diff --git a/fern/apis/fdr/definition/commons.yml b/fern/apis/fdr/definition/commons.yml index 8be958bad3..976f31c549 100644 --- a/fern/apis/fdr/definition/commons.yml +++ b/fern/apis/fdr/definition/commons.yml @@ -81,6 +81,13 @@ types: - Deprecated - Beta + RgbaColor: + properties: + r: integer + g: integer + b: integer + a: optional + errors: BadRequestError: status-code: 400 diff --git a/fern/apis/fdr/definition/docs/v1/commons/commons.yml b/fern/apis/fdr/definition/docs/v1/commons/commons.yml index deb7a75c7c..72014516d0 100644 --- a/fern/apis/fdr/definition/docs/v1/commons/commons.yml +++ b/fern/apis/fdr/definition/docs/v1/commons/commons.yml @@ -9,13 +9,6 @@ types: fileId: rootCommons.FileId url: rootCommons.Url - RgbaColor: - properties: - r: integer - g: integer - b: integer - a: optional - # Docs layout config ProgrammingLanguage: @@ -344,7 +337,7 @@ types: ColorsConfig: availability: deprecated properties: - accentPrimary: optional + accentPrimary: optional ColorsConfigV2: availability: deprecated @@ -361,13 +354,13 @@ types: ColorUnthemedConfig: availability: deprecated properties: - color: optional + color: optional ColorThemedConfig: availability: deprecated properties: - dark: optional - light: optional + dark: optional + light: optional DocsTypographyConfig: availability: deprecated diff --git a/fern/apis/fdr/definition/docs/v1/read/__package__.yml b/fern/apis/fdr/definition/docs/v1/read/__package__.yml index 7b34a64261..89f99de1c9 100644 --- a/fern/apis/fdr/definition/docs/v1/read/__package__.yml +++ b/fern/apis/fdr/definition/docs/v1/read/__package__.yml @@ -149,12 +149,12 @@ types: properties: logo: optional backgroundImage: optional - accentPrimary: commons.RgbaColor + accentPrimary: rootCommons.RgbaColor background: Background - border: optional - sidebarBackground: optional - headerBackground: optional - cardBackground: optional + border: optional + sidebarBackground: optional + headerBackground: optional + cardBackground: optional DarkAndLightModeConfig: properties: @@ -163,7 +163,7 @@ types: Background: union: - solid: commons.RgbaColor + solid: rootCommons.RgbaColor gradient: {} NavigationConfig: diff --git a/fern/apis/fdr/definition/docs/v1/write/__package__.yml b/fern/apis/fdr/definition/docs/v1/write/__package__.yml index 40b0fc6b32..f21e3379e3 100644 --- a/fern/apis/fdr/definition/docs/v1/write/__package__.yml +++ b/fern/apis/fdr/definition/docs/v1/write/__package__.yml @@ -143,12 +143,12 @@ types: properties: logo: optional backgroundImage: optional - accentPrimary: commons.RgbaColor - background: optional - border: optional - sidebarBackground: optional - headerBackground: optional - cardBackground: optional + accentPrimary: rootCommons.RgbaColor + background: optional + border: optional + sidebarBackground: optional + headerBackground: optional + cardBackground: optional DarkAndLightModeConfig: properties: diff --git a/fern/apis/fdr/definition/docs/v3/__package__.yml b/fern/apis/fdr/definition/docs/v3/__package__.yml new file mode 100644 index 0000000000..a5b4a25da0 --- /dev/null +++ b/fern/apis/fdr/definition/docs/v3/__package__.yml @@ -0,0 +1,163 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json + +imports: + rootCommons: ../../commons.yml + navigation: ../../navigation/latest/__package__.yml + algolia: ../../algolia.yml + v1Commons: ../v1/commons/commons.yml + +service: + base-path: /v3/registry/docs + auth: true + endpoints: + getOrganization: + method: GET + path: /{domain}/organization + path-parameters: + domain: string + response: rootCommons.OrgId + errors: + - rootCommons.UnauthorizedError + - rootCommons.NotFoundError + + getNavigation: + method: GET + path: /{domain}/instance/{id}/navigation + path-parameters: + domain: string + id: DocsInstanceId + response: navigation.RootNode + errors: + - rootCommons.UnauthorizedError + - rootCommons.NotFoundError + + getConfig: + method: GET + path: /{domain}/instance/{id}/config + path-parameters: + domain: string + id: DocsInstanceId + response: DocsConfig + errors: + - rootCommons.UnauthorizedError + - rootCommons.NotFoundError + + getPages: + method: POST + path: /{domain}/instance/{id}/pages + path-parameters: + domain: string + id: DocsInstanceId + request: + name: BulkGetPagesRequest + body: + properties: + pages: list + response: map + errors: + - rootCommons.UnauthorizedError + - rootCommons.NotFoundError + + getFiles: + method: POST + path: /{domain}/instance/{id}/files + path-parameters: + domain: string + id: DocsInstanceId + request: + name: BulkGetFilesRequest + body: + properties: + files: list + response: map + errors: + - rootCommons.UnauthorizedError + - rootCommons.NotFoundError + +types: + DocsInstanceId: + discriminated: false + union: + - rootCommons.DocsConfigId + - literal<"latest"> + + FileMetadata: + union: + url: UrlFile + image: ImageFile + + UrlFile: + properties: + url: rootCommons.Url + + ImageFile: + properties: + url: rootCommons.Url + width: double + height: double + blurDataUrl: optional + alt: optional + + DocsConfig: + properties: + id: rootCommons.DocsConfigId + updatedAt: timestamp + + title: optional + defaultLanguage: optional + announcement: optional + + # navigation + navbarLinks: optional> + footerLinks: optional> + + # logo + logoHeight: optional + logoHref: optional + favicon: optional + + # seo + metadata: optional + redirects: optional> + + # styles + colors: optional + fonts: optional + layout: optional + + # integrations + analytics: optional + integrations: optional + search: optional + + # css and js + css: optional + js: optional + + # playground + playground: optional + + # files + files: optional> + markdownPageIds: optional> + mdxBundlerFileIds: optional> + + ColorsConfig: + properties: + dark: optional + light: optional + + ThemeConfig: + properties: + logo: optional + backgroundImage: optional + accentPrimary: rootCommons.RgbaColor + background: Background + border: optional + sidebarBackground: optional + headerBackground: optional + cardBackground: optional + + GetSearchKeyResponse: + properties: + key: string