🎉 Using or considering OpenSnowcat? We want to hear from you! Our repos are feeling lonely – give them a ⭐ star !
Schema Registry

API Endpoints

OpenSnowcat Schema Registry API documentation for managing and validating JSON schemas with Iglu protocol support.

Schemas

  • [GET] /api/schemas - List all schemas
  • [GET] /api/schemas/search - Search schemas by name and description
  • [POST] /api/schemas - Publish new self-describing schema
  • [GET] /api/schemas/{vendor} - Get all schemas for vendor
  • [GET] /api/schemas/{vendor}/{name} - Get list of schemas by vendor name
  • [GET] /api/schemas/{vendor}/{name}/jsonschema/{model} - Get list of schemas by vendor name and model
  • [GET] /api/schemas/{vendor}/{name}/{format}/{version} - Get a particular schema by its Schema URI
  • [PUT] /api/schemas/{vendor}/{name}/{format}/{version} - Add a schema to its Schema URI
  • [DELETE] /api/schemas/{vendor}/{name}/{format}/{version} - Delete a particular schema from Schema Registry by its URI

Drafts

  • [GET] /api/drafts - List all available drafts
  • [GET] /api/drafts/{vendor}/{name}/{format}/{version} - Get a particular draft by its URI
  • [PUT] /api/drafts/{vendor}/{name}/{format}/{version} - Add or update a draft
  • [DELETE] /api/drafts/{vendor}/{name}/{format}/{version} - Delete a particular draft by its URI

Meta

  • [GET] /api/meta/{vendor}/{name}/{format}/{version} - Get metadata for a specific schema version
  • [GET] /api/meta/health - Health check
  • [GET] /api/meta/health/db - Database health check

Authentication

  • [POST] /api/auth/keygen - Create new API key with granular permissions
  • [DELETE] /api/auth/keygen - Delete API key

Validation

  • [POST] /api/validate/schema/{format} - Validate schemas by format
  • [POST] /api/validate/instance - Validate self-describing instances

Model Context Protocol (MCP)

  • [POST] /api/mcp - Model Context Protocol JSON-RPC 2.0 endpoint

Authentication

All API endpoints require authentication using an API key passed in the header:

apikey: your-api-key-uuid