allow freeform aliases to be request body types

fern-api · Feb 5, 2025 · 242ddfa · 242ddfa
1 parent 4a34d3f
commit 242ddfa
Show file tree

Hide file tree

Showing 6 changed files with 244 additions and 98 deletions.
diff --git a/packages/parsers/src/openapi/3.1/paths/request/RequestMediaTypeObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/request/RequestMediaTypeObjectConverter.node.ts
@@ -14,9 +14,8 @@ import { resolveReference } from "../../../utils/3.1/resolveReference";
 import { maybeSingleValueToArray } from "../../../utils/maybeSingleValueToArray";
 import { MediaType } from "../../../utils/MediaType";
 import { AvailabilityConverterNode } from "../../extensions/AvailabilityConverter.node";
-import { isObjectSchema } from "../../guards/isObjectSchema";
 import { isReferenceObject } from "../../guards/isReferenceObject";
-import { ObjectConverterNode } from "../../schemas/ObjectConverter.node";
+import { SchemaConverterNode } from "../../schemas";
 import { ReferenceConverterNode } from "../../schemas/ReferenceConverter.node";
 import { GLOBAL_EXAMPLE_NAME } from "../ExampleObjectConverter.node";
 import { MultipartFormDataPropertySchemaConverterNode } from "./MultipartFormDataPropertySchemaConverter.node";
@@ -33,7 +32,7 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte
   description: string | undefined;
 
   // application/json
-  schema: ReferenceConverterNode | ObjectConverterNode | undefined;
+  schema: ReferenceConverterNode | SchemaConverterNode | undefined;
 
   // application/octet-stream
   isOptional: boolean | undefined;
@@ -102,13 +101,13 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte
           },
           false
         );
-      } else if (isObjectSchema(this.input.schema)) {
+      } else {
         this.resolvedSchema = this.input.schema;
         const mediaType = MediaType.parse(contentType);
         // An exhaustive switch cannot be used here, because contentType is an unbounded string
         if (mediaType?.containsJSON()) {
           this.contentType = "json" as const;
-          this.schema = new ObjectConverterNode({
+          this.schema = new SchemaConverterNode({
             input: this.input.schema,
             context: this.context,
             accessPath: this.accessPath,
@@ -168,8 +167,23 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte
     | FernRegistry.api.latest.HttpRequestBodyShape[]
     | undefined {
     switch (this.contentType) {
-      case "json":
-        return this.schema?.convert();
+      case "json": {
+        const convertedJsonSchema = this.schema?.convert();
+        if (convertedJsonSchema == null) {
+          return undefined;
+        }
+        const convertedJsonSchemaArray =
+          maybeSingleValueToArray(convertedJsonSchema);
+
+        return convertedJsonSchemaArray
+          ?.map((convertedJsonSchema) =>
+            convertedJsonSchema.type === "object" ||
+            convertedJsonSchema.type === "alias"
+              ? convertedJsonSchema
+              : undefined
+          )
+          .filter(isNonNullish);
+      }
       case "bytes":
         return {
           type: "bytes",
@@ -243,8 +257,23 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte
           description: this.description,
         }));
       }
-      case undefined:
-        return this.schema?.convert();
+      case undefined: {
+        const convertedJsonSchema = this.schema?.convert();
+        if (convertedJsonSchema == null) {
+          return undefined;
+        }
+        const convertedJsonSchemaArray =
+          maybeSingleValueToArray(convertedJsonSchema);
+
+        return convertedJsonSchemaArray
+          ?.map((convertedJsonSchema) =>
+            convertedJsonSchema.type === "object" ||
+            convertedJsonSchema.type === "alias"
+              ? convertedJsonSchema
+              : undefined
+          )
+          .filter(isNonNullish);
+      }
       default:
         return undefined;
     }

diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/nested-array-object.json b/packages/parsers/src/openapi/__test__/__snapshots__/nested-array-object.json
@@ -0,0 +1,85 @@
+{
+  "id": "test-uuid-replacement",
+  "endpoints": {
+    "endpoint_.postTestNestedArrayObject": {
+      "id": "endpoint_.postTestNestedArrayObject",
+      "method": "POST",
+      "path": [
+        {
+          "type": "literal",
+          "value": "/"
+        },
+        {
+          "type": "literal",
+          "value": "test"
+        },
+        {
+          "type": "literal",
+          "value": "/"
+        },
+        {
+          "type": "literal",
+          "value": "nested"
+        },
+        {
+          "type": "literal",
+          "value": "/"
+        },
+        {
+          "type": "literal",
+          "value": "array-object"
+        }
+      ],
+      "environments": [],
+      "requests": [
+        {
+          "contentType": "application/json",
+          "body": {
+            "type": "alias",
+            "value": {
+              "type": "list",
+              "itemShape": {
+                "type": "object",
+                "extends": [],
+                "properties": [
+                  {
+                    "key": "a",
+                    "valueShape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "primitive",
+                        "value": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  },
+                  {
+                    "key": "b",
+                    "valueShape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "primitive",
+                        "value": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      ],
+      "protocol": {
+        "type": "rest"
+      }
+    }
+  },
+  "websockets": {},
+  "webhooks": {},
+  "types": {},
+  "subpackages": {},
+  "auths": {}
+}
diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/only-include-referenced-schemas.json b/packages/parsers/src/openapi/__test__/__snapshots__/only-include-referenced-schemas.json
@@ -15757,16 +15757,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -17208,16 +17199,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -21963,16 +21945,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -33065,16 +33038,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -35746,9 +35710,21 @@
         {
           "contentType": "application/json",
           "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
+            "type": "alias",
+            "value": {
+              "type": "id",
+              "id": "contact_reply_ticket_request"
+            }
+          }
+        },
+        {
+          "contentType": "application/json",
+          "body": {
+            "type": "alias",
+            "value": {
+              "type": "id",
+              "id": "admin_reply_ticket_request"
+            }
           }
         }
       ],

diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/openapi-filter.json b/packages/parsers/src/openapi/__test__/__snapshots__/openapi-filter.json
@@ -15757,16 +15757,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -17208,16 +17199,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -21963,16 +21945,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -33065,16 +33038,7 @@
           }
         }
       ],
-      "requests": [
-        {
-          "contentType": "application/json",
-          "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
-          }
-        }
-      ],
+      "requests": [],
       "responses": [
         {
           "statusCode": 200,
@@ -35746,9 +35710,21 @@
         {
           "contentType": "application/json",
           "body": {
-            "type": "object",
-            "extends": [],
-            "properties": []
+            "type": "alias",
+            "value": {
+              "type": "id",
+              "id": "contact_reply_ticket_request"
+            }
+          }
+        },
+        {
+          "contentType": "application/json",
+          "body": {
+            "type": "alias",
+            "value": {
+              "type": "id",
+              "id": "admin_reply_ticket_request"
+            }
           }
         }
       ],