fix(cli): openapi importer supports a setting for not defaulting opti…

…onal additional properties
fern-api · Sep 17, 2024 · 52594ad · 52594ad
1 parent 0c1465c
commit 52594ad
Show file tree

Hide file tree

Showing 15 changed files with 285 additions and 20 deletions.
diff --git a/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts
@@ -36,6 +36,7 @@ export interface APIDefinitionSettings {
     shouldUseTitleAsName: boolean | undefined;
     shouldUseUndiscriminatedUnionsWithLiterals: boolean | undefined;
     asyncApiMessageNaming: "v1" | "v2" | undefined;
+    shouldUseOptionalAdditionalProperties: boolean | undefined;
 }
 
 export interface APIDefinitionLocation {

diff --git a/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts
@@ -94,7 +94,8 @@ async function parseAPIConfigurationToApiLocations(
                 settings: {
                     shouldUseTitleAsName: undefined,
                     shouldUseUndiscriminatedUnionsWithLiterals: undefined,
-                    asyncApiMessageNaming: undefined
+                    asyncApiMessageNaming: undefined,
+                    shouldUseOptionalAdditionalProperties: undefined
                 }
             });
         } else if (isRawProtobufAPIDefinitionSchema(apiConfiguration)) {
@@ -111,7 +112,8 @@ async function parseAPIConfigurationToApiLocations(
                 settings: {
                     shouldUseTitleAsName: undefined,
                     shouldUseUndiscriminatedUnionsWithLiterals: undefined,
-                    asyncApiMessageNaming: undefined
+                    asyncApiMessageNaming: undefined,
+                    shouldUseOptionalAdditionalProperties: undefined
                 }
             });
         } else if (Array.isArray(apiConfiguration)) {
@@ -128,7 +130,8 @@ async function parseAPIConfigurationToApiLocations(
                         settings: {
                             shouldUseTitleAsName: undefined,
                             shouldUseUndiscriminatedUnionsWithLiterals: undefined,
-                            asyncApiMessageNaming: undefined
+                            asyncApiMessageNaming: undefined,
+                            shouldUseOptionalAdditionalProperties: undefined
                         }
                     });
                 } else if (isRawProtobufAPIDefinitionSchema(definition)) {
@@ -145,7 +148,8 @@ async function parseAPIConfigurationToApiLocations(
                         settings: {
                             shouldUseTitleAsName: undefined,
                             shouldUseUndiscriminatedUnionsWithLiterals: undefined,
-                            asyncApiMessageNaming: undefined
+                            asyncApiMessageNaming: undefined,
+                            shouldUseOptionalAdditionalProperties: undefined
                         }
                     });
                 } else {
@@ -160,7 +164,8 @@ async function parseAPIConfigurationToApiLocations(
                         settings: {
                             shouldUseTitleAsName: definition.settings?.["use-title"],
                             shouldUseUndiscriminatedUnionsWithLiterals: definition.settings?.unions === "v1",
-                            asyncApiMessageNaming: definition.settings?.["message-naming"]
+                            asyncApiMessageNaming: definition.settings?.["message-naming"],
+                            shouldUseOptionalAdditionalProperties: undefined
                         }
                     });
                 }
@@ -177,7 +182,8 @@ async function parseAPIConfigurationToApiLocations(
                 settings: {
                     shouldUseTitleAsName: apiConfiguration.settings?.["use-title"],
                     shouldUseUndiscriminatedUnionsWithLiterals: apiConfiguration.settings?.unions === "v1",
-                    asyncApiMessageNaming: apiConfiguration.settings?.["message-naming"]
+                    asyncApiMessageNaming: apiConfiguration.settings?.["message-naming"],
+                    shouldUseOptionalAdditionalProperties: undefined
                 }
             });
         }
@@ -199,7 +205,8 @@ async function parseAPIConfigurationToApiLocations(
                 settings: {
                     shouldUseTitleAsName: settings?.["use-title"],
                     shouldUseUndiscriminatedUnionsWithLiterals: settings?.unions === "v1",
-                    asyncApiMessageNaming: undefined
+                    asyncApiMessageNaming: undefined,
+                    shouldUseOptionalAdditionalProperties: undefined
                 }
             });
         } else if (openapi != null) {
@@ -214,7 +221,8 @@ async function parseAPIConfigurationToApiLocations(
                 settings: {
                     shouldUseTitleAsName: openapi.settings?.["use-title"],
                     shouldUseUndiscriminatedUnionsWithLiterals: openapi.settings?.unions === "v1",
-                    asyncApiMessageNaming: undefined
+                    asyncApiMessageNaming: undefined,
+                    shouldUseOptionalAdditionalProperties: undefined
                 }
             });
         }
@@ -231,7 +239,8 @@ async function parseAPIConfigurationToApiLocations(
                 settings: {
                     shouldUseTitleAsName: settings?.["use-title"],
                     shouldUseUndiscriminatedUnionsWithLiterals: settings?.unions === "v1",
-                    asyncApiMessageNaming: settings?.["message-naming"]
+                    asyncApiMessageNaming: settings?.["message-naming"],
+                    shouldUseOptionalAdditionalProperties: undefined
                 }
             });
         }
@@ -263,7 +272,8 @@ async function parseApiConfigurationV2Schema({
                 settings: {
                     shouldUseTitleAsName: undefined,
                     shouldUseUndiscriminatedUnionsWithLiterals: undefined,
-                    asyncApiMessageNaming: undefined
+                    asyncApiMessageNaming: undefined,
+                    shouldUseOptionalAdditionalProperties: spec.settings?.optionalAdditionalProperties ?? true
                 }
             };
             if (spec.namespace == null) {

diff --git a/packages/cli/configuration/src/generators-yml/schemas/APIConfigurationV2Schema.ts b/packages/cli/configuration/src/generators-yml/schemas/APIConfigurationV2Schema.ts
@@ -1,18 +1,36 @@
 import { z } from "zod";
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 
+/*********** OpenAPI Spec ***********/
+
+export const OpenAPISettingsSchema = z.strictObject({
+    optionalAdditionalProperties: z.optional(z.boolean())
+});
+
+export type OpenAPISettingsSchema = z.infer<typeof OpenAPISettingsSchema>;
+
 export const OpenAPISpecSchema = z.strictObject({
     openapi: z.string(),
     overrides: z.string().optional(),
-    namespace: z.string().optional()
+    namespace: z.string().optional(),
+    settings: z.optional(OpenAPISettingsSchema)
 });
 
 export type OpenAPISpecSchema = z.infer<typeof OpenAPISpecSchema>;
 
+/*********** AsyncAPI Spec ***********/
+
+export const AsyncAPISettingsSchema = z.strictObject({
+    optionalAdditionalProperties: z.optional(z.boolean())
+});
+
+export type AsyncAPISettingsSchema = z.infer<typeof AsyncAPISettingsSchema>;
+
 export const AsyncAPISchema = z.strictObject({
     asyncapi: z.string(),
     overrides: z.string().optional(),
-    namespace: z.string().optional()
+    namespace: z.string().optional(),
+    settings: z.optional(AsyncAPISettingsSchema)
 });
 
 export type AsyncAPISchema = z.infer<typeof AsyncAPISchema>;

diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/additionalProperties.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/additionalProperties.test.ts.snap
@@ -0,0 +1,183 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`anyOf > additional-properties > parse open api 1`] = `
+{
+  "apiVersion": null,
+  "basePath": null,
+  "channel": [],
+  "description": null,
+  "endpoints": [],
+  "globalHeaders": [],
+  "groups": {},
+  "hasEndpointsMarkedInternal": false,
+  "idempotencyHeaders": [],
+  "nonRequestReferencedSchemas": [],
+  "schemas": {
+    "CheckFlagRequestBody": {
+      "additionalProperties": false,
+      "allOf": [],
+      "allOfPropertyConflicts": [],
+      "availability": null,
+      "description": null,
+      "generatedName": "CheckFlagRequestBody",
+      "groupName": [],
+      "nameOverride": null,
+      "properties": [
+        {
+          "audiences": [],
+          "availability": null,
+          "conflict": {},
+          "generatedName": "checkFlagRequestBodyCompany",
+          "key": "company",
+          "nameOverride": null,
+          "schema": {
+            "availability": null,
+            "description": null,
+            "generatedName": "checkFlagRequestBodyCompany",
+            "groupName": [],
+            "nameOverride": null,
+            "title": null,
+            "type": "optional",
+            "value": {
+              "availability": null,
+              "description": null,
+              "generatedName": "CheckFlagRequestBodyCompany",
+              "groupName": [],
+              "nameOverride": null,
+              "title": null,
+              "type": "nullable",
+              "value": {
+                "availability": null,
+                "description": null,
+                "encoding": null,
+                "generatedName": "CheckFlagRequestBodyCompany",
+                "groupName": [],
+                "key": {
+                  "availability": null,
+                  "description": null,
+                  "generatedName": "CheckFlagRequestBodyCompanyKey",
+                  "groupName": [],
+                  "nameOverride": null,
+                  "schema": {
+                    "default": null,
+                    "format": null,
+                    "maxLength": null,
+                    "minLength": null,
+                    "pattern": null,
+                    "type": "string",
+                  },
+                  "title": null,
+                },
+                "nameOverride": null,
+                "title": null,
+                "type": "map",
+                "value": {
+                  "availability": null,
+                  "description": null,
+                  "generatedName": "CheckFlagRequestBodyCompanyValue",
+                  "groupName": [],
+                  "nameOverride": null,
+                  "schema": {
+                    "default": null,
+                    "format": null,
+                    "maxLength": null,
+                    "minLength": null,
+                    "pattern": null,
+                    "type": "string",
+                  },
+                  "title": null,
+                  "type": "primitive",
+                },
+              },
+            },
+          },
+        },
+        {
+          "audiences": [],
+          "availability": null,
+          "conflict": {},
+          "generatedName": "checkFlagRequestBodyUser",
+          "key": "user",
+          "nameOverride": null,
+          "schema": {
+            "availability": null,
+            "description": null,
+            "generatedName": "checkFlagRequestBodyUser",
+            "groupName": [],
+            "nameOverride": null,
+            "title": null,
+            "type": "optional",
+            "value": {
+              "availability": null,
+              "description": null,
+              "generatedName": "CheckFlagRequestBodyUser",
+              "groupName": [],
+              "nameOverride": null,
+              "title": null,
+              "type": "nullable",
+              "value": {
+                "availability": null,
+                "description": null,
+                "encoding": null,
+                "generatedName": "CheckFlagRequestBodyUser",
+                "groupName": [],
+                "key": {
+                  "availability": null,
+                  "description": null,
+                  "generatedName": "CheckFlagRequestBodyUserKey",
+                  "groupName": [],
+                  "nameOverride": null,
+                  "schema": {
+                    "default": null,
+                    "format": null,
+                    "maxLength": null,
+                    "minLength": null,
+                    "pattern": null,
+                    "type": "string",
+                  },
+                  "title": null,
+                },
+                "nameOverride": null,
+                "title": null,
+                "type": "map",
+                "value": {
+                  "availability": null,
+                  "description": null,
+                  "generatedName": "CheckFlagRequestBodyUserValue",
+                  "groupName": [],
+                  "nameOverride": null,
+                  "schema": {
+                    "default": null,
+                    "format": null,
+                    "maxLength": null,
+                    "minLength": null,
+                    "pattern": null,
+                    "type": "string",
+                  },
+                  "title": null,
+                  "type": "primitive",
+                },
+              },
+            },
+          },
+        },
+      ],
+      "source": {
+        "file": "additional-properties/openapi.yml",
+        "type": "openapi",
+      },
+      "title": null,
+      "type": "object",
+    },
+  },
+  "securitySchemes": {},
+  "servers": [],
+  "tags": {
+    "orderedTagIds": null,
+    "tagsById": {},
+  },
+  "title": "Additional Properties",
+  "variables": {},
+  "webhooks": [],
+}
+`;
diff --git a/packages/cli/openapi-parser/src/__test__/additionalProperties.test.ts b/packages/cli/openapi-parser/src/__test__/additionalProperties.test.ts
@@ -0,0 +1,10 @@
+import { testParseOpenAPI } from "./testParseOpenApi";
+
+describe("anyOf", () => {
+    testParseOpenAPI("additional-properties", "openapi.yml", undefined, {
+        audiences: [],
+        shouldUseTitleAsName: true,
+        shouldUseUndiscriminatedUnionsWithLiterals: true,
+        optionalAdditionalProperties: false
+    });
+});
diff --git a/packages/cli/openapi-parser/src/__test__/fixtures/additional-properties/openapi.yml b/packages/cli/openapi-parser/src/__test__/fixtures/additional-properties/openapi.yml
@@ -0,0 +1,21 @@
+openapi: 3.1.0
+info:
+  title: Additional Properties
+  version: "0"
+paths: {}
+components: 
+  schemas: 
+    CheckFlagRequestBody:
+      type: object
+      properties:
+        company:
+          additionalProperties:
+            type: string
+          type: object
+          nullable: true
+        user:
+          additionalProperties:
+            type: string
+          type: object
+          nullable: true
+
diff --git a/packages/cli/openapi-parser/src/__test__/gen-yml-make-undisc-unions-on.test.ts b/packages/cli/openapi-parser/src/__test__/gen-yml-make-undisc-unions-on.test.ts
@@ -4,6 +4,7 @@ describe("open api parser", () => {
     testParseOpenAPI("gen-yml-make-undisc-unions", "openapi.json", undefined, {
         audiences: [],
         shouldUseTitleAsName: true,
-        shouldUseUndiscriminatedUnionsWithLiterals: true
+        shouldUseUndiscriminatedUnionsWithLiterals: true,
+        optionalAdditionalProperties: true
     });
 });
diff --git a/packages/cli/openapi-parser/src/__test__/gen-yml-use-title-setting-on.test.ts b/packages/cli/openapi-parser/src/__test__/gen-yml-use-title-setting-on.test.ts
@@ -4,6 +4,7 @@ describe("open api parser", () => {
     testParseOpenAPI("gen-yml-use-title", "openapi.yml", undefined, {
         audiences: [],
         shouldUseTitleAsName: true,
-        shouldUseUndiscriminatedUnionsWithLiterals: false
+        shouldUseUndiscriminatedUnionsWithLiterals: false,
+        optionalAdditionalProperties: true
     });
 });
diff --git a/packages/cli/openapi-parser/src/__test__/gen-yml-use-title-setting.test.ts b/packages/cli/openapi-parser/src/__test__/gen-yml-use-title-setting.test.ts
@@ -4,6 +4,7 @@ describe("open api parser", () => {
     testParseOpenAPI("gen-yml-use-title", "openapi.yml", undefined, {
         audiences: [],
         shouldUseTitleAsName: false,
-        shouldUseUndiscriminatedUnionsWithLiterals: false
+        shouldUseUndiscriminatedUnionsWithLiterals: false,
+        optionalAdditionalProperties: true,
     });
 });