Schema Registry API
APICurio-based multiformat schema management — schema CRUD, versioning, PII field tagging, compatibility checking, and low-level artifact management.
| Field | Value |
|---|---|
| Port | 50031 |
| Base Path | /api/v1 (schemas), /groups (registry groups) |
| OpenAPI | 3.0.1 |
| Spec | Schema Registry API.json |
Group Management
Groups organize schemas into logical namespaces (e.g., by team or domain).
| Method | Path | Description | Status Codes |
|---|---|---|---|
| GET | /groups | List all groups | 200 |
| POST | /groups | Create group | 201, 400 |
| GET | /groups/{groupId} | Get group by ID | 200, 404 |
| PUT | /groups/{groupId} | Update group metadata | 204, 400, 404 |
| DELETE | /groups/{groupId} | Delete group | 204, 404, 409 |
warning
Deleting a group with existing artifacts returns 409 Conflict.
GroupInfo Schema
{
"groupId": "string",
"description": "string",
"properties": { "key": "value" },
"createdOn": "2024-01-01T00:00:00Z",
"modifiedOn": "2024-01-01T00:00:00Z"
}
Schema Management
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/schema-registry/schemas | List schemas with filters |
| POST | /api/v1/schema-registry/schemas | Create schema |
| GET | /api/v1/schema-registry/schemas/{id} | Get schema details |
| PATCH | /api/v1/schema-registry/schemas/{id} | Update schema metadata |
| DELETE | /api/v1/schema-registry/schemas/{id} | Delete schema |
Schema Versioning
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/schema-registry/schemas/{id}/versions | List versions |
| POST | /api/v1/schema-registry/schemas/{id}/versions | Create new version |
| GET | /api/v1/schema-registry/schemas/{id}/versions/{versionId} | Get specific version |
Schema State & PII
| Method | Path | Description |
|---|---|---|
| PUT | /api/v1/groups/{groupId}/artifacts/{artifactId}/state | Update state |
| PATCH | …/schemas/{id}/versions/{versionId}/fields/{fieldName}/pii | Mark field as PII |
| POST | …/schemas/{id}/versions/{version}/compatibility-check | Check compatibility |
| POST | /api/v1/schema-registry/schemas/{id}/deprecate | Deprecate schema |
Schema States
| State | Description |
|---|---|
ENABLED | Schema is active and available |
DISABLED | Schema is disabled |
DEPRECATED | Backward compatibility only — no new usage |
APICurio Low-Level (Artifact Management)
Direct APICurio Registry operations for advanced use cases.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/groups/{groupId}/artifacts | List artifacts in group |
| POST | /api/v1/groups/{groupId}/artifacts | Create artifact |
| GET | /api/v1/groups/{groupId}/artifacts/{artifactId} | Get artifact content |
| PUT | /api/v1/groups/{groupId}/artifacts/{artifactId} | Update artifact |
| GET | …/versioning/groups/{groupId}/artifacts/{artifactId}/versions | List versions |
| POST | …/versioning/groups/{groupId}/artifacts/{artifactId}/versions | Create version |
| GET | …/versioning/…/versions/{versionId} | Get version content |
Frontend Integration
| File | Purpose |
|---|---|
services/schema-registry/schema-registry.service.ts | Schema CRUD & versioning |
services/schema-registry/useSchemas.ts | React Query hook |
types/schema-registry.types.ts | TypeScript types |