workspace

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/scalar/main/json-schema/scalar-workspace-schema.json",
  "title": "workspace",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/scalar-workspace-api-openapi.yml#/components/schemas/workspace",
  "type": "object",
  "properties": {
    "uid": {
      "$ref": "#/$defs/nanoid"
    },
    "createdAt": {
      "default": "unixTimestamp()",
      "$ref": "#/$defs/timestamp"
    },
    "updatedAt": {
      "default": "unixTimestamp()",
      "$ref": "#/$defs/timestamp"
    },
    "namespace": {
      "$ref": "#/$defs/namespace"
    },
    "title": {
      "default": "",
      "type": "string",
      "maxLength": 100
    },
    "slug": {
      "default": "randomManagedDocSlug()",
      "$ref": "#/$defs/slug"
    },
    "description": {
      "default": "",
      "type": "string"
    },
    "isPrivate": {
      "default": false,
      "type": "boolean"
    },
    "tags": {
      "default": []
    },
    "accessGroups": {
      "default": []
    },
    "loginPortalUid": {
      "type": "string"
    },
    "verifiedContent": {
      "type": "boolean"
    },
    "version": {
      "$ref": "#/$defs/version"
    },
    "versions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/workspace-version"
      }
    }
  },
  "required": [
    "uid",
    "createdAt",
    "updatedAt",
    "namespace",
    "title",
    "slug",
    "description",
    "isPrivate",
    "tags",
    "accessGroups",
    "version",
    "versions"
  ],
  "additionalProperties": false,
  "$defs": {
    "namespace": {
      "type": "string",
      "minLength": 3,
      "maxLength": 50,
      "pattern": "^[a-zA-Z0-9-_]+$"
    },
    "nanoid": {
      "type": "string",
      "minLength": 5
    },
    "registry-meta": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        }
      },
      "required": [
        "namespace",
        "slug"
      ],
      "additionalProperties": false
    },
    "slug": {
      "type": "string",
      "minLength": 3,
      "maxLength": 60,
      "pattern": "^[a-z](?:[a-z0-9-]*[a-z0-9])?$"
    },
    "timestamp": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "version": {
      "type": "string",
      "minLength": 1
    },
    "workspace-version": {
      "type": "object",
      "properties": {
        "version": {
          "$ref": "#/$defs/version"
        },
        "managedDocs": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/registry-meta"
          }
        },
        "createdAt": {
          "default": "unixTimestamp()",
          "$ref": "#/$defs/timestamp"
        },
        "updatedAt": {
          "default": "unixTimestamp()",
          "$ref": "#/$defs/timestamp"
        }
      },
      "required": [
        "version",
        "managedDocs",
        "createdAt",
        "updatedAt"
      ],
      "additionalProperties": false
    }
  }
}