Skip to content
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs-yml.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4060,6 +4060,16 @@
"type": "null"
}
]
},
"right-text": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
Expand Down
5 changes: 5 additions & 0 deletions fern/apis/docs-yml/definition/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,11 @@ types:
href:
type: optional<string>
docs: The URL that users will be directed to when clicking the logo. Typically your company's homepage or app.
right-text:
type: optional<string>
docs: |
Text to display to the right of the logo image. This is useful for adding a tagline or product name next to your logo.
Example: `Docs`

BackgroundImageConfiguration:
docs: This background image is used to customize the appearance of your docs site.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
"[email protected]>whatwg-url": "^14.0.0",
"qs": "6.13.0",
"url-join": "^4.0.1",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"es-toolkit": "^1.39.10",
"ts-essentials": "^10.1.1",
"form-data": "^4.0.4"
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/configuration-loader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"dependencies": {
"@fern-api/configuration": "workspace:*",
"@fern-api/core-utils": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/github": "workspace:*",
"@fern-api/task-context": "workspace:*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,8 @@ function convertLogoReference(
dark: resolveFilepath(rawLogo.dark, absoluteFilepathToDocsConfig),
light: resolveFilepath(rawLogo.light, absoluteFilepathToDocsConfig),
height: rawLogo.height,
href: rawLogo.href != null ? CjsFdrSdk.Url(rawLogo.href) : undefined
href: rawLogo.href != null ? CjsFdrSdk.Url(rawLogo.href) : undefined,
rightText: rawLogo.rightText
}
: undefined;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/configuration/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
},
"dependencies": {
"@fern-api/core-utils": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fern-definition-schema": "workspace:*",
"@fern-api/path-utils": "workspace:*",
"@fern-fern/fiddle-sdk": "0.0.738",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ export interface Logo {
light: AbsoluteFilePath | undefined;
height: CjsFdrSdk.docs.v1.write.Height | undefined;
href: CjsFdrSdk.Url | undefined;
rightText: string | undefined;
}

export interface BackgroundImage {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,9 @@ export interface LogoConfiguration {
height?: number;
/** The URL that users will be directed to when clicking the logo. Typically your company's homepage or app. */
href?: string;
/**
* Text to display to the right of the logo image. This is useful for adding a tagline or product name next to your logo.
* Example: `Docs`
*/
rightText?: string;
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export const LogoConfiguration: core.serialization.ObjectSchema<
light: core.serialization.string().optional(),
height: core.serialization.number().optional(),
href: core.serialization.string().optional(),
rightText: core.serialization.property("right-text", core.serialization.string().optional()),
});

export declare namespace LogoConfiguration {
Expand All @@ -22,5 +23,6 @@ export declare namespace LogoConfiguration {
light?: string | null;
height?: number | null;
href?: string | null;
"right-text"?: string | null;
}
}
2 changes: 1 addition & 1 deletion packages/cli/docs-importers/commons/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
},
"dependencies": {
"@fern-api/configuration": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/task-context": "workspace:*",
"js-yaml": "^4.1.1"
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs-importers/mintlify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@fern-api/configuration": "workspace:*",
"@fern-api/core-utils": "workspace:*",
"@fern-api/docs-importer-commons": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/logger": "workspace:*",
"@fern-api/task-context": "workspace:*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ export async function convertMarkdown({
"no-image-zoom": undefined,
"force-toc": undefined,
"hide-nav-links": undefined,
"last-updated": undefined,
breadcrumb: undefined,
excerpt: undefined,
"canonical-url": undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs-importers/readme/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@fern-api/configuration": "workspace:*",
"@fern-api/core-utils": "workspace:*",
"@fern-api/docs-importer-commons": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/logger": "workspace:*",
"@fern-api/task-context": "workspace:*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ export async function convertMarkdown({
"hide-toc": undefined,
"hide-page-actions": undefined,
"hide-feedback": undefined,
"last-updated": undefined,
"no-image-zoom": undefined,
"force-toc": undefined,
"hide-nav-links": undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs-markdown-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"test:update": "vitest --run -u"
},
"dependencies": {
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/task-context": "workspace:*",
"estree-walker": "^3.0.3",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs-preview/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"dependencies": {
"@fern-api/core-utils": "workspace:*",
"@fern-api/docs-resolver": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/ir-sdk": "workspace:*",
"@fern-api/logger": "workspace:*",
Expand Down
1 change: 1 addition & 0 deletions packages/cli/docs-preview/src/runAppPreviewServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ const EMPTY_DOCS_DEFINITION: DocsV1Read.DocsDefinition = {
footerLinks: undefined,
logoHeight: undefined,
logoHref: undefined,
logoRightText: undefined,
favicon: undefined,
metadata: undefined,
redirects: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/cli/docs-preview/src/runPreviewServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ const EMPTY_DOCS_DEFINITION: DocsV1Read.DocsDefinition = {
footerLinks: undefined,
logoHeight: undefined,
logoHref: undefined,
logoRightText: undefined,
favicon: undefined,
metadata: undefined,
redirects: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs-resolver/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"@fern-api/core-utils": "workspace:*",
"@fern-api/docs-markdown-utils": "workspace:*",
"@fern-api/docs-parsers": "0.0.65",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/ir-generator": "workspace:*",
"@fern-api/ir-sdk": "workspace:*",
Expand Down
1 change: 1 addition & 0 deletions packages/cli/docs-resolver/src/DocsDefinitionResolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,7 @@ export class DocsDefinitionResolver {
title: this.parsedDocsConfig.title,
logoHeight: this.parsedDocsConfig.logo?.height,
logoHref: this.parsedDocsConfig.logo?.href ? DocsV1Write.Url(this.parsedDocsConfig.logo?.href) : undefined,
logoRightText: this.parsedDocsConfig.logo?.rightText,
favicon: this.getFileId(this.parsedDocsConfig.favicon),
navigation: undefined, // <-- this is now deprecated
root,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ it.skip("finds webhook by id and by path/method", () => {
headers: [],
payloads: [],
examples: [],
responses: [],
description: "description",
availability: undefined,
namespace: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ it.skip("generates slug for webhook", () => {
availability: undefined,
headers: [],
payloads: [],
responses: [],
description: undefined
};
expect(
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/ete-tests/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
},
"dependencies": {
"@fern-api/configuration": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/logger": "workspace:*",
"@fern-api/logging-execa": "workspace:*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"@fern-api/core-utils": "workspace:*",
"@fern-api/docs-resolver": "workspace:*",
"@fern-api/fai-sdk": "0.0.6-2ee1b7e28",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/ir-generator": "workspace:*",
"@fern-api/ir-migrations": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/register/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"@fern-api/configuration": "workspace:*",
"@fern-api/core": "workspace:*",
"@fern-api/core-utils": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/ir-generator": "workspace:*",
"@fern-api/ir-sdk": "workspace:*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
],
},
],
"name": "Add a Comment",
"name": "Createcomment",
"originalEndpointId": "endpoint_commentsService.createcomment",
"path": {
"parts": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@
"availability": undefined,
"basePath": undefined,
"baseUrl": undefined,
"displayName": "Add a Comment",
"displayName": undefined,
"docs": "buf:lint:ignore RPC_REQUEST_STANDARD_NAME
Create a comment on a resource",
"errors": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
},
},
},
"responses": undefined,
},
],
"websockets": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ function convertWebhookGroup(webhookGroup: Ir.webhooks.WebhookGroup): FdrCjsSdk.
})
),
payload: convertWebhookPayload(webhook.payload),
examples: webhookExamples
examples: webhookExamples,
responses: undefined
};
});
}
Expand Down
10 changes: 10 additions & 0 deletions packages/cli/workspace/loader/src/docs-yml.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4060,6 +4060,16 @@
"type": "null"
}
]
},
"right-text": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/yaml/docs-validator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"@fern-api/core-utils": "workspace:*",
"@fern-api/docs-markdown-utils": "workspace:*",
"@fern-api/docs-resolver": "workspace:*",
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/fern-definition-schema": "workspace:*",
"@fern-api/fs-utils": "workspace:*",
"@fern-api/ir-generator": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"test:update": "vitest --passWithNoTests --run -u"
},
"dependencies": {
"@fern-api/fdr-sdk": "0.142.1-b1f6b6363",
"@fern-api/fdr-sdk": "0.142.4-4cf986c21",
"@fern-api/venus-api-sdk": "0.17.3-3-gf696595",
"@fern-fern/fdr-test-sdk": "^0.0.5297",
"@fern-fern/fiddle-sdk": "0.0.738",
Expand Down
Loading
Loading