improvement: add x-fern-base-path to asyncapi extensions (#3953)

fern-api · Jun 28, 2024 · d8575c9 · d8575c9
1 parent 83e9429
commit d8575c9
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/packages/cli/openapi-ir-to-fern/src/FernDefnitionBuilder.ts b/packages/cli/openapi-ir-to-fern/src/FernDefnitionBuilder.ts
@@ -332,6 +332,11 @@ export class FernDefinitionBuilderImpl implements FernDefinitionBuilder {
     public addChannel(file: RelativeFilePath, { channel }: { channel: RawSchemas.WebSocketChannelSchema }): void {
         const fernFile = this.getOrCreateFile(file);
         fernFile.channel = channel;
+
+        const basePath = this.basePath;
+        if (basePath != null) {
+            fernFile.channel.path = path.join(basePath, channel.path);
+        }
     }
 
     public addChannelExample(

diff --git a/packages/cli/openapi-parser/src/asyncapi/fernExtensions.ts b/packages/cli/openapi-parser/src/asyncapi/fernExtensions.ts
@@ -28,7 +28,18 @@ export const FernAsyncAPIExtension = {
      *             value:
      *              data: "12340213"
      */
-    FERN_EXAMPLES: "x-fern-examples"
+    FERN_EXAMPLES: "x-fern-examples",
+
+    /**
+     * Prepends the configured base path to all of the endpoint paths.
+     *
+     * x-fern-base-path: /v1
+     * servers:
+     *   - url: https://api.example.com
+     * paths:
+     *   /path/to/my/endpoint:
+     */
+    BASE_PATH: "x-fern-base-path"
 } as const;
 
 export type FernAsyncAPIExtension = Values<typeof FernAsyncAPIExtension>;
diff --git a/packages/cli/openapi-parser/src/asyncapi/parse.ts b/packages/cli/openapi-parser/src/asyncapi/parse.ts
@@ -26,6 +26,7 @@ import { AsyncAPIV2 } from "./v2";
 export interface AsyncAPIIntermediateRepresentation {
     schemas: Record<SchemaId, Schema>;
     channel: WebsocketChannel | undefined;
+    basePath: string | undefined;
 }
 
 export function parseAsyncAPI({
@@ -214,7 +215,8 @@ export function parseAsyncAPI({
         schemas: Object.fromEntries(
             Object.entries(schemas).map(([id, schema]) => [id, convertSchemaWithExampleToSchema(schema)])
         ),
-        channel: parsedChannel
+        channel: parsedChannel,
+        basePath: getExtension<string | undefined>(document, FernAsyncAPIExtension.BASE_PATH)
     };
 }
 

diff --git a/packages/cli/openapi-parser/src/parse.ts b/packages/cli/openapi-parser/src/parse.ts
@@ -109,6 +109,9 @@ export async function parse({
                     ...parsedAsyncAPI.schemas
                 };
             }
+            if (parsedAsyncAPI.basePath != null) {
+                ir.basePath = parsedAsyncAPI.basePath;
+            }
         } else {
             taskContext.failAndThrow(`${spec.absoluteFilepath} is not a valid OpenAPI or AsyncAPI file`);
         }