feat(cli): support x-fern-ignore extension for AsyncAPI channels. (#…

…5742)
fern-api · Jan 24, 2025 · 83641f3 · 83641f3
1 parent 8f97bbd
commit 83641f3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/asyncapi/fernExtensions.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/asyncapi/fernExtensions.ts
@@ -39,7 +39,16 @@ export const FernAsyncAPIExtension = {
      * paths:
      *   /path/to/my/endpoint:
      */
-    BASE_PATH: "x-fern-base-path"
+    BASE_PATH: "x-fern-base-path",
+
+    /**
+     * Used to tell fern to ignore channels.
+     *
+     * channels:
+     *   /my-channel:
+     *     x-fern-ignore: true
+     */
+    IGNORE: "x-fern-ignore"
 } as const;
 
 export type FernAsyncAPIExtension = Values<typeof FernAsyncAPIExtension>;
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/asyncapi/parse.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/asyncapi/parse.ts
@@ -82,6 +82,11 @@ export function parseAsyncAPI({
     const exampleFactory = new ExampleWebsocketSessionFactory(schemas, context);
 
     for (const [channelPath, channel] of Object.entries(document.channels ?? {})) {
+        const shouldIgnore = getExtension<boolean>(channel, FernAsyncAPIExtension.IGNORE);
+        if (shouldIgnore != null && shouldIgnore) {
+            context.logger.info(`Channel ${channelPath} is marked with x-fern-ignore. Skipping.`);
+            continue;
+        }
         if (channel.bindings?.ws == null) {
             context.logger.error(`Channel ${channelPath} does not have websocket bindings. Skipping.`);
             continue;