feat: disable batch/stream toggle (#4108)

fix: disable stream toggle flag
fern-api · Jul 24, 2024 · bccbdaf · bccbdaf
1 parent ed71266
commit bccbdaf
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/packages/cli/configuration/fern/definition/docs.yml b/packages/cli/configuration/fern/definition/docs.yml
@@ -821,3 +821,9 @@ types:
         docs: |
           List of relative paths to folders or files that end in .{ts,tsx,js,jsx},
           and makes them available for use in MDX files.
+      disable-stream-toggle:
+        type: optional<boolean>
+        docs: |
+          If `disable-stream-toggle` is set to true, the stream toggle will be disabled.
+
+          This behavior is unstable and may change in the future.
diff --git a/...cli/configuration/src/docs-yml/schemas/sdk/api/resources/docs/types/ExperimentalConfig.ts b/...cli/configuration/src/docs-yml/schemas/sdk/api/resources/docs/types/ExperimentalConfig.ts
@@ -8,4 +8,10 @@ export interface ExperimentalConfig {
      * and makes them available for use in MDX files.
      */
     mdxComponents?: string[];
+    /**
+     * If `disable-stream-toggle` is set to true, the stream toggle will be disabled.
+     *
+     * This behavior is unstable and may change in the future.
+     */
+    disableStreamToggle?: boolean;
 }
diff --git a/...uration/src/docs-yml/schemas/sdk/serialization/resources/docs/types/ExperimentalConfig.ts b/...uration/src/docs-yml/schemas/sdk/serialization/resources/docs/types/ExperimentalConfig.ts
@@ -14,10 +14,12 @@ export const ExperimentalConfig: core.serialization.ObjectSchema<
         "mdx-components",
         core.serialization.list(core.serialization.string()).optional()
     ),
+    disableStreamToggle: core.serialization.property("disable-stream-toggle", core.serialization.boolean().optional()),
 });
 
 export declare namespace ExperimentalConfig {
     interface Raw {
         "mdx-components"?: string[] | null;
+        "disable-stream-toggle"?: boolean | null;
     }
 }
diff --git a/packages/cli/docs-resolver/src/ApiReferenceNodeConverter.ts b/packages/cli/docs-resolver/src/ApiReferenceNodeConverter.ts
@@ -23,6 +23,7 @@ export class ApiReferenceNodeConverter {
     #children: FernNavigation.ApiPackageChild[] = [];
     #overviewPageId: FernNavigation.PageId | undefined;
     #slug: FernNavigation.SlugGenerator;
+    private disableEndpointPairs;
     constructor(
         private apiSection: docsYml.DocsNavigationItem.ApiSection,
         api: APIV1Read.ApiDefinition,
@@ -32,6 +33,7 @@ export class ApiReferenceNodeConverter {
         private taskContext: TaskContext,
         private markdownFilesToFullSlugs: Map<AbsoluteFilePath, string>
     ) {
+        this.disableEndpointPairs = docsWorkspace.config.experimental?.disableStreamToggle ?? false;
         this.apiDefinitionId = FernNavigation.ApiDefinitionId(api.id);
         this.#holder = ApiDefinitionHolder.create(api, taskContext);
 
@@ -625,6 +627,10 @@ export class ApiReferenceNodeConverter {
     }
 
     private mergeEndpointPairs(children: FernNavigation.ApiPackageChild[]): FernNavigation.ApiPackageChild[] {
+        if (this.disableEndpointPairs) {
+            return children;
+        }
+
         const toRet: FernNavigation.ApiPackageChild[] = [];
 
         const methodAndPathToEndpointNode = new Map<string, FernNavigation.EndpointNode>();