PortalCustomization

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortalCustomization",
  "title": "PortalCustomization",
  "description": "The custom settings of this portal",
  "type": "object",
  "properties": {
    "theme": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "nullable": false
        },
        "mode": {
          "type": "string",
          "enum": [
            "light",
            "dark",
            "system"
          ],
          "x-speakeasy-unknown-values": "allow"
        },
        "colors": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "primary": {
              "type": "string",
              "example": "#000000",
              "nullable": false,
              "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$",
              "x-validation-message": "must be a valid hex color value"
            }
          }
        }
      }
    },
    "layout": {
      "type": "string",
      "nullable": false
    },
    "css": {
      "type": "string",
      "nullable": true
    },
    "menu": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "main": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PortalMenuItem"
          }
        },
        "footer_sections": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PortalFooterMenuSection"
          }
        },
        "footer_bottom": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PortalMenuItem"
          }
        }
      }
    },
    "spec_renderer": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "try_it_ui": {
          "description": "Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.",
          "type": "boolean",
          "default": true
        },
        "try_it_insomnia": {
          "description": "Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.",
          "type": "boolean",
          "default": true
        },
        "infinite_scroll": {
          "description": "Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.",
          "type": "boolean",
          "default": true
        },
        "show_schemas": {
          "description": "Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.",
          "type": "boolean",
          "default": true
        },
        "hide_internal": {
          "description": "Manage visibility of internal endpoints and models.",
          "type": "boolean",
          "default": false
        },
        "hide_deprecated": {
          "description": "Manage visibility of deprecated endpoints and models.",
          "type": "boolean",
          "default": false
        },
        "allow_custom_server_urls": {
          "description": "Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.",
          "type": "boolean",
          "default": true
        }
      }
    },
    "robots": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}