docs-yml.schema.json

{
  "type": "object",
  "properties": {
    "instances": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/docs.DocsInstance"
      }
    },
    "title": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "analytics": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.AnalyticsConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "announcement": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.AnnouncementConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "roles": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.RoleId"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "tabs": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/docs.TabConfig"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "versions": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.VersionConfig"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "landing-page": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.PageConfiguration"
        },
        {
          "type": "null"
        }
      ]
    },
    "navigation": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.NavigationConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "navbar-links": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.NavbarLink"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "footer-links": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.FooterLinksConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "experimental": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.ExperimentalConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "default-language": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.ProgrammingLanguage"
        },
        {
          "type": "null"
        }
      ]
    },
    "metadata": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.MetadataConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "redirects": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.RedirectConfig"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "logo": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.LogoConfiguration"
        },
        {
          "type": "null"
        }
      ]
    },
    "favicon": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "background-image": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.BackgroundImageConfiguration"
        },
        {
          "type": "null"
        }
      ]
    },
    "colors": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.ColorsConfiguration"
        },
        {
          "type": "null"
        }
      ]
    },
    "typography": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.DocsTypographyConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "layout": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.LayoutConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "integrations": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.IntegrationsConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "css": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.CssConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "js": {
      "oneOf": [
        {
          "$ref": "#/definitions/docs.JsConfig"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "instances"
  ],
  "additionalProperties": false,
  "definitions": {
    "docs.CustomDomain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "docs.GithubEditThisPageConfig": {
      "type": "object",
      "properties": {
        "host": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "owner": {
          "type": "string"
        },
        "repo": {
          "type": "string"
        },
        "branch": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "owner",
        "repo"
      ],
      "additionalProperties": false
    },
    "docs.EditThisPageConfig": {
      "type": "object",
      "properties": {
        "github": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.GithubEditThisPageConfig"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.DocsInstance": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "custom-domain": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.CustomDomain"
            },
            {
              "type": "null"
            }
          ]
        },
        "private": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "edit-this-page": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.EditThisPageConfig"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "url"
      ],
      "additionalProperties": false
    },
    "docs.SegmentConfig": {
      "type": "object",
      "properties": {
        "write-key": {
          "type": "string"
        }
      },
      "required": [
        "write-key"
      ],
      "additionalProperties": false
    },
    "docs.FullStoryAnalyticsConfig": {
      "type": "object",
      "properties": {
        "org-id": {
          "type": "string"
        }
      },
      "required": [
        "org-id"
      ],
      "additionalProperties": false
    },
    "docs.IntercomConfig": {
      "type": "object",
      "properties": {
        "app-id": {
          "type": "string"
        },
        "api-base": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "app-id"
      ],
      "additionalProperties": false
    },
    "docs.PostHogConfig": {
      "type": "object",
      "properties": {
        "api-key": {
          "type": "string"
        },
        "endpoint": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "api-key"
      ],
      "additionalProperties": false
    },
    "docs.AnalyticsConfig": {
      "type": "object",
      "properties": {
        "segment": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SegmentConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "fullstory": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FullStoryAnalyticsConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "intercom": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.IntercomConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "posthog": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.PostHogConfig"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.AnnouncementConfig": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "additionalProperties": false
    },
    "docs.RoleId": {
      "type": "string"
    },
    "docs.Role": {
      "anyOf": [
        {
          "$ref": "#/definitions/docs.RoleId"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.RoleId"
          }
        }
      ]
    },
    "docs.ChangelogFolderRelativePath": {
      "type": "string"
    },
    "docs.TabConfig": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "display-name": {
          "type": "string"
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "skip-slug": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "href": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "changelog": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ChangelogFolderRelativePath"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "display-name"
      ],
      "additionalProperties": false
    },
    "docs.VersionAvailability": {
      "type": "string",
      "enum": [
        "deprecated",
        "ga",
        "stable",
        "beta"
      ]
    },
    "docs.VersionConfig": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "display-name": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "availability": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.VersionAvailability"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "display-name",
        "path"
      ],
      "additionalProperties": false
    },
    "docs.PageConfiguration": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "page": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "page",
        "path"
      ],
      "additionalProperties": false
    },
    "docs.SectionConfiguration": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "section": {
          "type": "string"
        },
        "path": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "contents": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.NavigationItem"
          }
        },
        "collapsed": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "skip-slug": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "section",
        "contents"
      ],
      "additionalProperties": false
    },
    "docs.AudienceId": {
      "type": "string"
    },
    "docs.VersionedSnippetLanguageConfiguration": {
      "type": "object",
      "properties": {
        "version": {
          "type": "string"
        },
        "package": {
          "type": "string"
        }
      },
      "required": [
        "version",
        "package"
      ],
      "additionalProperties": false
    },
    "docs.SnippetLanguageConfiguration": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/definitions/docs.VersionedSnippetLanguageConfiguration"
        }
      ]
    },
    "docs.SnippetsConfiguration": {
      "type": "object",
      "properties": {
        "python": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SnippetLanguageConfiguration"
            },
            {
              "type": "null"
            }
          ]
        },
        "typescript": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SnippetLanguageConfiguration"
            },
            {
              "type": "null"
            }
          ]
        },
        "go": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SnippetLanguageConfiguration"
            },
            {
              "type": "null"
            }
          ]
        },
        "java": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SnippetLanguageConfiguration"
            },
            {
              "type": "null"
            }
          ]
        },
        "ruby": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SnippetLanguageConfiguration"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.PlaygroundButtonSettings": {
      "type": "object",
      "properties": {
        "href": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.PlaygroundSettings": {
      "type": "object",
      "properties": {
        "environments": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "button": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.PlaygroundButtonSettings"
            },
            {
              "type": "null"
            }
          ]
        },
        "oauth": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "limit-websocket-messages-per-connection": {
          "oneOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.ApiReferencePackageConfigurationWithOptions": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "title": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "summary": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "contents": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/docs.ApiReferenceLayoutItem"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "skip-slug": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "playground": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.PlaygroundSettings"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.ApiReferencePackageConfiguration": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.ApiReferenceLayoutItem"
          }
        },
        {
          "$ref": "#/definitions/docs.ApiReferencePackageConfigurationWithOptions"
        }
      ]
    },
    "docs.ApiReferenceSectionConfiguration": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "section": {
          "type": "string"
        },
        "referenced-packages": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "summary": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "contents": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/docs.ApiReferenceLayoutItem"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "skip-slug": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "playground": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.PlaygroundSettings"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "section"
      ],
      "additionalProperties": false
    },
    "docs.ApiReferenceEndpointConfiguration": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "endpoint": {
          "type": "string"
        },
        "title": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "playground": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.PlaygroundSettings"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "endpoint"
      ],
      "additionalProperties": false
    },
    "docs.LinkConfiguration": {
      "type": "object",
      "properties": {
        "link": {
          "type": "string"
        },
        "href": {
          "type": "string"
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "link",
        "href"
      ],
      "additionalProperties": false
    },
    "docs.ApiReferenceLayoutItem": {
      "anyOf": [
        {
          "type": "string",
          "description": "This should be either an endpoint, websocket, webhook, or subpackage ID"
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/docs.ApiReferencePackageConfiguration"
          },
          "description": "Keyed by subpackage name, this object allows you to group endpoints and pages together."
        },
        {
          "$ref": "#/definitions/docs.ApiReferenceSectionConfiguration"
        },
        {
          "$ref": "#/definitions/docs.ApiReferenceEndpointConfiguration"
        },
        {
          "$ref": "#/definitions/docs.PageConfiguration"
        },
        {
          "$ref": "#/definitions/docs.LinkConfiguration"
        }
      ]
    },
    "docs.ApiReferenceConfiguration": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "api": {
          "type": "string"
        },
        "api-name": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "audiences": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/docs.AudienceId"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "display-errors": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "snippets": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SnippetsConfiguration"
            },
            {
              "type": "null"
            }
          ]
        },
        "summary": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "layout": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/docs.ApiReferenceLayoutItem"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "skip-slug": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "alphabetized": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "flattened": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "paginated": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "playground": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.PlaygroundSettings"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "api"
      ],
      "additionalProperties": false
    },
    "docs.ChangelogConfiguration": {
      "type": "object",
      "properties": {
        "viewers": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.Role"
            },
            {
              "type": "null"
            }
          ]
        },
        "orphaned": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "changelog": {
          "$ref": "#/definitions/docs.ChangelogFolderRelativePath"
        },
        "title": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "slug": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "icon": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hidden": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "changelog"
      ],
      "additionalProperties": false
    },
    "docs.NavigationItem": {
      "anyOf": [
        {
          "$ref": "#/definitions/docs.PageConfiguration"
        },
        {
          "$ref": "#/definitions/docs.SectionConfiguration"
        },
        {
          "$ref": "#/definitions/docs.ApiReferenceConfiguration"
        },
        {
          "$ref": "#/definitions/docs.LinkConfiguration"
        },
        {
          "$ref": "#/definitions/docs.ChangelogConfiguration"
        }
      ]
    },
    "docs.UntabbedNavigationConifg": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/docs.NavigationItem"
      }
    },
    "docs.TabId": {
      "type": "string"
    },
    "docs.TabbedNavigationItem": {
      "type": "object",
      "properties": {
        "tab": {
          "$ref": "#/definitions/docs.TabId"
        },
        "layout": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/docs.NavigationItem"
              }
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "tab"
      ],
      "additionalProperties": false
    },
    "docs.TabbedNavigationConfig": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/docs.TabbedNavigationItem"
      }
    },
    "docs.NavigationConfig": {
      "anyOf": [
        {
          "$ref": "#/definitions/docs.UntabbedNavigationConifg"
        },
        {
          "$ref": "#/definitions/docs.TabbedNavigationConfig"
        }
      ]
    },
    "docs.NavbarGithubConfig": {
      "type": "string"
    },
    "docs.NavbarLink": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "filled",
            "outlined",
            "minimal",
            "github",
            "primary",
            "secondary"
          ]
        }
      },
      "required": [
        "type"
      ],
      "oneOf": [
        {
          "properties": {
            "type": {
              "const": "filled"
            },
            "href": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "url": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "text": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "icon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rightIcon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rounded": {
              "oneOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "type"
          ]
        },
        {
          "properties": {
            "type": {
              "const": "outlined"
            },
            "href": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "url": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "text": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "icon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rightIcon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rounded": {
              "oneOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "type"
          ]
        },
        {
          "properties": {
            "type": {
              "const": "minimal"
            },
            "href": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "url": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "text": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "icon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rightIcon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rounded": {
              "oneOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "type"
          ]
        },
        {
          "properties": {
            "type": {
              "const": "github"
            },
            "value": {
              "$ref": "#/definitions/docs.NavbarGithubConfig"
            }
          },
          "required": [
            "type"
          ]
        },
        {
          "properties": {
            "type": {
              "const": "primary"
            },
            "href": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "url": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "text": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "icon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rightIcon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rounded": {
              "oneOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "type"
          ]
        },
        {
          "properties": {
            "type": {
              "const": "secondary"
            },
            "href": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "url": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "text": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "icon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rightIcon": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "rounded": {
              "oneOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "type"
          ]
        }
      ]
    },
    "docs.FooterLinksConfig": {
      "type": "object",
      "properties": {
        "github": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "x": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "linkedin": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "youtube": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "instagram": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "facebook": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "discord": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "slack": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hackernews": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "medium": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "website": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.ExperimentalConfig": {
      "type": "object",
      "properties": {
        "mdx-components": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "disable-stream-toggle": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.ProgrammingLanguage": {
      "type": "string",
      "enum": [
        "typescript",
        "javascript",
        "python",
        "java",
        "go",
        "ruby",
        "csharp",
        "nodets",
        "nodejs",
        "dotnet",
        "curl",
        "jvm",
        "ts",
        "js"
      ]
    },
    "docs.TwitterCardSetting": {
      "type": "string",
      "enum": [
        "summary",
        "summary_large_image",
        "app",
        "player"
      ]
    },
    "docs.MetadataConfig": {
      "type": "object",
      "properties": {
        "og:site_name": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:title": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:description": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:url": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:image": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:image:width": {
          "oneOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:image:height": {
          "oneOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:locale": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "og:logo": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:title": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:description": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:handle": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:image": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:site": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:url": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "twitter:card": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.TwitterCardSetting"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.RedirectConfig": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string"
        },
        "destination": {
          "type": "string"
        },
        "permanent": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "source",
        "destination"
      ],
      "additionalProperties": false
    },
    "docs.LogoConfiguration": {
      "type": "object",
      "properties": {
        "dark": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "light": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "height": {
          "oneOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "href": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.BackgroundImageThemedConfig": {
      "type": "object",
      "properties": {
        "dark": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "light": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.BackgroundImageConfiguration": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/definitions/docs.BackgroundImageThemedConfig"
        }
      ]
    },
    "docs.ColorThemedConfig": {
      "type": "object",
      "properties": {
        "dark": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "light": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.ColorConfig": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/definitions/docs.ColorThemedConfig"
        }
      ]
    },
    "docs.ColorsConfiguration": {
      "type": "object",
      "properties": {
        "accent-primary": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "accentPrimary": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "background": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "border": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "sidebar-background": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "header-background": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "card-background": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ColorConfig"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.FontWeight": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        }
      ]
    },
    "docs.FontStyle": {
      "type": "string",
      "enum": [
        "normal",
        "italic"
      ]
    },
    "docs.FontConfigVariant": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        },
        "weight": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontWeight"
            },
            {
              "type": "null"
            }
          ]
        },
        "style": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontStyle"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "path"
      ],
      "additionalProperties": false
    },
    "docs.FontConfigPath": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/definitions/docs.FontConfigVariant"
        }
      ]
    },
    "docs.FontDisplay": {
      "type": "string",
      "enum": [
        "auto",
        "block",
        "swap",
        "fallback",
        "optional"
      ]
    },
    "docs.FontConfig": {
      "type": "object",
      "properties": {
        "name": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "path": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "weight": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontWeight"
            },
            {
              "type": "null"
            }
          ]
        },
        "style": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontStyle"
            },
            {
              "type": "null"
            }
          ]
        },
        "paths": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/docs.FontConfigPath"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "display": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontDisplay"
            },
            {
              "type": "null"
            }
          ]
        },
        "fallback": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "font-variation-settings": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.DocsTypographyConfig": {
      "type": "object",
      "properties": {
        "headingsFont": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "bodyFont": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "codeFont": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.FontConfig"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.SearchbarPlacement": {
      "type": "string",
      "enum": [
        "header",
        "header-tabs",
        "sidebar"
      ]
    },
    "docs.TabsPlacement": {
      "type": "string",
      "enum": [
        "header",
        "sidebar"
      ]
    },
    "docs.ContentAlignment": {
      "type": "string",
      "enum": [
        "center",
        "left"
      ]
    },
    "docs.HeaderPosition": {
      "type": "string",
      "enum": [
        "fixed",
        "static"
      ]
    },
    "docs.LayoutConfig": {
      "type": "object",
      "properties": {
        "page-width": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "content-width": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "sidebar-width": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "header-height": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "searchbar-placement": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.SearchbarPlacement"
            },
            {
              "type": "null"
            }
          ]
        },
        "tabs-placement": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.TabsPlacement"
            },
            {
              "type": "null"
            }
          ]
        },
        "content-alignment": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.ContentAlignment"
            },
            {
              "type": "null"
            }
          ]
        },
        "header-position": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.HeaderPosition"
            },
            {
              "type": "null"
            }
          ]
        },
        "disable-header": {
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.IntegrationsConfig": {
      "type": "object",
      "properties": {
        "intercom": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "docs.CssConfig": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "docs.JsScriptStrategy": {
      "type": "string",
      "enum": [
        "beforeInteractive",
        "afterInteractive",
        "lazyOnload"
      ]
    },
    "docs.JsRemoteConfig": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "strategy": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.JsScriptStrategy"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "url"
      ],
      "additionalProperties": false
    },
    "docs.JsFileConfigSettings": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        },
        "strategy": {
          "oneOf": [
            {
              "$ref": "#/definitions/docs.JsScriptStrategy"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "path"
      ],
      "additionalProperties": false
    },
    "docs.JsFileConfig": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/definitions/docs.JsFileConfigSettings"
        }
      ]
    },
    "docs.JsConfigOptions": {
      "anyOf": [
        {
          "$ref": "#/definitions/docs.JsRemoteConfig"
        },
        {
          "$ref": "#/definitions/docs.JsFileConfig"
        }
      ]
    },
    "docs.JsConfig": {
      "anyOf": [
        {
          "$ref": "#/definitions/docs.JsConfigOptions"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/docs.JsConfigOptions"
          }
        }
      ]
    }
  }
}