Configure per-artifact COMPATIBILITY and VALIDITY rules in Apicurio Registry via the REST v2 API

domain: apicur.io · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Enable the registry rules API: access the base URL at https://<registry-host>/apis/registry/v2
  2. Set a global default: PUT /admin/rules with body {"type": "COMPATIBILITY", "config": "BACKWARD"} to enforce backward compatibility across all artifacts unless overridden
  3. Override at artifact level: PUT /groups/{groupId}/artifacts/{artifactId}/rules with body {"type": "COMPATIBILITY", "config": "FULL"} to require both backward and forward compatibility for a specific schema
  4. Add a VALIDITY rule to reject malformed schemas: PUT /groups/{groupId}/artifacts/{artifactId}/rules with {"type": "VALIDITY", "config": "FULL"} — this validates syntax and semantic correctness on every schema upload
  5. Test the rule: attempt to register a breaking schema change via POST /groups/{groupId}/artifacts/{artifactId}/versions and confirm a 409 Conflict response is returned
  6. List active rules: GET /groups/{groupId}/artifacts/{artifactId}/rules and confirm both COMPATIBILITY and VALIDITY appear

Known gotchas

Related routes

Install and update Falco rules artifacts using falcoctl with an OCI-based artifact registry
falco.org · 6 steps · unrated
Configure Confluent Schema Registry compatibility modes for JSON Schema and Protobuf subjects
data-engineering · 5 steps · unrated
Configure OCI artifact push and pull for a non-container artifact (SBOM, attestation bundle, or Helm values file) using ORAS CLI and verify artifact integrity with cosign
Container Registries / OCI Artifacts · 6 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans