{ "anyOf": [ { "type": "object", "properties": { "theme": { "type": "string", "const": "jam" }, "$schema": { "type": "string", "format": "uri", "default": "https://www.jamdesk.com/docs.json", "description": "The URL to the JSON schema file for validation" }, "projectId": { "type": "string", "description": "Jamdesk project identifier. Automatically set by jamdesk deploy." }, "name": { "type": "string", "minLength": 1, "description": "Your project, organization, or product name displayed throughout your Jamdesk site" }, "description": { "type": "string", "description": "Optional site description for search engine optimization and AI indexing" }, "colors": { "$ref": "#/definitions/colorsSchema" }, "logo": { "anyOf": [ { "type": "string", "minLength": 3, "description": "Logo image path used for both light and dark themes" }, { "type": "object", "properties": { "light": { "type": "string", "description": "Path to the light theme logo file (shown in dark mode), including file extension. Example: `/logo.png`" }, "dark": { "type": "string", "description": "Path to the dark theme logo file (shown in light mode), including file extension. Example: `/logo-dark.png`" }, "href": { "$ref": "#/definitions/hrefSchema", "description": "URL destination when clicking the logo. If omitted, defaults to your site homepage. Example: `https://example.com`" } }, "required": [ "light" ], "additionalProperties": false } ], "description": "Configure your site logo. Use a single image for both themes, or separate light/dark images with an optional click destination URL" }, "favicon": { "anyOf": [ { "type": "string", "description": "Path to your favicon file in the docs folder, including file extension. Jamdesk automatically resizes it to required dimensions" }, { "type": "object", "properties": { "light": { "type": "string", "description": "Path to the light theme favicon (shown in dark mode), including file extension. Example: `/favicon.png`" }, "dark": { "type": "string", "description": "Path to the dark theme favicon (shown in light mode), including file extension. Example: `/favicon-dark.png`" } }, "required": [ "light", "dark" ], "additionalProperties": false, "description": "Favicon path configuration. Use a single file for both themes, or separate light/dark favicons. Example: `/favicon.png`" } ] }, "api": { "type": "object", "properties": { "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "params": { "type": "object", "properties": { "expanded": { "type": "string", "enum": [ "all", "closed" ], "description": "Control how API parameters are displayed. Options: `all` (all expanded) or `closed` (collapsed by default). Defaults to `closed`" } }, "additionalProperties": false, "description": "Customize how API parameters are presented in your documentation" }, "playground": { "type": "object", "properties": { "display": { "type": "string", "enum": [ "interactive", "simple", "none" ], "description": "Set the API playground display style. Options: `interactive` (full playground), `simple` (simplified view), or `none` (hidden). Defaults to `interactive`" }, "proxy": { "type": "boolean", "description": "Enable proxy server for API requests to handle CORS and authentication. Defaults to `true` when display is `interactive`, `false` otherwise" } }, "additionalProperties": false, "description": "Configure the interactive API playground experience" }, "examples": { "type": "object", "properties": { "defaults": { "type": "string", "enum": [ "required", "all" ], "description": "Control which parameters appear in API examples. Options: `required` (only required params) or `all` (all parameters). Defaults to `all`" }, "languages": { "type": "array", "items": { "type": "string", "enum": [ "curl", "bash", "python", "javascript", "go", "ruby", "csharp", "java", "rust", "php" ] }, "uniqueItems": true, "description": "Programming languages to include in auto-generated API code examples. Order determines tab display order. Defaults to [\"curl\", \"python\", \"javascript\"]" }, "prefill": { "type": "boolean", "description": "Automatically populate the API playground with example values when enabled" } }, "additionalProperties": false, "description": "Customize auto-generated API code examples and snippets" }, "mdx": { "type": "object", "properties": { "auth": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "bearer", "basic", "key", "cobo" ], "description": "API authentication method. Options: `bearer`, `basic`, `key`, or `cobo`" }, "name": { "type": "string", "description": "Display name for the API authentication scheme" } }, "additionalProperties": false, "description": "Configure API authentication settings for your documentation" }, "server": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "array", "items": { "type": "string", "format": "uri" } } ], "description": "Base URL(s) for your API server. Accepts a single URL string or an array of URLs" } }, "additionalProperties": false, "description": "Settings for API documentation pages created from MDX content" } }, "additionalProperties": false, "description": "Configure API reference documentation, interactive playground, and code examples" }, "appearance": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "system", "light", "dark" ], "description": "Set the default theme appearance. Options: `system` (follows OS preference), `light`, or `dark`. Defaults to `system`" }, "strict": { "type": "boolean", "description": "Hide the theme toggle button from users. When `true`, users cannot switch between light and dark modes. Defaults to `false`" } }, "additionalProperties": false, "description": "Configure theme appearance and dark mode settings" }, "background": { "type": "object", "properties": { "image": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "light": { "type": "string" }, "dark": { "type": "string" } }, "required": [ "light", "dark" ], "additionalProperties": false } ], "description": "Set a fixed background image for your site. Accepts absolute URLs or relative paths to image files" }, "decoration": { "type": "string", "enum": [ "gradient", "grid", "windows" ], "description": "Choose a background decoration style. Options: `gradient`, `grid`, or `windows`" }, "color": { "$ref": "#/definitions/colorPairSchema", "description": "Customize background colors for light and dark themes" } }, "additionalProperties": false, "description": "Configure background images, colors, and decorative patterns" }, "navbar": { "type": "object", "properties": { "style": { "type": "string", "enum": [ "default", "topOfContent" ], "description": "Navbar display style. Accepted for Mintlify compatibility but currently ignored \u2014 all navbars use the default style" }, "links": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "label", "href" ], "additionalProperties": false }, "description": "Navigation links displayed in the top navigation bar" }, "primary": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "button" }, "label": { "type": "string" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "type", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "github" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "type", "href" ], "additionalProperties": false } ], "description": "Primary call-to-action button displayed in the navigation bar" } }, "additionalProperties": false, "description": "Configure navigation bar links and primary call-to-action" }, "tabsPosition": { "type": "string", "enum": [ "top", "left" ], "description": "Controls where navigation tabs are displayed. `top` places tabs in the header bar, `left` places them at the top of the sidebar. Default depends on theme: jam/nebula default to `left`, pulsar defaults to `top`" }, "anchors": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Display text for the anchor link" }, "href": { "type": "string", "minLength": 1, "description": "URL the anchor links to (opens in new tab)" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon displayed alongside the anchor link" } }, "required": [ "name", "href" ], "additionalProperties": false }, "description": "External links displayed at the top of the sidebar on all pages" }, "navigation": { "$ref": "#/definitions/navigationSchema" }, "footer": { "type": "object", "properties": { "socials": { "type": "object", "additionalProperties": { "type": "string", "format": "uri" }, "propertyNames": { "enum": [ "x", "website", "facebook", "youtube", "discord", "slack", "github", "linkedin", "instagram", "hacker-news", "medium", "telegram", "twitter", "x-twitter", "earth-americas", "bluesky", "threads", "reddit", "podcast" ] }, "description": "Social media links for your footer. Each key is a platform name (e.g., `x`, `github`, `linkedin`) and each value is your profile URL. Example: `{ \"x\": \"https://x.com/jamdeskHQ\" }`" }, "links": { "type": "array", "items": { "type": "object", "properties": { "header": { "type": "string", "minLength": 1, "description": "Column header title for footer link groups" }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "description": "Display text for the footer link" }, "href": { "$ref": "#/definitions/hrefSchema", "description": "Destination URL for the footer link" } }, "required": [ "label", "href" ], "additionalProperties": false }, "minItems": 1, "description": "List of links to display in this footer column" } }, "required": [ "items" ], "additionalProperties": false }, "minItems": 1, "maxItems": 4, "description": "Footer link columns with grouped navigation links" } }, "additionalProperties": false, "description": "Configure footer social media links and navigation columns" }, "search": { "type": "object", "properties": { "prompt": { "type": "string", "description": "Placeholder text displayed in the search input field" }, "popularPages": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "description": "Display title for the popular page link" }, "slug": { "type": "string", "minLength": 1, "description": "Page path (without .mdx extension)" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon displayed alongside the page link" } }, "required": [ "title", "slug" ], "additionalProperties": false }, "description": "Pages displayed in the search empty state as quick-access links" } }, "additionalProperties": false, "description": "Customize the search bar appearance and behavior" }, "seo": { "type": "object", "properties": { "metatags": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "description": "Custom meta tags applied to all pages. Each key-value pair becomes a meta tag in the page head" }, "indexing": { "type": "string", "enum": [ "navigable", "all" ], "description": "Control which pages are indexed by search engines. `navigable` indexes only pages in your navigation structure, `all` indexes every page. Defaults to `navigable`" }, "indexHiddenPages": { "type": "boolean", "description": "Include hidden pages in the sitemap for search engine indexing. Defaults to `false`" } }, "additionalProperties": false, "description": "Configure search engine optimization and page indexing settings" }, "fonts": { "anyOf": [ { "type": "object", "properties": { "family": { "type": "string", "description": "Font family name for your typography. Examples: \"Open Sans\", \"Playfair Display\", \"Inter\"" }, "weight": { "type": "number", "description": "Font weight value (e.g., 400, 700). Variable fonts support precise weights like 550" }, "source": { "type": "string", "minLength": 1, "description": "Font file path or URL. Accepts local paths (e.g., `/fonts/custom.woff2`) or remote URLs (e.g., `https://example.com/fonts/custom.woff2`)" }, "format": { "type": "string", "enum": [ "woff", "woff2" ], "description": "Font file format. Supported formats: `woff` or `woff2`" } }, "required": [ "family" ], "additionalProperties": false }, { "type": "object", "properties": { "heading": { "$ref": "#/anyOf/0/properties/fonts/anyOf/0" }, "body": { "$ref": "#/anyOf/0/properties/fonts/anyOf/0" } }, "additionalProperties": false }, { "type": "object", "properties": { "primary": { "type": "string", "description": "Primary font family name. Example: \"Open Sans\"" }, "mono": { "type": "string", "description": "Monospace font family name. Example: \"Fira Code\"" } }, "additionalProperties": false, "description": "Legacy font configuration. Use the family or heading/body format for more control" } ], "description": "Configure custom fonts for your documentation site" }, "icons": { "type": "object", "properties": { "library": { "type": "string", "enum": [ "fontawesome", "lucide" ], "description": "Icon library for your site. Options: `fontawesome` or `lucide`. Defaults to `fontawesome`" } }, "required": [ "library" ], "additionalProperties": false, "description": "Choose which icon library to use throughout your documentation" }, "styling": { "type": "object", "properties": { "eyebrows": { "type": "string", "enum": [ "section", "breadcrumbs" ], "description": "Content eyebrow style. Options: `section` (section-based) or `breadcrumbs` (breadcrumb navigation). Defaults to `section`" }, "codeblocks": { "anyOf": [ { "anyOf": [ { "not": {} }, { "type": "string", "enum": [ "system", "dark" ] } ] }, { "type": "object", "properties": { "theme": { "anyOf": [ { "type": "string", "enum": [ "andromeeda", "aurora-x", "ayu-dark", "ayu-light", "ayu-mirage", "catppuccin-frappe", "catppuccin-latte", "catppuccin-macchiato", "catppuccin-mocha", "css-variables", "dark-plus", "dracula", "dracula-soft", "everforest-dark", "everforest-light", "github-dark", "github-dark-default", "github-dark-dimmed", "github-dark-high-contrast", "github-light", "github-light-default", "github-light-high-contrast", "gruvbox-dark-hard", "gruvbox-dark-medium", "gruvbox-dark-soft", "gruvbox-light-hard", "gruvbox-light-medium", "gruvbox-light-soft", "horizon", "horizon-bright", "houston", "kanagawa-dragon", "kanagawa-lotus", "kanagawa-wave", "laserwave", "light-plus", "material-theme", "material-theme-darker", "material-theme-lighter", "material-theme-ocean", "material-theme-palenight", "min-dark", "min-light", "monokai", "night-owl", "night-owl-light", "nord", "one-dark-pro", "one-light", "plastic", "poimandres", "red", "rose-pine", "rose-pine-dawn", "rose-pine-moon", "slack-dark", "slack-ochin", "snazzy-light", "solarized-dark", "solarized-light", "synthwave-84", "tokyo-night", "vesper", "vitesse-black", "vitesse-dark", "vitesse-light" ] }, { "type": "object", "properties": { "light": { "type": "string", "enum": [ "andromeeda", "aurora-x", "ayu-dark", "ayu-light", "ayu-mirage", "catppuccin-frappe", "catppuccin-latte", "catppuccin-macchiato", "catppuccin-mocha", "css-variables", "dark-plus", "dracula", "dracula-soft", "everforest-dark", "everforest-light", "github-dark", "github-dark-default", "github-dark-dimmed", "github-dark-high-contrast", "github-light", "github-light-default", "github-light-high-contrast", "gruvbox-dark-hard", "gruvbox-dark-medium", "gruvbox-dark-soft", "gruvbox-light-hard", "gruvbox-light-medium", "gruvbox-light-soft", "horizon", "horizon-bright", "houston", "kanagawa-dragon", "kanagawa-lotus", "kanagawa-wave", "laserwave", "light-plus", "material-theme", "material-theme-darker", "material-theme-lighter", "material-theme-ocean", "material-theme-palenight", "min-dark", "min-light", "monokai", "night-owl", "night-owl-light", "nord", "one-dark-pro", "one-light", "plastic", "poimandres", "red", "rose-pine", "rose-pine-dawn", "rose-pine-moon", "slack-dark", "slack-ochin", "snazzy-light", "solarized-dark", "solarized-light", "synthwave-84", "tokyo-night", "vesper", "vitesse-black", "vitesse-dark", "vitesse-light" ] }, "dark": { "type": "string", "enum": [ "andromeeda", "aurora-x", "ayu-dark", "ayu-light", "ayu-mirage", "catppuccin-frappe", "catppuccin-latte", "catppuccin-macchiato", "catppuccin-mocha", "css-variables", "dark-plus", "dracula", "dracula-soft", "everforest-dark", "everforest-light", "github-dark", "github-dark-default", "github-dark-dimmed", "github-dark-high-contrast", "github-light", "github-light-default", "github-light-high-contrast", "gruvbox-dark-hard", "gruvbox-dark-medium", "gruvbox-dark-soft", "gruvbox-light-hard", "gruvbox-light-medium", "gruvbox-light-soft", "horizon", "horizon-bright", "houston", "kanagawa-dragon", "kanagawa-lotus", "kanagawa-wave", "laserwave", "light-plus", "material-theme", "material-theme-darker", "material-theme-lighter", "material-theme-ocean", "material-theme-palenight", "min-dark", "min-light", "monokai", "night-owl", "night-owl-light", "nord", "one-dark-pro", "one-light", "plastic", "poimandres", "red", "rose-pine", "rose-pine-dawn", "rose-pine-moon", "slack-dark", "slack-ochin", "snazzy-light", "solarized-dark", "solarized-light", "synthwave-84", "tokyo-night", "vesper", "vitesse-black", "vitesse-dark", "vitesse-light" ] } }, "required": [ "light", "dark" ], "additionalProperties": false } ] }, "languages": { "type": "object", "properties": { "custom": { "type": "array", "items": { "type": "string", "description": "Path to a JSON file defining a custom Shiki language syntax highlighting configuration" } } }, "additionalProperties": false, "description": "Add custom programming languages for code block syntax highlighting" } }, "additionalProperties": false } ], "description": "Configure code block syntax highlighting themes. Defaults to `system`. Use `theme` for a single theme name, or `themes` with `light` and `dark` keys for theme-specific styling" }, "latex": { "type": "boolean", "description": "Force LaTeX math rendering. When enabled, overrides automatic LaTeX detection" }, "typography": { "type": "boolean", "description": "Enable typography enhancements: smart quotes (\u201ccurly\u201d), en-dashes (\u2013), em-dashes (\u2014), and ellipses (\u2026). Defaults to `false`" }, "js": { "anyOf": [ { "type": "string", "pattern": "^/", "description": "Path to a custom JavaScript file relative to your docs directory (e.g., \"/script.js\")" }, { "type": "array", "items": { "type": "string", "pattern": "^/" }, "description": "Array of custom JavaScript file paths to include on every page" } ], "description": "Custom JavaScript to include on every page. Specify a file path or array of paths relative to your docs directory" } }, "additionalProperties": false, "description": "Customize content styling, code blocks, and visual presentation" }, "redirects": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "destination": { "type": "string" }, "permanent": { "type": "boolean" } }, "required": [ "source", "destination" ], "additionalProperties": false }, "description": "URL redirect rules for your documentation site. Each redirect maps a source path to a destination URL" }, "integrations": { "type": "object", "properties": { "amplitude": { "type": "object", "properties": { "apiKey": { "type": "string" } }, "required": [ "apiKey" ], "additionalProperties": false }, "clarity": { "type": "object", "properties": { "projectId": { "type": "string" } }, "required": [ "projectId" ], "additionalProperties": false }, "clearbit": { "type": "object", "properties": { "publicApiKey": { "type": "string" } }, "required": [ "publicApiKey" ], "additionalProperties": false }, "fathom": { "type": "object", "properties": { "siteId": { "type": "string" } }, "required": [ "siteId" ], "additionalProperties": false }, "frontchat": { "type": "object", "properties": { "snippetId": { "type": "string", "minLength": 6 } }, "required": [ "snippetId" ], "additionalProperties": false }, "ga4": { "type": "object", "description": "Google Analytics 4 integration", "properties": { "measurementId": { "type": "string", "pattern": "^G-[A-Z0-9]+$", "description": "GA4 Measurement ID (e.g., G-ABC123XYZ)" } }, "required": [ "measurementId" ], "additionalProperties": false }, "gtm": { "type": "object", "description": "Google Tag Manager integration. Include empty object {} to indicate placeholder.", "properties": { "tagId": { "type": "string", "pattern": "^GTM-[A-Z0-9]+$", "description": "GTM Container ID (e.g., GTM-ABCD123)" } }, "additionalProperties": false }, "heap": { "type": "object", "properties": { "appId": { "type": "string" } }, "required": [ "appId" ], "additionalProperties": false }, "hightouch": { "type": "object", "properties": { "writeKey": { "type": "string" }, "apiHost": { "type": "string" } }, "required": [ "writeKey" ], "additionalProperties": false }, "hotjar": { "type": "object", "properties": { "hjid": { "type": "string" }, "hjsv": { "type": "string" } }, "required": [ "hjid", "hjsv" ], "additionalProperties": false }, "crisp": { "type": "object", "properties": { "websiteId": { "type": "string", "minLength": 8 } }, "required": [ "websiteId" ], "additionalProperties": false }, "intercom": { "type": "object", "properties": { "appId": { "type": "string", "minLength": 6 } }, "required": [ "appId" ], "additionalProperties": false }, "koala": { "type": "object", "properties": { "publicApiKey": { "type": "string", "minLength": 2 } }, "required": [ "publicApiKey" ], "additionalProperties": false }, "logrocket": { "type": "object", "properties": { "appId": { "type": "string" } }, "required": [ "appId" ], "additionalProperties": false }, "mixpanel": { "type": "object", "properties": { "projectToken": { "type": "string" } }, "required": [ "projectToken" ], "additionalProperties": false }, "osano": { "type": "object", "properties": { "scriptSource": { "type": "string", "allOf": [ { "pattern": "^https://cmp\\.osano\\.com/" }, { "pattern": "/osano\\.js$" } ] } }, "required": [ "scriptSource" ], "additionalProperties": false }, "pirsch": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "posthog": { "type": "object", "properties": { "apiKey": { "type": "string", "pattern": "^phc_" }, "apiHost": { "type": "string", "format": "uri" } }, "required": [ "apiKey" ], "additionalProperties": false }, "plausible": { "type": "object", "description": "Plausible Analytics. Use domain for standard setup (free/paid). Use scriptUrl for paid proxy scripts that bypass ad blockers (pa-XXXXX.js URLs from Plausible dashboard). Only set one.", "properties": { "domain": { "type": "string", "description": "Standard setup: your site domain registered in Plausible (e.g., docs.example.com). Used as the data-domain attribute." }, "server": { "type": "string", "format": "uri", "description": "Self-hosted only: URL of your Plausible server. Only used with domain, not scriptUrl." }, "scriptUrl": { "type": "string", "format": "uri", "description": "Proxy setup: full URL to your Plausible paid proxy script (e.g., https://plausible.io/js/pa-XXXXX.js). Site identity is embedded in the script \u2014 no domain needed." } }, "anyOf": [ { "required": [ "domain" ] }, { "required": [ "scriptUrl" ] } ], "additionalProperties": false }, "segment": { "type": "object", "properties": { "key": { "type": "string" } }, "required": [ "key" ], "additionalProperties": false }, "telemetry": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "cookies": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "description": "Configure third-party integrations and analytics tools" }, "banner": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "description": "Banner text content. Supports basic MDX formatting (links, bold, italic). Custom MDX components are not supported" }, "dismissible": { "type": "boolean", "description": "Show a dismiss button allowing users to close the banner. When `true`, displays a close button on the right side" } }, "required": [ "content" ], "additionalProperties": false }, "errors": { "type": "object", "properties": { "404": { "type": "object", "properties": { "redirect": { "type": "boolean", "default": true, "description": "Automatically redirect users to the homepage when a 404 error occurs. Defaults to `true`" }, "title": { "type": "string", "description": "Page title displayed on the 404 error page" }, "description": { "type": "string", "description": "Error page description text. Supports basic MDX formatting (links, bold, italic). Custom MDX components are not supported" } }, "additionalProperties": false } }, "additionalProperties": false, "description": "Customize 404 error page content and redirect behavior" }, "contextual": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable or disable the AI Actions menu. Default: true" }, "options": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "copy", "view", "chatgpt", "claude", "gemini", "perplexity", "mcp", "cursor", "vscode" ] }, { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "href": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "base": { "type": "string" }, "query": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "additionalProperties": false } } }, "required": [ "base" ], "additionalProperties": false } ] } }, "required": [ "title", "description", "href" ], "additionalProperties": false, "description": "Define a custom contextual menu option with title, description, icon, and destination" } ] }, "description": "Contextual menu options available on documentation pages" } }, "additionalProperties": false, "description": "Configure contextual menu options for page actions (copy, view source, AI chat, etc.)" }, "thumbnails": { "type": "object", "properties": { "appearance": { "type": "string", "enum": [ "light", "dark" ], "description": "Thumbnail appearance style. Options: `light` or `dark`. If omitted, appearance is auto-generated from your color scheme" }, "background": { "type": "string", "description": "Background image URL for social media thumbnails. Accepts absolute URLs or relative paths" }, "fonts": { "type": "object", "properties": { "family": { "type": "string", "description": "Font family name for your typography. Examples: \"Open Sans\", \"Playfair Display\", \"Inter\"" } }, "required": [ "family" ], "additionalProperties": false, "description": "Font family for thumbnail text. For Google Fonts, specify only the family name" } }, "additionalProperties": false }, "interaction": { "type": "object", "properties": { "drilldown": { "type": "boolean", "description": "Auto-navigate to the first page when a navigation group is expanded. When enabled, clicking a group automatically opens its first page" } }, "additionalProperties": false, "description": "Configure user interaction behavior with navigation and links" }, "metadata": { "type": "object", "properties": { "timestamp": { "type": "boolean", "default": false, "description": "Display the last modified date on all documentation pages. When `true`, shows when each page was last updated. Defaults to `false`" } }, "additionalProperties": false, "description": "Configure page metadata display settings" }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable AI-powered chat assistant (default: true). Set to false to disable.", "default": true }, "starterQuestions": { "type": "array", "items": { "type": "string", "minLength": 5, "maxLength": 200 }, "maxItems": 4, "description": "Suggested questions shown in chat empty state. Auto-generated by AI during builds when omitted. Set to [] to disable." } }, "additionalProperties": false }, "analytics": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable Jamdesk built-in analytics tracking. Defaults to true. Set to false to disable", "default": true } }, "additionalProperties": false, "description": "Configure Jamdesk analytics behavior" }, "modeToggle": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "dark", "light" ], "description": "Default theme mode" }, "isHidden": { "type": "boolean", "description": "Hide the theme toggle switch" } }, "additionalProperties": false, "description": "Deprecated: Use \"appearance\" instead. Maps to appearance.default and appearance.strict" }, "layout": { "type": "string", "enum": [ "sidenav", "topnav" ], "description": "Deprecated: Ignored by Jamdesk. Theme determines layout automatically" }, "spellcheck": { "type": "object", "properties": { "ignore": { "type": "array", "items": { "type": "string" }, "description": "Words to ignore during spellcheck (product names, technical terms, etc.)" } }, "additionalProperties": false, "description": "Configuration for the jamdesk spellcheck command" }, "images": { "type": "object", "description": "Image optimization settings for documentation builds", "properties": { "convertToWebp": { "type": "boolean", "description": "Automatically convert PNG and JPG images to WebP format during builds. Reduces image sizes by 60-80% for faster page loads. SVG and GIF files are not converted. Default: false" } }, "additionalProperties": false } }, "required": [ "theme", "name", "colors", "navigation" ], "additionalProperties": false }, { "type": "object", "properties": { "theme": { "type": "string", "const": "nebula" }, "$schema": { "$ref": "#/anyOf/0/properties/$schema" }, "projectId": { "$ref": "#/anyOf/0/properties/projectId" }, "name": { "$ref": "#/anyOf/0/properties/name" }, "description": { "$ref": "#/anyOf/0/properties/description" }, "colors": { "$ref": "#/definitions/colorsSchema" }, "logo": { "$ref": "#/anyOf/0/properties/logo" }, "favicon": { "$ref": "#/anyOf/0/properties/favicon" }, "api": { "$ref": "#/anyOf/0/properties/api" }, "appearance": { "$ref": "#/anyOf/0/properties/appearance" }, "background": { "$ref": "#/anyOf/0/properties/background" }, "navbar": { "$ref": "#/anyOf/0/properties/navbar" }, "tabsPosition": { "$ref": "#/anyOf/0/properties/tabsPosition" }, "anchors": { "$ref": "#/anyOf/0/properties/anchors" }, "navigation": { "$ref": "#/definitions/navigationSchema" }, "footer": { "$ref": "#/anyOf/0/properties/footer" }, "search": { "$ref": "#/anyOf/0/properties/search" }, "seo": { "$ref": "#/anyOf/0/properties/seo" }, "fonts": { "$ref": "#/anyOf/0/properties/fonts" }, "icons": { "$ref": "#/anyOf/0/properties/icons" }, "styling": { "$ref": "#/anyOf/0/properties/styling" }, "redirects": { "$ref": "#/anyOf/0/properties/redirects", "description": "URL redirect rules for your documentation site. Each redirect maps a source path to a destination URL" }, "integrations": { "$ref": "#/anyOf/0/properties/integrations" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "errors": { "$ref": "#/anyOf/0/properties/errors" }, "contextual": { "$ref": "#/anyOf/0/properties/contextual" }, "thumbnails": { "$ref": "#/anyOf/0/properties/thumbnails" }, "interaction": { "$ref": "#/anyOf/0/properties/interaction" }, "metadata": { "$ref": "#/anyOf/0/properties/metadata" }, "chat": { "$ref": "#/anyOf/0/properties/chat" }, "analytics": { "$ref": "#/anyOf/0/properties/analytics" }, "modeToggle": { "$ref": "#/anyOf/0/properties/modeToggle" }, "layout": { "$ref": "#/anyOf/0/properties/layout" }, "spellcheck": { "$ref": "#/anyOf/0/properties/spellcheck" }, "images": { "$ref": "#/anyOf/0/properties/images" } }, "required": [ "theme", "name", "colors", "navigation" ], "additionalProperties": false }, { "type": "object", "properties": { "theme": { "type": "string", "const": "pulsar" }, "$schema": { "$ref": "#/anyOf/0/properties/$schema" }, "projectId": { "$ref": "#/anyOf/0/properties/projectId" }, "name": { "$ref": "#/anyOf/0/properties/name" }, "description": { "$ref": "#/anyOf/0/properties/description" }, "colors": { "$ref": "#/definitions/colorsSchema" }, "logo": { "$ref": "#/anyOf/0/properties/logo" }, "favicon": { "$ref": "#/anyOf/0/properties/favicon" }, "api": { "$ref": "#/anyOf/0/properties/api" }, "appearance": { "$ref": "#/anyOf/0/properties/appearance" }, "background": { "$ref": "#/anyOf/0/properties/background" }, "navbar": { "$ref": "#/anyOf/0/properties/navbar" }, "tabsPosition": { "$ref": "#/anyOf/0/properties/tabsPosition" }, "anchors": { "$ref": "#/anyOf/0/properties/anchors" }, "navigation": { "$ref": "#/definitions/navigationSchema" }, "footer": { "$ref": "#/anyOf/0/properties/footer" }, "search": { "$ref": "#/anyOf/0/properties/search" }, "seo": { "$ref": "#/anyOf/0/properties/seo" }, "fonts": { "$ref": "#/anyOf/0/properties/fonts" }, "icons": { "$ref": "#/anyOf/0/properties/icons" }, "styling": { "$ref": "#/anyOf/0/properties/styling" }, "redirects": { "$ref": "#/anyOf/0/properties/redirects", "description": "URL redirect rules for your documentation site. Each redirect maps a source path to a destination URL" }, "integrations": { "$ref": "#/anyOf/0/properties/integrations" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "errors": { "$ref": "#/anyOf/0/properties/errors" }, "contextual": { "$ref": "#/anyOf/0/properties/contextual" }, "thumbnails": { "$ref": "#/anyOf/0/properties/thumbnails" }, "interaction": { "$ref": "#/anyOf/0/properties/interaction" }, "metadata": { "$ref": "#/anyOf/0/properties/metadata" }, "chat": { "$ref": "#/anyOf/0/properties/chat" }, "analytics": { "$ref": "#/anyOf/0/properties/analytics" }, "modeToggle": { "$ref": "#/anyOf/0/properties/modeToggle" }, "layout": { "$ref": "#/anyOf/0/properties/layout" }, "spellcheck": { "$ref": "#/anyOf/0/properties/spellcheck" }, "images": { "$ref": "#/anyOf/0/properties/images" } }, "required": [ "theme", "name", "colors", "navigation" ], "additionalProperties": false } ], "definitions": { "anchorSchema": { "anyOf": [ { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema", "description": "Anchor name for navigation grouping and organization" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema", "description": "Destination URL. Accepts relative paths (e.g., `/docs/intro`) or absolute URLs (e.g., `https://example.com`)" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema", "description": "Add global navigation links that appear on all pages regardless of navigation structure" } }, "required": [ "anchor", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "languages": { "$ref": "#/definitions/languagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "languages" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "versions": { "$ref": "#/definitions/versionsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "dropdowns": { "$ref": "#/definitions/dropdownsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "dropdowns" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "tabs": { "$ref": "#/definitions/tabsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "tabs" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "products": { "$ref": "#/definitions/productsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "products" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "anchor" ], "additionalProperties": false } ] }, "anchorsSchema": { "type": "array", "items": { "$ref": "#/definitions/anchorSchema" }, "minItems": 1, "description": "Navigation structure organized using anchor-based grouping" }, "colorsSchema": { "type": "object", "properties": { "primary": { "type": "string", "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$", "description": "Primary brand color for your Jamdesk site (hex format, e.g., `#ff0000` or `#f00`)" }, "light": { "type": "string", "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$", "description": "Light theme color used when dark mode is active (hex format, e.g., `#ffffff` or `#fff`)" }, "dark": { "$ref": "#/definitions/colorsSchema/properties/light", "description": "Dark theme color used when light mode is active (hex format, e.g., `#000000` or `#000`)" } }, "required": [ "primary" ], "additionalProperties": false, "description": "Configure your site's color scheme. At minimum, define the primary color. Example: `{ \"colors\": { \"primary\": \"#ff0000\" } }`" }, "dropdownSchema": { "anyOf": [ { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "href": { "$ref": "#/definitions/hrefSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "languages": { "$ref": "#/definitions/languagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "languages" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "versions": { "$ref": "#/definitions/versionsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "tabs": { "$ref": "#/definitions/tabsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "tabs" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "anchors": { "$ref": "#/definitions/anchorsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "anchors" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "products": { "$ref": "#/definitions/productsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "products" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "dropdown": { "$ref": "#/definitions/global_dropdowns_dropdown_Schema" }, "icon": { "$ref": "#/definitions/global_dropdowns_icon_Schema" }, "color": { "$ref": "#/definitions/global_dropdowns_color_Schema" }, "description": { "$ref": "#/definitions/global_dropdowns_description_Schema" }, "hidden": { "$ref": "#/definitions/global_dropdowns_hidden_Schema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "dropdown" ], "additionalProperties": false } ] }, "dropdownsSchema": { "type": "array", "items": { "$ref": "#/definitions/dropdownSchema" }, "description": "Navigation structure organized using dropdown menus" }, "menuItemSchema": { "anyOf": [ { "type": "object", "properties": { "item": { "type": "string", "minLength": 1, "description": "Menu item name displayed in navigation" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "description": { "type": "string", "description": "Optional description text for the menu item" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "item", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "item": { "$ref": "#/definitions/menuItemNameSchema" }, "icon": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/icon" }, "description": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/description" }, "hidden": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/hidden" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "item", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "item": { "$ref": "#/definitions/menuItemNameSchema" }, "icon": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/icon" }, "description": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/description" }, "hidden": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/hidden" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "item", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "item": { "$ref": "#/definitions/menuItemNameSchema" }, "icon": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/icon" }, "description": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/description" }, "hidden": { "$ref": "#/definitions/menuItemSchema/anyOf/0/properties/hidden" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "item" ], "additionalProperties": false } ] }, "menuSchema": { "type": "array", "items": { "$ref": "#/definitions/menuItemSchema" }, "description": "Navigation structure organized using menu items" }, "productSchema": { "anyOf": [ { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "href": { "$ref": "#/definitions/hrefSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "languages": { "$ref": "#/definitions/languagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "languages" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "versions": { "$ref": "#/definitions/versionsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "tabs": { "$ref": "#/definitions/tabsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "tabs" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "anchors": { "$ref": "#/definitions/anchorsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "anchors" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "dropdowns": { "$ref": "#/definitions/dropdownsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "dropdowns" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "product": { "$ref": "#/definitions/global_products_product_Schema" }, "name": { "$ref": "#/definitions/global_products_name_Schema" }, "icon": { "$ref": "#/definitions/global_products_icon_Schema" }, "color": { "$ref": "#/definitions/global_products_color_Schema" }, "description": { "$ref": "#/definitions/global_products_description_Schema" }, "hidden": { "$ref": "#/definitions/global_products_hidden_Schema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "product" ], "additionalProperties": false } ] }, "productsSchema": { "type": "array", "items": { "$ref": "#/definitions/productSchema" }, "description": "Navigation structure organized by product categories" }, "groupsSchema": { "type": "array", "items": { "$ref": "#/definitions/groupSchema" }, "minItems": 1, "description": "Organizing by groups" }, "hiddenSchema": { "type": "boolean", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "iconSchema": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "style": { "type": "string", "enum": [ "brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin" ] }, "name": { "$ref": "#/definitions/iconNameSchema" }, "library": { "type": "string", "enum": [ "fontawesome", "lucide" ] } }, "required": [ "name" ], "additionalProperties": false } ], "description": "Icon to display alongside this navigation item" }, "languageSchema": { "anyOf": [ { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "href": { "$ref": "#/definitions/hrefSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "versions": { "$ref": "#/definitions/versionsSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "tabs": { "$ref": "#/definitions/tabsSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "tabs" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "dropdowns": { "$ref": "#/definitions/dropdownsSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "dropdowns" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "anchors": { "$ref": "#/definitions/anchorsSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "anchors" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "products": { "$ref": "#/definitions/productsSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "products" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "language": { "$ref": "#/definitions/global_languages_language_Schema" }, "default": { "$ref": "#/definitions/global_languages_default_Schema" }, "hidden": { "$ref": "#/definitions/global_languages_hidden_Schema" }, "banner": { "$ref": "#/anyOf/0/properties/banner" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "language" ], "additionalProperties": false } ], "description": "Navigation structure organized by language/localization" }, "languagesSchema": { "type": "array", "items": { "$ref": "#/definitions/languageSchema" }, "minItems": 1, "description": "Navigation structure organized by language/localization" }, "navigationSchema": { "anyOf": [ { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema", "description": "Add global navigation links that appear on all pages regardless of navigation structure" }, "products": { "$ref": "#/definitions/productsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "products" ], "additionalProperties": false }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema" }, "languages": { "$ref": "#/definitions/languagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "languages" ], "additionalProperties": false }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema" }, "versions": { "$ref": "#/definitions/versionsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema" }, "tabs": { "$ref": "#/definitions/tabsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "tabs" ], "additionalProperties": false }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema" }, "dropdowns": { "$ref": "#/definitions/dropdownsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "dropdowns" ], "additionalProperties": false }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/globalSchema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" } }, "required": [ "pages" ], "additionalProperties": false } ], "description": "Define your documentation site's navigation structure and organization" }, "openApiSchema": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "$ref": "#/definitions/openApiStringSchema" } }, { "type": "object", "properties": { "source": { "$ref": "#/definitions/openApiStringSchema" }, "directory": { "type": "string" } }, "required": [ "source" ], "additionalProperties": false } ], "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "pageOrGroupSchema": { "anyOf": [ { "$ref": "#/definitions/group_root_Schema" }, { "type": "object", "properties": { "page": { "type": "string", "minLength": 1, "description": "File path to the documentation page (without .mdx extension). Example: `guides/quickstart`" }, "title": { "type": "string", "description": "Custom sidebar title. Overrides the auto-generated title from the file path" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside the page title in navigation" }, "tag": { "type": "string", "description": "Small badge displayed next to the page title (e.g., \"New\", \"Beta\")" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "description": "HTTP method for API endpoint pages. Displays a colored method badge in the sidebar" } }, "required": [ "page" ], "additionalProperties": false, "description": "Page with custom title, icon, tag, or API method" }, { "$ref": "#/definitions/groupsSchema/items" } ] }, "pagesSchema": { "type": "array", "items": { "$ref": "#/definitions/pageOrGroupSchema" }, "description": "Array of page paths, page objects, or nested navigation groups", "default": [] }, "tabSchema": { "anyOf": [ { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "href": { "$ref": "#/definitions/hrefSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "languages": { "$ref": "#/definitions/languagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "languages" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "versions": { "$ref": "#/definitions/versionsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "dropdowns": { "$ref": "#/definitions/dropdownsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "dropdowns" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "anchors": { "$ref": "#/definitions/anchorsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "anchors" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "products": { "$ref": "#/definitions/productsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "products" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "menu": { "$ref": "#/definitions/menuSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab", "menu" ], "additionalProperties": false }, { "type": "object", "properties": { "tab": { "$ref": "#/definitions/global_tabs_tab_Schema" }, "icon": { "$ref": "#/definitions/global_tabs_icon_Schema" }, "hidden": { "$ref": "#/definitions/global_tabs_hidden_Schema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "tab" ], "additionalProperties": false } ] }, "tabsSchema": { "type": "array", "items": { "$ref": "#/definitions/tabSchema" }, "minItems": 1, "description": "Navigation structure organized using tabbed sections" }, "versionSchema": { "anyOf": [ { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "href": { "$ref": "#/definitions/hrefSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "languages": { "$ref": "#/definitions/languagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "languages" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "tabs": { "$ref": "#/definitions/tabsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "tabs" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "dropdowns": { "$ref": "#/definitions/dropdownsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "dropdowns" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "anchors": { "$ref": "#/definitions/anchorsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "anchors" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "products": { "$ref": "#/definitions/productsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "products" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "groups": { "$ref": "#/definitions/groupsSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "groups" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "pages": { "$ref": "#/definitions/pagesSchema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version", "pages" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "$ref": "#/definitions/global_versions_version_Schema" }, "default": { "$ref": "#/definitions/global_versions_default_Schema" }, "hidden": { "$ref": "#/definitions/global_versions_hidden_Schema" }, "openapi": { "$ref": "#/definitions/openApiSchema", "description": "URL(s) to your OpenAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema", "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "global": { "$ref": "#/definitions/globalSchema" } }, "required": [ "version" ], "additionalProperties": false } ] }, "versionsSchema": { "type": "array", "items": { "$ref": "#/definitions/versionSchema" }, "minItems": 1, "description": "Navigation structure organized by documentation versions" }, "hrefSchema": { "type": "string", "description": "Destination URL. Accepts relative paths (e.g., `/docs/intro`) or absolute URLs (e.g., `https://example.com`)" }, "colorPairSchema": { "type": "object", "properties": { "light": { "type": "string", "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$", "description": "Hex color code for light theme appearance (e.g., `#ffffff` or `#fff`)" }, "dark": { "type": "string", "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$", "description": "Hex color code for dark theme appearance (e.g., `#000000` or `#000`)" } }, "additionalProperties": false }, "asyncApiSchema": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "$ref": "#/definitions/asyncApiStringSchema" } }, { "type": "object", "properties": { "source": { "$ref": "#/definitions/asyncApiStringSchema" }, "directory": { "type": "string" } }, "required": [ "source" ], "additionalProperties": false } ], "description": "URL(s) to your AsyncAPI specification file(s). Accepts a single URL string or an array of URLs (absolute or relative paths)" }, "globalSchema": { "type": "object", "properties": { "languages": { "type": "array", "items": { "type": "object", "properties": { "language": { "type": "string", "enum": [ "en", "cn", "zh", "zh-Hans", "zh-Hant", "es", "fr", "fr-CA", "fr-ca", "ja", "jp", "ja-jp", "pt", "pt-BR", "de", "ko", "it", "ru", "ro", "cs", "id", "ar", "tr", "hi", "sv", "no", "lv", "nl", "uk", "vi", "pl", "uz", "he" ], "description": "Language code in ISO 639-1 format (e.g., `en`, `es`, `fr`, `zh`)" }, "default": { "type": "boolean", "description": "Set this language as the default for your documentation site" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "language", "href" ], "additionalProperties": false } }, "versions": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "description": "Version identifier for your documentation (e.g., `v1.0`, `latest`, `stable`)" }, "default": { "type": "boolean", "description": "Set this version as the default version shown to users" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "version", "href" ], "additionalProperties": false } }, "tabs": { "type": "array", "items": { "type": "object", "properties": { "tab": { "type": "string", "minLength": 1, "description": "Tab name for organizing content into separate sections" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "tab", "href" ], "additionalProperties": false } }, "dropdowns": { "type": "array", "items": { "type": "object", "properties": { "dropdown": { "type": "string", "minLength": 1, "description": "Dropdown menu name for grouping related navigation items" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "description": { "type": "string", "description": "Optional description text for the dropdown menu" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "dropdown", "href" ], "additionalProperties": false } }, "anchors": { "type": "array", "items": { "type": "object", "properties": { "anchor": { "$ref": "#/definitions/anchorNameSchema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "anchor", "href" ], "additionalProperties": false } }, "products": { "type": "array", "items": { "type": "object", "properties": { "product": { "type": "string", "minLength": 1, "description": "Product identifier for multi-product documentation sites" }, "name": { "type": "string", "description": "Human-readable display name for the product" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "color": { "$ref": "#/definitions/colorPairSchema" }, "description": { "type": "string", "description": "Product description text displayed in navigation" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "href": { "$ref": "#/definitions/hrefSchema" } }, "required": [ "product", "href" ], "additionalProperties": false } } }, "additionalProperties": false, "description": "Add global navigation links that appear on all pages regardless of navigation structure" }, "anchorNameSchema": { "type": "string", "minLength": 1, "description": "Anchor name for navigation grouping and organization" }, "iconNameSchema": { "type": "string" }, "openApiStringSchema": { "type": "string", "minLength": 1 }, "asyncApiStringSchema": { "type": "string", "minLength": 1 }, "group_group_Schema": { "type": "string", "minLength": 1, "description": "Navigation group name for organizing related pages" }, "group_public_Schema": { "type": "boolean", "description": "Make this navigation group publicly accessible. When `false`, group may require authentication" }, "group_root_Schema": { "type": "string", "minLength": 1, "description": "Root page path for this navigation group. Example: `docs/getting-started`" }, "group_tag_Schema": { "type": "string", "description": "Optional tag label for categorizing or filtering the navigation group" }, "group_expanded_Schema": { "type": "boolean", "description": "Expand this navigation group by default when the page loads. When `true`, group starts open" }, "menuItemNameSchema": { "type": "string", "minLength": 1, "description": "Menu item name displayed in navigation" }, "global_languages_language_Schema": { "type": "string", "enum": [ "en", "cn", "zh", "zh-Hans", "zh-Hant", "es", "fr", "fr-CA", "fr-ca", "ja", "jp", "ja-jp", "pt", "pt-BR", "de", "ko", "it", "ru", "ro", "cs", "id", "ar", "tr", "hi", "sv", "no", "lv", "nl", "uk", "vi", "pl", "uz", "he" ], "description": "Language code in ISO 639-1 format (e.g., `en`, `es`, `fr`, `zh`)" }, "global_languages_default_Schema": { "type": "boolean", "description": "Set this language as the default for your documentation site" }, "global_languages_hidden_Schema": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "global_versions_version_Schema": { "type": "string", "minLength": 1, "description": "Version identifier for your documentation (e.g., `v1.0`, `latest`, `stable`)" }, "global_versions_default_Schema": { "type": "boolean", "description": "Set this version as the default version shown to users" }, "global_versions_hidden_Schema": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "global_tabs_tab_Schema": { "type": "string", "minLength": 1, "description": "Tab name for organizing content into separate sections" }, "global_tabs_icon_Schema": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "global_tabs_hidden_Schema": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "global_dropdowns_dropdown_Schema": { "type": "string", "minLength": 1, "description": "Dropdown menu name for grouping related navigation items" }, "global_dropdowns_icon_Schema": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "global_dropdowns_color_Schema": { "$ref": "#/definitions/colorPairSchema" }, "global_dropdowns_description_Schema": { "type": "string", "description": "Optional description text for the dropdown menu" }, "global_dropdowns_hidden_Schema": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "global_products_product_Schema": { "type": "string", "minLength": 1, "description": "Product identifier for multi-product documentation sites" }, "global_products_name_Schema": { "type": "string", "description": "Human-readable display name for the product" }, "global_products_icon_Schema": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "global_products_color_Schema": { "$ref": "#/definitions/colorPairSchema" }, "global_products_description_Schema": { "type": "string", "description": "Product description text displayed in navigation" }, "global_products_hidden_Schema": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "groupSchema": { "anyOf": [ { "type": "object", "properties": { "group": { "type": "string", "minLength": 1, "description": "Navigation group name for organizing related pages" }, "public": { "type": "boolean", "description": "Make this navigation group publicly accessible. When `false`, group may require authentication" }, "icon": { "$ref": "#/definitions/iconSchema", "description": "Icon to display alongside this navigation item" }, "hidden": { "$ref": "#/definitions/hiddenSchema", "description": "Hide this navigation option by default. When `true`, the item is hidden but can be shown via user preferences" }, "root": { "type": "string", "minLength": 1, "description": "Root page path for this navigation group. Example: `docs/getting-started`" }, "tag": { "type": "string", "description": "Optional tag label for categorizing or filtering the navigation group" }, "expanded": { "type": "boolean", "description": "Expand this navigation group by default when the page loads. When `true`, group starts open" }, "openapi": { "$ref": "#/definitions/openApiSchema" }, "pages": { "$ref": "#/definitions/pagesSchema" } }, "required": [ "group", "openapi" ], "additionalProperties": false }, { "type": "object", "properties": { "group": { "$ref": "#/definitions/group_group_Schema" }, "public": { "$ref": "#/definitions/group_public_Schema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "root": { "$ref": "#/definitions/group_root_Schema" }, "tag": { "$ref": "#/definitions/group_tag_Schema" }, "expanded": { "$ref": "#/definitions/group_expanded_Schema" }, "asyncapi": { "$ref": "#/definitions/asyncApiSchema" }, "pages": { "$ref": "#/definitions/pagesSchema", "default": [] } }, "required": [ "group", "asyncapi" ], "additionalProperties": false }, { "type": "object", "properties": { "group": { "$ref": "#/definitions/group_group_Schema" }, "public": { "$ref": "#/definitions/group_public_Schema" }, "icon": { "$ref": "#/definitions/iconSchema" }, "hidden": { "$ref": "#/definitions/hiddenSchema" }, "root": { "$ref": "#/definitions/group_root_Schema" }, "tag": { "$ref": "#/definitions/group_tag_Schema" }, "expanded": { "$ref": "#/definitions/group_expanded_Schema" }, "pages": { "$ref": "#/definitions/pagesSchema", "default": [] } }, "required": [ "group" ], "additionalProperties": false } ], "description": "Navigation structure organized using page groups" } }, "$schema": "http://json-schema.org/draft-07/schema#" }