feat: skipUrlSlug in tabs (#943)

fern-api · May 31, 2024 · 3c97f67 · 3c97f67
1 parent b7476d6
commit 3c97f67
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 1 deletion.
diff --git a/fern/apis/fdr/definition/docs/v1/db/__package__.yml b/fern/apis/fdr/definition/docs/v1/db/__package__.yml
@@ -141,6 +141,7 @@ types:
       icon: optional<string>
       items: list<NavigationItem>
       urlSlug: string
+      skipUrlSlug: optional<boolean>
 
   UnversionedUntabbedNavigationConfig:
     properties:

diff --git a/fern/apis/fdr/definition/docs/v1/read/__package__.yml b/fern/apis/fdr/definition/docs/v1/read/__package__.yml
@@ -233,6 +233,7 @@ types:
     properties:
       title: string
       items: list<NavigationItem>
+      skipUrlSlug: boolean
 
   NavigationTabLink:
     properties:

diff --git a/fern/apis/fdr/definition/docs/v1/write/__package__.yml b/fern/apis/fdr/definition/docs/v1/write/__package__.yml
@@ -180,6 +180,7 @@ types:
     properties:
       title: string
       items: list<NavigationItem>
+      skipUrlSlug: optional<boolean>
 
   NavigationTabLink:
     properties:

diff --git a/packages/commons/fdr-utils/src/resolver.ts b/packages/commons/fdr-utils/src/resolver.ts
@@ -198,7 +198,12 @@ function resolveSidebarNodesVersionItems(
     if (isUnversionedTabbedNavigationConfig(nav)) {
         return nav.tabs.map((tab, index): SidebarNodeRaw.Tab => {
             if (tab.type === "group" || (tab.type == null && tab.items != null)) {
-                const parentSlugs = [...fixedSlugs, ...tab.urlSlug.split("/")];
+                const parentSlugs =
+                    tab.fullSlug != null
+                        ? [...fixedSlugs, ...tab.fullSlug]
+                        : tab.skipUrlSlug
+                          ? fixedSlugs
+                          : [...fixedSlugs, ...tab.urlSlug.split("/")];
                 return {
                     type: "tabGroup",
                     title: tab.title,

diff --git a/...client/generated/api/resources/docs/resources/v1/resources/db/types/NavigationTabGroup.ts b/...client/generated/api/resources/docs/resources/v1/resources/db/types/NavigationTabGroup.ts
@@ -9,4 +9,5 @@ export interface NavigationTabGroup {
     icon?: string;
     items: FernRegistry.docs.v1.db.NavigationItem[];
     urlSlug: string;
+    skipUrlSlug?: boolean;
 }
diff --git a/...ient/generated/api/resources/docs/resources/v1/resources/read/types/NavigationTabGroup.ts b/...ient/generated/api/resources/docs/resources/v1/resources/read/types/NavigationTabGroup.ts
@@ -7,4 +7,5 @@ import * as FernRegistry from "../../../../../../..";
 export interface NavigationTabGroup extends FernRegistry.docs.v1.read.NavigationNodeMetadata {
     title: string;
     items: FernRegistry.docs.v1.read.NavigationItem[];
+    skipUrlSlug: boolean;
 }
diff --git a/...ent/generated/api/resources/docs/resources/v1/resources/write/types/NavigationTabGroup.ts b/...ent/generated/api/resources/docs/resources/v1/resources/write/types/NavigationTabGroup.ts
@@ -7,4 +7,5 @@ import * as FernRegistry from "../../../../../../..";
 export interface NavigationTabGroup extends FernRegistry.docs.v1.write.NavigationNodeMetadata {
     title: string;
     items: FernRegistry.docs.v1.write.NavigationItem[];
+    skipUrlSlug?: boolean;
 }
diff --git a/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts b/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts
@@ -143,6 +143,7 @@ export function transformNavigationTabForDb(dbShape: DocsV1Db.NavigationTab): Do
             type: "group",
             ...group,
             items: group.items.map(transformNavigationItemForDb),
+            skipUrlSlug: group.skipUrlSlug ?? false,
         }),
     });
 }
@@ -155,6 +156,7 @@ export function transformNavigationTabV2ForDb(dbShape: DocsV1Db.NavigationTabV2)
             return {
                 ...dbShape,
                 items: dbShape.items.map(transformNavigationItemForDb),
+                skipUrlSlug: dbShape.skipUrlSlug ?? false,
             };
         case "changelog":
             return dbShape;

diff --git a/.../api/generated/api/resources/docs/resources/v1/resources/db/types/NavigationTabGroup.d.ts b/.../api/generated/api/resources/docs/resources/v1/resources/db/types/NavigationTabGroup.d.ts
@@ -7,4 +7,5 @@ export interface NavigationTabGroup {
     icon?: string;
     items: FernRegistry.docs.v1.db.NavigationItem[];
     urlSlug: string;
+    skipUrlSlug?: boolean;
 }
diff --git a/...pi/generated/api/resources/docs/resources/v1/resources/read/types/NavigationTabGroup.d.ts b/...pi/generated/api/resources/docs/resources/v1/resources/read/types/NavigationTabGroup.d.ts
@@ -5,4 +5,5 @@ import * as FernRegistry from "../../../../../../..";
 export interface NavigationTabGroup extends FernRegistry.docs.v1.read.NavigationNodeMetadata {
     title: string;
     items: FernRegistry.docs.v1.read.NavigationItem[];
+    skipUrlSlug: boolean;
 }
diff --git a/...i/generated/api/resources/docs/resources/v1/resources/write/types/NavigationTabGroup.d.ts b/...i/generated/api/resources/docs/resources/v1/resources/write/types/NavigationTabGroup.d.ts
@@ -5,4 +5,5 @@ import * as FernRegistry from "../../../../../../..";
 export interface NavigationTabGroup extends FernRegistry.docs.v1.write.NavigationNodeMetadata {
     title: string;
     items: FernRegistry.docs.v1.write.NavigationItem[];
+    skipUrlSlug?: boolean;
 }