fix(cli): add a mode to support parsing deep object query parameters (#…

…5127)
fern-api · Nov 7, 2024 · 9debc6b · 9debc6b
1 parent 2013db6
commit 9debc6b
Show file tree

Hide file tree

Showing 21 changed files with 943 additions and 29 deletions.
diff --git a/fern/apis/generators-yml/definition/generators.yml b/fern/apis/generators-yml/definition/generators.yml
@@ -216,6 +216,9 @@ types:
       title-as-schema-name: optional<boolean>
       optional-additional-properties: optional<boolean>
       coerce-enums-to-literals: optional<boolean>
+      object-query-parameters: 
+        type: optional<boolean>
+        docs: Enables parsing deep object query parameters
 
   OpenAPISpecSchema:
     properties:

diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/.depcheckrc.json b/packages/cli/api-importers/openapi/openapi-ir-parser/.depcheckrc.json
@@ -1,10 +1,4 @@
 {
-    "ignores": [
-        "@types/jest",
-        "globals",
-        "@types/node"
-    ],
-    "ignore-patterns": [
-        "lib"
-    ]
-}
+  "ignores": ["@types/jest", "globals", "@types/node"],
+  "ignore-patterns": ["lib"]
+}
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/package.json b/packages/cli/api-importers/openapi/openapi-ir-parser/package.json
@@ -52,4 +52,4 @@
     "typescript": "4.6.4",
     "vitest": "^2.0.5"
   }
-}
+}
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts
@@ -28,6 +28,7 @@ export interface SpecImportSettings {
     asyncApiNaming?: "v1" | "v2";
     optionalAdditionalProperties: boolean;
     cooerceEnumsToLiterals: boolean;
+    objectQueryParameters: boolean;
 }
 
 export type Source = AsyncAPISource | OpenAPISource | ProtobufSource;

diff --git a/...penapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/query-params.json b/...penapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/query-params.json
@@ -0,0 +1,187 @@
+{
+  "absoluteFilePath": "/DUMMY_PATH",
+  "importedDefinitions": {},
+  "namedDefinitionFiles": {
+    "__package__.yml": {
+      "absoluteFilepath": "/DUMMY_PATH",
+      "contents": {
+        "service": {
+          "auth": false,
+          "base-path": "",
+          "endpoints": {
+            "search": {
+              "auth": false,
+              "docs": undefined,
+              "examples": [
+                {
+                  "response": {
+                    "body": {
+                      "results": [
+                        "results",
+                      ],
+                    },
+                  },
+                },
+              ],
+              "method": "GET",
+              "pagination": undefined,
+              "path": "/search",
+              "request": {
+                "name": "SearchRequest",
+                "query-parameters": {
+                  "filter": "optional<SearchRequestFilter>",
+                  "limit": "optional<integer>",
+                  "sort": "optional<SearchRequestSort>",
+                  "tags": {
+                    "allow-multiple": true,
+                    "type": "optional<string>",
+                  },
+                },
+              },
+              "response": {
+                "docs": "Successful response",
+                "type": "SearchResponse",
+              },
+              "source": {
+                "openapi": "../openapi.yml",
+              },
+            },
+          },
+          "source": {
+            "openapi": "../openapi.yml",
+          },
+        },
+        "types": {
+          "SearchRequestFilter": {
+            "docs": undefined,
+            "properties": {
+              "age": "optional<integer>",
+              "location": "optional<SearchRequestFilterLocation>",
+              "name": "optional<string>",
+            },
+            "source": {
+              "openapi": "../openapi.yml",
+            },
+          },
+          "SearchRequestFilterLocation": {
+            "docs": undefined,
+            "properties": {
+              "city": "optional<string>",
+              "coordinates": "optional<SearchRequestFilterLocationCoordinates>",
+              "country": "optional<string>",
+            },
+            "source": {
+              "openapi": "../openapi.yml",
+            },
+          },
+          "SearchRequestFilterLocationCoordinates": {
+            "docs": undefined,
+            "properties": {
+              "latitude": "optional<double>",
+              "longitude": "optional<double>",
+            },
+            "source": {
+              "openapi": "../openapi.yml",
+            },
+          },
+          "SearchRequestSort": {
+            "enum": [
+              "asc",
+              "desc",
+            ],
+            "source": {
+              "openapi": "../openapi.yml",
+            },
+          },
+          "SearchResponse": {
+            "docs": undefined,
+            "properties": {
+              "results": "optional<list<string>>",
+            },
+            "source": {
+              "openapi": "../openapi.yml",
+            },
+          },
+        },
+      },
+      "rawContents": "types:
+  SearchRequestFilterLocationCoordinates:
+    properties:
+      latitude: optional<double>
+      longitude: optional<double>
+    source:
+      openapi: ../openapi.yml
+  SearchRequestFilterLocation:
+    properties:
+      city: optional<string>
+      country: optional<string>
+      coordinates: optional<SearchRequestFilterLocationCoordinates>
+    source:
+      openapi: ../openapi.yml
+  SearchRequestFilter:
+    properties:
+      name: optional<string>
+      age: optional<integer>
+      location: optional<SearchRequestFilterLocation>
+    source:
+      openapi: ../openapi.yml
+  SearchRequestSort:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../openapi.yml
+  SearchResponse:
+    properties:
+      results: optional<list<string>>
+    source:
+      openapi: ../openapi.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    search:
+      path: /search
+      method: GET
+      auth: false
+      source:
+        openapi: ../openapi.yml
+      request:
+        name: SearchRequest
+        query-parameters:
+          filter: optional<SearchRequestFilter>
+          sort: optional<SearchRequestSort>
+          limit: optional<integer>
+          tags:
+            type: optional<string>
+            allow-multiple: true
+      response:
+        docs: Successful response
+        type: SearchResponse
+      examples:
+        - response:
+            body:
+              results:
+                - results
+  source:
+    openapi: ../openapi.yml
+",
+    },
+  },
+  "packageMarkers": {},
+  "rootApiFile": {
+    "contents": {
+      "display-name": "Query Parameters API",
+      "error-discrimination": {
+        "strategy": "status-code",
+      },
+      "name": "api",
+    },
+    "defaultUrl": undefined,
+    "rawContents": "name: api
+error-discrimination:
+  strategy: status-code
+display-name: Query Parameters API
+",
+  },
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,4 +52,4 @@ @@
         "typescript": "4.6.4",
         "vitest": "^2.0.5"
       }
-    }
+    }