fix: Correct handling of default parameter values in referenced compo…

…nent schema (#1746) * fix: Correct handling of default parameter values in referenced component schema * chore: lint code * chore: lint code * Create dull-birds-pump.md
openapi-ts · Jul 17, 2024 · e705909 · e705909
1 parent 184ff13
commit e705909
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 1 deletion.
diff --git a/.changeset/dull-birds-pump.md b/.changeset/dull-birds-pump.md
@@ -0,0 +1,5 @@
+---
+"openapi-typescript": patch
+---
+
+fix: Correct handling of default parameter values in referenced component schema
diff --git a/packages/openapi-typescript/src/transform/schema-object.ts b/packages/openapi-typescript/src/transform/schema-object.ts
@@ -457,7 +457,8 @@ function transformSchemaObjectCore(schemaObject: SchemaObject, options: Transfor
           ("default" in v &&
             options.ctx.defaultNonNullable &&
             !options.path?.includes("parameters") &&
-            !options.path?.includes("requestBody")) // parameters can’t be required, even with defaults
+            !options.path?.includes("requestBody") &&
+            !options.path?.includes("requestBodies")) // can’t be required, even with defaults
             ? undefined
             : QUESTION_TOKEN;
         let type =

diff --git a/packages/openapi-typescript/test/transform/request-body-object.test.ts b/packages/openapi-typescript/test/transform/request-body-object.test.ts
@@ -89,6 +89,62 @@ describe("transformRequestBodyObject", () => {
         },
       },
     ],
+    [
+      "requestBodies -> POST data with default values",
+      {
+        given: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  card_title: {
+                    type: "string",
+                    title: "Card Title",
+                    default: "Social Profile",
+                  },
+                  template: {
+                    type: "string",
+                    title: "Template",
+                  },
+                  socials: {
+                    type: "object",
+                    title: "Socials",
+                    default: {},
+                  },
+                },
+                type: "object",
+                required: ["template"],
+                title: "Create",
+                description: "Social Profile schema for create.",
+              },
+            },
+          },
+          description: "description",
+        },
+        want: `{
+    content: {
+        "application/json": {
+            /**
+             * Card Title
+             * @default Social Profile
+             */
+            card_title?: string;
+            /** Template */
+            template: string;
+            /**
+             * Socials
+             * @default {}
+             */
+            socials?: Record<string, never>;
+        };
+    };
+}`,
+        options: {
+          path: "#/components/requestBodies/social_profiles__Create/application~1json",
+          ctx: { ...DEFAULT_CTX },
+        },
+      },
+    ],
   ];
 
   for (const [testName, { given, want, options = DEFAULT_OPTIONS, ci }] of tests) {