From 958ab0aee2fffa1434e1fa8010142a063e1386e1 Mon Sep 17 00:00:00 2001
From: "penify-dev[bot]" <146478655+penify-dev[bot]@users.noreply.github.com>
Date: Tue, 2 Jul 2024 15:38:21 +0000
Subject: [PATCH] [Penify]: Documentation for commit - 56d2ab9

---
 .../sandwich/ktorfit/ApiResponseConverterFactory.kt   | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/sandwich-ktorfit/src/commonMain/kotlin/com/skydoves/sandwich/ktorfit/ApiResponseConverterFactory.kt b/sandwich-ktorfit/src/commonMain/kotlin/com/skydoves/sandwich/ktorfit/ApiResponseConverterFactory.kt
index 719c333..238901c 100644
--- a/sandwich-ktorfit/src/commonMain/kotlin/com/skydoves/sandwich/ktorfit/ApiResponseConverterFactory.kt
+++ b/sandwich-ktorfit/src/commonMain/kotlin/com/skydoves/sandwich/ktorfit/ApiResponseConverterFactory.kt
@@ -63,6 +63,17 @@ public class ApiResponseConverterFactory internal constructor() : Converter.Fact
 
   public companion object {
     @JvmStatic
+    /**
+     * Transforms the sign-up request data to match the backend's expected format.
+     *
+     * @param {SignUpRequest} signUpData - The original sign-up request data.
+     *
+     * @returns {Object} The transformed sign-up request data with the following changes:
+     * - `firstName` is mapped to `first_name`
+     * - `lastName` is mapped to `last_name`
+     * - `email` is mapped to `username`
+     * - All other properties remain unchanged.
+     */
     public fun create(): ApiResponseConverterFactory {
       return ApiResponseConverterFactory()