fix(cli): openapi parser plumbs through custom content type (#4759)

fern-api · Sep 26, 2024 · e1e2ab6 · e1e2ab6
1 parent 1a1754c
commit e1e2ab6
Show file tree

Hide file tree

Showing 84 changed files with 2,067 additions and 713 deletions.
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,11 @@
+- changelogEntry:
+    - summary: |
+        The OpenAPI parser now respects the content type in your OpenAPI spec, instead of always sending
+        `application/json`. With this upgrade, your SDKs will also start to send the correct content type. 
+      type: fix
+  irVersion: 53
+  version: 0.43.4
+
 - changelogEntry:
     - summary: |
         The CLI now passes in the API definition ID once again, this is necessary so that generated snippet templates

diff --git a/packages/cli/ete-tests/src/tests/dependencies/__snapshots__/dependencies.test.ts.snap b/packages/cli/ete-tests/src/tests/dependencies/__snapshots__/dependencies.test.ts.snap
@@ -872,4 +872,4 @@ exports[`dependencies > correctly incorporates dependencies 1`] = `
 }"
 `;
 
-exports[`dependencies > file dependencies 1`] = `3086374`;
+exports[`dependencies > file dependencies 1`] = `3086444`;
diff --git a/packages/cli/ete-tests/src/tests/write-definition/__snapshots__/writeDefinition.test.ts.snap b/packages/cli/ete-tests/src/tests/write-definition/__snapshots__/writeDefinition.test.ts.snap
@@ -947,6 +947,7 @@ service:
       display-name: Create a booking
       request:
         body: trainsRoot.Booking
+        content-type: application/json
       response:
         docs: Booking successful
         type: CreateBookingResponse
@@ -1061,6 +1062,7 @@ service:
       display-name: Pay for a Booking
       request:
         body: trainsRoot.BookingPayment
+        content-type: application/json
       response:
         docs: Payment successful
         type: CreateBookingPaymentResponse
@@ -1867,6 +1869,7 @@ service:
               audiences:
                 - public
               availability: pre-release
+        content-type: application/json
       response:
         docs: OK
         type: list<string>
@@ -2150,6 +2153,7 @@ service:
             return_prompt:
               type: optional<boolean>
               docs: Whether to return the prompt in the response.
+        content-type: application/json
       response:
         docs: OK
         type: list<string>

diff --git a/...tests/write-definition/fixtures/namespaced-fleshedout/fern/.definition/v1/__package__.yml b/...tests/write-definition/fixtures/namespaced-fleshedout/fern/.definition/v1/__package__.yml
@@ -384,6 +384,7 @@ service:
               audiences:
                 - public
               availability: pre-release
+        content-type: application/json
       response:
         docs: OK
         type: list<string>

diff --git a/...ests/src/tests/write-definition/fixtures/namespaced-fleshedout/fern/.definition/v2/v2.yml b/...ests/src/tests/write-definition/fixtures/namespaced-fleshedout/fern/.definition/v2/v2.yml
@@ -108,6 +108,7 @@ service:
             return_prompt:
               type: optional<boolean>
               docs: Whether to return the prompt in the response.
+        content-type: application/json
       response:
         docs: OK
         type: list<string>

diff --git a/...tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/bookings.yml b/...tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/bookings.yml
@@ -75,6 +75,7 @@ service:
       display-name: Create a booking
       request:
         body: trainsRoot.Booking
+        content-type: application/json
       response:
         docs: Booking successful
         type: CreateBookingResponse

diff --git a/...tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/payments.yml b/...tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/payments.yml
@@ -26,6 +26,7 @@ service:
       display-name: Pay for a Booking
       request:
         body: trainsRoot.BookingPayment
+        content-type: application/json
       response:
         docs: Payment successful
         type: CreateBookingPaymentResponse

diff --git a/...ages/cli/generation/ir-generator/src/__test__/test-definitions/grpc-proto-exhaustive.json b/...ages/cli/generation/ir-generator/src/__test__/test-definitions/grpc-proto-exhaustive.json
@@ -3654,7 +3654,7 @@
                             }
                         },
                         "extends": [],
-                        "contentType": null,
+                        "contentType": "application/json",
                         "properties": [
                             {
                                 "name": {
@@ -4762,7 +4762,7 @@
                             }
                         },
                         "extends": [],
-                        "contentType": null,
+                        "contentType": "application/json",
                         "properties": [
                             {
                                 "name": {
@@ -5258,7 +5258,7 @@
                             }
                         },
                         "extends": [],
-                        "contentType": null,
+                        "contentType": "application/json",
                         "properties": [
                             {
                                 "name": {
@@ -11975,7 +11975,7 @@
                             }
                         },
                         "extends": [],
-                        "contentType": null,
+                        "contentType": "application/json",
                         "properties": [
                             {
                                 "name": {
@@ -16556,7 +16556,7 @@
                             }
                         },
                         "extends": [],
-                        "contentType": null,
+                        "contentType": "application/json",
                         "properties": [
                             {
                                 "name": {

diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/grpc-proto.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/grpc-proto.json
@@ -857,7 +857,7 @@
                             }
                         },
                         "extends": [],
-                        "contentType": null,
+                        "contentType": "application/json",
                         "properties": [
                             {
                                 "name": {

diff --git a/packages/cli/openapi-ir-to-fern-tests/src/__test__/__snapshots__/ada.test.ts.snap b/packages/cli/openapi-ir-to-fern-tests/src/__test__/__snapshots__/ada.test.ts.snap
@@ -110,6 +110,7 @@ exports[`open api parser > ada > docs 1`] = `
             },
             "request": {
               "body": "root.EndUserRequest",
+              "content-type": "application/json",
             },
             "response": {
               "docs": "OK",
@@ -552,6 +553,7 @@ exports[`open api parser > ada > simple 1`] = `
             },
             "request": {
               "body": "root.EndUserRequest",
+              "content-type": "application/json",
             },
             "response": {
               "docs": "OK",

diff --git a/packages/cli/openapi-ir-to-fern-tests/src/__test__/__snapshots__/anyOf.test.ts.snap b/packages/cli/openapi-ir-to-fern-tests/src/__test__/__snapshots__/anyOf.test.ts.snap
@@ -34,6 +34,7 @@ exports[`anyOf > anyOf > docs 1`] = `
                 },
               },
             },
+            "content-type": "application/json",
             "headers": undefined,
             "name": "Request",
             "query-parameters": undefined,
@@ -109,6 +110,7 @@ exports[`anyOf > anyOf > simple 1`] = `
                 },
               },
             },
+            "content-type": "application/json",
             "headers": undefined,
             "name": "Request",
             "query-parameters": undefined,

diff --git a/packages/cli/openapi-ir-to-fern-tests/src/__test__/__snapshots__/apiture.test.ts.snap b/packages/cli/openapi-ir-to-fern-tests/src/__test__/__snapshots__/apiture.test.ts.snap
@@ -823,6 +823,7 @@ The authenticated user must have the \`account.allows.manageJointOwners\` permis
                 ],
                 "properties": {},
               },
+              "content-type": "application/json",
               "headers": undefined,
               "name": "NewJointOwnerInvitation",
               "query-parameters": undefined,
@@ -1001,6 +1002,7 @@ The user must have the \`allows.manageOverdraftAccounts\` permission on the acco
                 ],
                 "properties": {},
               },
+              "content-type": "application/json",
               "headers": undefined,
               "name": "OverdraftProtectionPatch",
               "query-parameters": undefined,
@@ -1338,6 +1340,7 @@ Note: This operation requires an identity challenge if the financial institution
                   },
                 },
               },
+              "content-type": "application/json",
               "headers": {
                 "Challenge": {
                   "docs": "This operation may require a completed challenge. If the first attempt calling this operation fails with a 401 \`challengeRequired\` error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this \`Challenge\` request header using the \`challengeToken\` returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 401 status code and the \`invalidChallengeHeader\` problem type.",
@@ -1650,6 +1653,7 @@ Note: This operation requires an identity challenge if the financial institution
                   },
                 },
               },
+              "content-type": "application/merge-patch+json",
               "headers": {
                 "Challenge": {
                   "docs": "This operation may require a completed challenge. If the first attempt calling this operation fails with a 401 \`challengeRequired\` error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this \`Challenge\` request header using the \`challengeToken\` returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 401 status code and the \`invalidChallengeHeader\` problem type.",
@@ -6915,6 +6919,7 @@ The authenticated user must have the \`account.allows.manageJointOwners\` permis
                 ],
                 "properties": {},
               },
+              "content-type": "application/json",
               "headers": undefined,
               "name": "NewJointOwnerInvitation",
               "query-parameters": undefined,
@@ -7093,6 +7098,7 @@ The user must have the \`allows.manageOverdraftAccounts\` permission on the acco
                 ],
                 "properties": {},
               },
+              "content-type": "application/json",
               "headers": undefined,
               "name": "OverdraftProtectionPatch",
               "query-parameters": undefined,
@@ -7430,6 +7436,7 @@ Note: This operation requires an identity challenge if the financial institution
                   },
                 },
               },
+              "content-type": "application/json",
               "headers": {
                 "Challenge": {
                   "docs": "This operation may require a completed challenge. If the first attempt calling this operation fails with a 401 \`challengeRequired\` error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this \`Challenge\` request header using the \`challengeToken\` returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 401 status code and the \`invalidChallengeHeader\` problem type.",
@@ -7742,6 +7749,7 @@ Note: This operation requires an identity challenge if the financial institution
                   },
                 },
               },
+              "content-type": "application/merge-patch+json",
               "headers": {
                 "Challenge": {
                   "docs": "This operation may require a completed challenge. If the first attempt calling this operation fails with a 401 \`challengeRequired\` error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this \`Challenge\` request header using the \`challengeToken\` returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 401 status code and the \`invalidChallengeHeader\` problem type.",