Scalar · Schema

project-version

API ClientAPI DocumentationAPI ReferenceCode GenerationDeveloper ToolsOpenAPIRegistrySDKSwagger

Properties

Name Type Description
uid object
name string
primaryGuideId string
primaryReferenceId string
references object
guides object
header array
footer string
footerCss string
footerBelowSidebar boolean
headScript string
bodyScript string
View JSON Schema on GitHub

JSON Schema

scalar-project-version-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/scalar/main/json-schema/scalar-project-version-schema.json",
  "title": "project-version",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/scalar-signup-api-openapi.yml#/components/schemas/project-version",
  "type": "object",
  "properties": {
    "uid": {
      "$ref": "#/$defs/nanoid"
    },
    "name": {
      "default": "Default Version",
      "type": "string"
    },
    "primaryGuideId": {
      "type": "string"
    },
    "primaryReferenceId": {
      "type": "string"
    },
    "references": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "$ref": "#/$defs/reference"
      }
    },
    "guides": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "$ref": "#/$defs/guide"
      }
    },
    "header": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/header-link"
      }
    },
    "footer": {
      "default": "",
      "type": "string"
    },
    "footerCss": {
      "default": "",
      "type": "string"
    },
    "footerBelowSidebar": {
      "default": false,
      "type": "boolean"
    },
    "headScript": {
      "default": "",
      "type": "string"
    },
    "bodyScript": {
      "default": "",
      "type": "string"
    }
  },
  "required": [
    "uid",
    "name",
    "primaryGuideId",
    "primaryReferenceId",
    "references",
    "guides",
    "header",
    "footer",
    "footerCss",
    "footerBelowSidebar",
    "headScript",
    "bodyScript"
  ],
  "additionalProperties": false,
  "$defs": {
    "guide": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "sidebar": {
          "$ref": "#/$defs/sidebar"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isButton": {
          "default": false,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "uid",
        "title",
        "description",
        "sidebar",
        "show",
        "isButton",
        "isStarred"
      ],
      "additionalProperties": false
    },
    "header-link": {
      "anyOf": [
        {
          "$ref": "#/$defs/header-link-guide"
        },
        {
          "$ref": "#/$defs/header-link-reference"
        },
        {
          "$ref": "#/$defs/header-link-group"
        },
        {
          "$ref": "#/$defs/header-link-external"
        },
        {
          "$ref": "#/$defs/header-link-version-selector"
        },
        {
          "$ref": "#/$defs/header-link-spacer"
        }
      ]
    },
    "header-link-external": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        },
        "type": {
          "type": "string",
          "const": "link"
        },
        "isButton": {
          "default": false,
          "type": "boolean"
        },
        "link": {
          "type": "string"
        }
      },
      "required": [
        "uid",
        "title",
        "show",
        "isStarred",
        "type",
        "isButton",
        "link"
      ],
      "additionalProperties": false
    },
    "header-link-group": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        },
        "type": {
          "type": "string",
          "const": "group"
        },
        "children": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/header-link-guide"
              },
              {
                "$ref": "#/$defs/header-link-reference"
              },
              {
                "$ref": "#/$defs/header-link-external"
              }
            ]
          },
          "description": "Children of the group. Groups cannot contain other groups, spacers, or the version selector"
        }
      },
      "required": [
        "uid",
        "title",
        "show",
        "isStarred",
        "type",
        "children"
      ],
      "additionalProperties": false
    },
    "header-link-guide": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        },
        "type": {
          "type": "string",
          "const": "guide"
        }
      },
      "required": [
        "uid",
        "title",
        "show",
        "isStarred",
        "type"
      ],
      "additionalProperties": false
    },
    "header-link-reference": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        },
        "type": {
          "type": "string",
          "const": "reference"
        },
        "hasPermalink": {
          "default": false,
          "description": "Whether the reference has a permalinked reference or not",
          "type": "boolean"
        },
        "hasManagedDoc": {
          "default": false,
          "description": "Whether the reference has a linked registry API",
          "type": "boolean"
        }
      },
      "required": [
        "uid",
        "title",
        "show",
        "isStarred",
        "type",
        "hasPermalink",
        "hasManagedDoc"
      ],
      "additionalProperties": false
    },
    "header-link-spacer": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        },
        "type": {
          "type": "string",
          "const": "spacer"
        }
      },
      "required": [
        "uid",
        "title",
        "show",
        "isStarred",
        "type"
      ],
      "additionalProperties": false
    },
    "header-link-version-selector": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        },
        "type": {
          "type": "string",
          "const": "version-selector"
        }
      },
      "required": [
        "uid",
        "title",
        "show",
        "isStarred",
        "type"
      ],
      "additionalProperties": false
    },
    "namespace": {
      "type": "string",
      "minLength": 3,
      "maxLength": 50,
      "pattern": "^[a-zA-Z0-9-_]+$"
    },
    "nanoid": {
      "type": "string",
      "minLength": 5
    },
    "project-icon": {
      "$ref": "#/$defs/project-icon-info"
    },
    "project-icon-info": {
      "type": "object",
      "properties": {
        "src": {
          "default": "",
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "mask": {
          "type": "boolean"
        }
      },
      "required": [
        "src"
      ],
      "additionalProperties": false
    },
    "reference": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "yjsReference": {
          "$ref": "#/$defs/nanoid"
        },
        "config": {
          "default": "{}",
          "type": "string"
        },
        "specPermalink": {
          "default": "",
          "type": "string"
        },
        "managedDoc": {
          "default": null,
          "anyOf": [
            {
              "$ref": "#/$defs/reference-managed-doc"
            },
            {
              "type": "null"
            }
          ]
        },
        "show": {
          "default": true,
          "type": "boolean"
        },
        "isButton": {
          "default": false,
          "type": "boolean"
        },
        "isStarred": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "uid",
        "title",
        "description",
        "yjsReference",
        "config",
        "specPermalink",
        "managedDoc",
        "show",
        "isButton",
        "isStarred"
      ],
      "additionalProperties": false
    },
    "reference-managed-doc": {
      "type": "object",
      "properties": {
        "namespace": {
          "$ref": "#/$defs/namespace"
        },
        "slug": {
          "$ref": "#/$defs/slug"
        },
        "versions": {
          "default": [
            "latest"
          ],
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "namespace",
        "slug",
        "versions"
      ],
      "additionalProperties": false
    },
    "sidebar": {
      "type": "object",
      "properties": {
        "items": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/sidebar-item"
          }
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "items",
        "children"
      ],
      "additionalProperties": false
    },
    "sidebar-folder": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "type": {
          "type": "string",
          "const": "Folder"
        },
        "link": {
          "type": "string"
        },
        "icon": {
          "$ref": "#/$defs/project-icon"
        },
        "children": {
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "description": {
          "type": "string"
        },
        "show": {
          "type": "boolean"
        },
        "defaultOpen": {
          "type": "boolean"
        }
      },
      "required": [
        "uid",
        "title",
        "type",
        "children",
        "show"
      ],
      "additionalProperties": false
    },
    "sidebar-item": {
      "anyOf": [
        {
          "$ref": "#/$defs/sidebar-link"
        },
        {
          "$ref": "#/$defs/sidebar-page"
        },
        {
          "$ref": "#/$defs/sidebar-folder"
        }
      ]
    },
    "sidebar-link": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "type": {
          "type": "string",
          "const": "Link"
        },
        "link": {
          "type": "string"
        },
        "icon": {
          "$ref": "#/$defs/project-icon"
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "description": {
          "type": "string"
        },
        "show": {
          "type": "boolean"
        }
      },
      "required": [
        "uid",
        "title",
        "type",
        "link",
        "show"
      ],
      "additionalProperties": false
    },
    "sidebar-page": {
      "type": "object",
      "properties": {
        "uid": {
          "$ref": "#/$defs/nanoid"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "type": {
          "type": "string",
          "const": "Page"
        },
        "link": {
          "type": "string"
        },
        "icon": {
          "$ref": "#/$defs/project-icon"
        },
        "children": {
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "description": {
          "type": "string"
        },
        "show": {
          "type": "boolean"
        },
        "sidebarTitle": {
          "type": "string"
        },
        "defaultOpen": {
          "type": "boolean"
        },
        "yjsReference": {
          "type": "string"
        },
        "backgroundImage": {
          "type": "string"
        },
        "isMdx": {
          "default": false,
          "type": "boolean"
        },
        "isHtml": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "uid",
        "title",
        "type",
        "children",
        "description",
        "show",
        "yjsReference",
        "isMdx",
        "isHtml"
      ],
      "additionalProperties": false
    },
    "slug": {
      "type": "string",
      "minLength": 3,
      "maxLength": 60,
      "pattern": "^[a-z](?:[a-z0-9-]*[a-z0-9])?$"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/scalar-project-version"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.