(fix): fixes trailing slash parsing in openapi-parser, updates tests (#…

…3418)
fern-api · Apr 21, 2024 · 50374c9 · 50374c9
1 parent e10d2ea
commit 50374c9
Show file tree

Hide file tree

Showing 8 changed files with 230 additions and 120 deletions.
diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/belvo.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/belvo.test.ts.snap
diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/deel.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/deel.test.ts.snap
@@ -16896,7 +16896,7 @@ exports[`open api parser deel parse open api 1`] = `
       "internal": null,
       "method": "GET",
       "operationId": "getEorClientTimeOffs",
-      "path": "/time-offs",
+      "path": "/time-offs/",
       "pathParameters": [],
       "queryParameters": [],
       "request": null,

diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/path.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/path.test.ts.snap
@@ -0,0 +1,95 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`path parsing path parse open api 1`] = `
+{
+  "channel": [],
+  "description": null,
+  "endpoints": [
+    {
+      "audiences": [],
+      "authed": false,
+      "availability": null,
+      "description": null,
+      "errorStatusCode": [],
+      "examples": [
+        {
+          "codeSamples": [],
+          "description": null,
+          "headers": [],
+          "name": null,
+          "pathParameters": [],
+          "queryParameters": [],
+          "request": null,
+          "response": null,
+          "type": "full",
+        },
+      ],
+      "generatedRequestName": "GetExampleWithoutTrailingSlashRequest",
+      "headers": [],
+      "internal": null,
+      "method": "GET",
+      "operationId": null,
+      "path": "/example-without-trailing-slash",
+      "pathParameters": [],
+      "queryParameters": [],
+      "request": null,
+      "requestNameOverride": null,
+      "response": null,
+      "sdkName": null,
+      "server": [],
+      "summary": "Get Example",
+      "tags": [],
+    },
+    {
+      "audiences": [],
+      "authed": false,
+      "availability": null,
+      "description": null,
+      "errorStatusCode": [],
+      "examples": [
+        {
+          "codeSamples": [],
+          "description": null,
+          "headers": [],
+          "name": null,
+          "pathParameters": [],
+          "queryParameters": [],
+          "request": null,
+          "response": null,
+          "type": "full",
+        },
+      ],
+      "generatedRequestName": "GetExampleWithTrailingSlashRequest",
+      "headers": [],
+      "internal": null,
+      "method": "GET",
+      "operationId": null,
+      "path": "/example-with-trailing-slash/",
+      "pathParameters": [],
+      "queryParameters": [],
+      "request": null,
+      "requestNameOverride": null,
+      "response": null,
+      "sdkName": null,
+      "server": [],
+      "summary": "Get Example with trailing",
+      "tags": [],
+    },
+  ],
+  "errors": {},
+  "globalHeaders": [],
+  "groups": {},
+  "hasEndpointsMarkedInternal": false,
+  "nonRequestReferencedSchemas": [],
+  "schemas": {},
+  "securitySchemes": {},
+  "servers": [],
+  "tags": {
+    "orderedTagIds": null,
+    "tagsById": {},
+  },
+  "title": "Sample Path Parsing API",
+  "variables": {},
+  "webhooks": [],
+}
+`;
diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/supertokens.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/supertokens.test.ts.snap
@@ -21591,7 +21591,7 @@ e.g.:
       "internal": null,
       "method": "GET",
       "operationId": "getHelloOnRootPath",
-      "path": "",
+      "path": "/",
       "pathParameters": [],
       "queryParameters": [],
       "request": null,

diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/uploadcare.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/uploadcare.test.ts.snap
@@ -202,7 +202,7 @@ Log.d("TAG", file.toString())
       "internal": null,
       "method": "POST",
       "operationId": "baseUpload",
-      "path": "/base",
+      "path": "/base/",
       "pathParameters": [],
       "queryParameters": [],
       "request": {
@@ -610,7 +610,7 @@ Log.d("TAG", file.toString())
       "internal": null,
       "method": "POST",
       "operationId": "multipartFileUploadStart",
-      "path": "/multipart/start",
+      "path": "/multipart/start/",
       "pathParameters": [],
       "queryParameters": [],
       "request": {
@@ -1725,7 +1725,7 @@ Log.d("TAG", file.toString())
       "internal": null,
       "method": "POST",
       "operationId": "multipartFileUploadComplete",
-      "path": "/multipart/complete",
+      "path": "/multipart/complete/",
       "pathParameters": [],
       "queryParameters": [],
       "request": {
@@ -2663,7 +2663,7 @@ Log.d("TAG", file.toString())
       "internal": null,
       "method": "POST",
       "operationId": "fromURLUpload",
-      "path": "/from_url",
+      "path": "/from_url/",
       "pathParameters": [],
       "queryParameters": [],
       "request": {
@@ -4166,7 +4166,7 @@ Log.d("TAG", status.toString())
       "internal": null,
       "method": "GET",
       "operationId": "fromURLUploadStatus",
-      "path": "/from_url/status",
+      "path": "/from_url/status/",
       "pathParameters": [],
       "queryParameters": [
         {
@@ -4932,7 +4932,7 @@ Log.d("TAG", file.toString())
       "internal": null,
       "method": "GET",
       "operationId": "fileUploadInfo",
-      "path": "/info",
+      "path": "/info/",
       "pathParameters": [],
       "queryParameters": [
         {
@@ -5809,7 +5809,7 @@ Log.d("TAG", group.toString())
       "internal": null,
       "method": "POST",
       "operationId": "createFilesGroup",
-      "path": "/group",
+      "path": "/group/",
       "pathParameters": [],
       "queryParameters": [],
       "request": {
@@ -6731,7 +6731,7 @@ Log.d("TAG", group.toString())
       "internal": null,
       "method": "GET",
       "operationId": "filesGroupInfo",
-      "path": "/group/info",
+      "path": "/group/info/",
       "pathParameters": [],
       "queryParameters": [
         {

diff --git a/packages/cli/openapi-parser/src/__test__/fixtures/path/openapi.yml b/packages/cli/openapi-parser/src/__test__/fixtures/path/openapi.yml
@@ -0,0 +1,11 @@
+openapi: 3.0.0
+info:
+  title: Sample Path Parsing API
+  version: 1.0.0
+paths:
+  /example-without-trailing-slash:
+    get:
+      summary: Get Example
+  /example-with-trailing-slash/:
+    get:
+      summary: Get Example with trailing
diff --git a/packages/cli/openapi-parser/src/__test__/path.test.ts b/packages/cli/openapi-parser/src/__test__/path.test.ts
@@ -0,0 +1,5 @@
+import { testParseOpenAPI } from "./testParseOpenApi";
+
+describe("path parsing", () => {
+    testParseOpenAPI("path", "openapi.yml");
+});
diff --git a/packages/cli/openapi-parser/src/openapi/v3/generateIr.ts b/packages/cli/openapi-parser/src/openapi/v3/generateIr.ts
@@ -72,8 +72,7 @@ export function generateIr({
             return;
         }
         taskContext.logger.debug(`Converting path ${path}`);
-        const pathWithoutTrailingSlash = path.replace(/\/$/, "");
-        const convertedOperations = convertPathItem(pathWithoutTrailingSlash, pathItem, openApi, context);
+        const convertedOperations = convertPathItem(path, pathItem, openApi, context);
 
         for (const operation of convertedOperations) {
             switch (operation.type) {