feat: plumb through navigation v1 (#1651)

fern-api · Oct 11, 2024 · 6478b57 · 6478b57
1 parent 62a7f30
commit 6478b57
Show file tree

Hide file tree

Showing 32 changed files with 431 additions and 218 deletions.
diff --git a/fern/apis/fdr/definition/docs/v1/db/__package__.yml b/fern/apis/fdr/definition/docs/v1/db/__package__.yml
@@ -6,6 +6,7 @@ imports:
   apiReadV1Endpoint: ../../../api/v1/read/endpoint.yml
   docsReadV1: ../read/__package__.yml
   commons: ../commons/commons.yml
+  navigationV1: ../../../navigation/v1/__package__.yml
 
 types:
   DocsDefinitionDb:
@@ -52,7 +53,10 @@ types:
       announcement: optional<commons.AnnouncementConfig>
 
       # navigation
-      navigation: NavigationConfig
+      navigation:
+        type: optional<NavigationConfig>
+        availability: deprecated
+      root: optional<navigationV1.RootNode>
       navbarLinks: optional<list<commons.NavbarLink>>
       footerLinks: optional<list<commons.FooterLink>>
 

diff --git a/fern/apis/fdr/definition/docs/v1/read/__package__.yml b/fern/apis/fdr/definition/docs/v1/read/__package__.yml
@@ -6,7 +6,7 @@ imports:
   apiReadV1: ../../../api/v1/read/__package__.yml
   apiCommonsV1: ../../../api/v1/commons.yml
   commons: ../commons/commons.yml
-  navigation: ../../../navigation/v1/__package__.yml
+  navigationV1: ../../../navigation/v1/__package__.yml
 
 service:
   base-path: /registry/docs
@@ -90,7 +90,10 @@ types:
       announcement: optional<commons.AnnouncementConfig>
 
       # navigation
-      navigation: NavigationConfig
+      navigation:
+        type: optional<NavigationConfig>
+        availability: deprecated
+      root: optional<navigationV1.RootNode>
       navbarLinks: optional<list<commons.NavbarLink>>
       footerLinks: optional<list<commons.FooterLink>>
 
@@ -266,7 +269,7 @@ types:
 
   ApiSectionV2:
     properties:
-      node: navigation.ApiReferenceNode
+      node: navigationV1.ApiReferenceNode
 
   ApiNavigationConfigRoot:
     availability: deprecated
@@ -300,7 +303,7 @@ types:
 
   ChangelogSectionV3:
     properties:
-      node: navigation.ChangelogNode
+      node: navigationV1.ChangelogNode
 
   ChangelogItem:
     properties:

diff --git a/fern/apis/fdr/definition/docs/v1/write/__package__.yml b/fern/apis/fdr/definition/docs/v1/write/__package__.yml
@@ -3,7 +3,7 @@
 imports:
   rootCommons: ../../../commons.yml
   commons: ../commons/commons.yml
-  navigation: ../../../navigation/v1/__package__.yml
+  navigationV1: ../../../navigation/v1/__package__.yml
   apiCommonsV1: ../../../api/v1/commons.yml
 
 service:
@@ -87,7 +87,10 @@ types:
       announcement: optional<commons.AnnouncementConfig>
 
       # navigation
-      navigation: NavigationConfig
+      navigation:
+        type: optional<NavigationConfig>
+        availability: deprecated
+      root: optional<navigationV1.RootNode>
       navbarLinks: optional<list<commons.NavbarLink>>
       footerLinks: optional<list<commons.FooterLink>>
 
@@ -277,7 +280,7 @@ types:
 
   ApiSectionV2:
     properties:
-      node: navigation.ApiReferenceNode
+      node: navigationV1.ApiReferenceNode
 
   ApiNavigationConfigRoot:
     availability: deprecated
@@ -331,7 +334,7 @@ types:
 
   ChangelogSectionV3:
     properties:
-      node: navigation.ChangelogNode
+      node: navigationV1.ChangelogNode
 
   ChangelogItem:
     properties:

diff --git a/fern/apis/fdr/definition/navigation/v1/__package__.yml b/fern/apis/fdr/definition/navigation/v1/__package__.yml
@@ -321,6 +321,8 @@ types:
       slug: Slug
       icon: optional<string>
       hidden: optional<boolean>
+      authed: optional<boolean>
+      audience: optional<list<commons.AudienceId>>
 
   WithPage:
     properties:

diff --git a/packages/commons/fdr-utils/src/definition-object-factory.ts b/packages/commons/fdr-utils/src/definition-object-factory.ts
@@ -21,6 +21,7 @@ export class DefinitionObjectFactory {
                 },
                 navbarLinks: [],
                 navigation: { items: [], landingPage: undefined },
+                root: undefined,
                 title: undefined,
                 defaultLanguage: undefined,
                 announcement: undefined,

diff --git a/...k/src/client/generated/api/resources/docs/resources/v1/resources/db/types/DocsDbConfig.ts b/...k/src/client/generated/api/resources/docs/resources/v1/resources/db/types/DocsDbConfig.ts
diff --git a/...k/src/client/generated/api/resources/docs/resources/v1/resources/read/types/DocsConfig.ts b/...k/src/client/generated/api/resources/docs/resources/v1/resources/read/types/DocsConfig.ts
diff --git a/...sdk/src/client/generated/api/resources/docs/resources/v1/resources/write/client/Client.ts b/...sdk/src/client/generated/api/resources/docs/resources/v1/resources/write/client/Client.ts
diff --git a/...ed/api/resources/docs/resources/v1/resources/write/client/requests/RegisterDocsRequest.ts b/...ed/api/resources/docs/resources/v1/resources/write/client/requests/RegisterDocsRequest.ts
diff --git a/.../src/client/generated/api/resources/docs/resources/v1/resources/write/types/DocsConfig.ts b/.../src/client/generated/api/resources/docs/resources/v1/resources/write/types/DocsConfig.ts