feat: allow users to override the api reference url slug (#824)

fern-api · May 8, 2024 · f3e8b2a · f3e8b2a
1 parent a531d95
commit f3e8b2a
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 1 deletion.
diff --git a/fern/apis/fdr/definition/docs/v1/write/__package__.yml b/fern/apis/fdr/definition/docs/v1/write/__package__.yml
@@ -334,6 +334,7 @@ types:
       showErrors: optional<boolean>
       changelog: optional<ChangelogSection>
       hidden: optional<boolean>
+      urlSlugOverride: optional<string>
       fullSlug: optional<list<string>>
       navigation: optional<ApiNavigationConfigRoot>
       longScrolling: optional<boolean>

diff --git a/.../src/client/generated/api/resources/docs/resources/v1/resources/write/types/ApiSection.ts b/.../src/client/generated/api/resources/docs/resources/v1/resources/write/types/ApiSection.ts
@@ -13,6 +13,7 @@ export interface ApiSection {
     showErrors?: boolean;
     changelog?: FernRegistry.docs.v1.write.ChangelogSection;
     hidden?: boolean;
+    urlSlugOverride?: string;
     fullSlug?: string[];
     navigation?: FernRegistry.docs.v1.write.ApiNavigationConfigRoot;
     longScrolling?: boolean;

diff --git a/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts b/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts
@@ -175,7 +175,7 @@ export function transformNavigationItemForDb(
                 longScrolling: writeShape.longScrolling,
                 flattened: writeShape.flattened,
                 fullSlug: writeShape.fullSlug,
-                urlSlug: kebabCase(writeShape.title),
+                urlSlug: writeShape.urlSlugOverride ?? kebabCase(writeShape.title),
                 artifacts:
                     writeShape.artifacts != null ? transformArtifactsForReading(writeShape.artifacts) : undefined,
                 skipUrlSlug: writeShape.skipUrlSlug ?? false,

diff --git a/...r/src/api/generated/api/resources/docs/resources/v1/resources/write/types/ApiSection.d.ts b/...r/src/api/generated/api/resources/docs/resources/v1/resources/write/types/ApiSection.d.ts
@@ -11,6 +11,7 @@ export interface ApiSection {
     showErrors?: boolean;
     changelog?: FernRegistry.docs.v1.write.ChangelogSection;
     hidden?: boolean;
+    urlSlugOverride?: string;
     fullSlug?: string[];
     navigation?: FernRegistry.docs.v1.write.ApiNavigationConfigRoot;
     longScrolling?: boolean;