Apicurio Registry data contracts

Contract "orders-contract" → contract.orders-contract.owner.team = orders-team
Contract "billing-contract" → contract.billing-contract.owner.team = billing-team

apiVersion: v3.1.0
kind: DataContract
id: orders-contract
info:
  title: Orders Contract
  version: 1.0.0
  description: Data contract for order events
  status: active
  dataClassification: confidential
team:
  name: orders-team
  domain: commerce
  contact: orders@company.com
schemas:
  - name: OrderEvent
    type: avro
    location: orders/OrderEvent:3
    fields:
      customerEmail:
        description: Customer email address
        pii: true
        tags:
          - PII
          - EMAIL
      totalAmount:
        description: Total order amount in cents
quality:
  accuracy:
    - name: positive-amount
      expression: totalAmount > 0
      threshold: 1.0
    - name: valid-email
      expression: "customerEmail.matches('.*@.*\\\\..*')"
      threshold: 0.99
  completeness:
    - field: orderId
      threshold: 1.0
    - field: customerEmail
      threshold: 0.99
  freshness:
    maxStaleness: PT5M
serviceLevel:
  availability: 0.999
  latency:
    p99: PT1S

groupId/artifactId:version

DRAFT ──────► STABLE ──────► DEPRECATED
   │                              ▲
   └──────────────────────────────┘
         (skip stable)

DEV ──────► STAGE ──────► PROD

{
  "domainRules": [],
  "migrationRules": [
    {
      "name": "v1-to-v2-upgrade",
      "kind": "TRANSFORM",
      "type": "JSONATA",
      "mode": "UPGRADE",
      "expr": "$ ~> |$|{'fullName': firstName & ' ' & lastName}|",
      "onFailure": "ERROR",
      "disabled": false
    }
  ]
}

curl -X POST \
  http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/migrate \
  -H 'Content-Type: application/json' \
  -d '{
    "sourceVersion": "1",
    "targetVersion": "3",
    "record": {"firstName": "John", "lastName": "Doe", "amount": 100}
  }'

# Set compatibility group
curl -X PUT \
  http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/compatibility-group \
  -H 'Content-Type: application/json' \
  -d '{"group": "v2-family"}'

# Get compatibility group
curl http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/compatibility-group

Properties props = new Properties();
props.put(SerdeConfig.REGISTRY_URL, "http://localhost:8080/apis/registry/v3");
props.put(SerdeConfig.EXPLICIT_ARTIFACT_GROUP_ID, "my-group");
props.put(SerdeConfig.ARTIFACT_RESOLVER_STRATEGY, TopicRecordIdStrategy.class.getName());
props.put(SerdeConfig.CONTRACT_RULES_ENABLED, "true");
props.put(SerdeConfig.CONTRACT_RULES_FAIL_ON_ERROR, "true");
props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, AvroKafkaSerializer.class.getName());
// ... other Kafka producer properties

KafkaProducer<String, GenericRecord> producer = new KafkaProducer<>(props);

curl http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/audit

[
  {
    "action": "STATUS_TRANSITION",
    "detail": "Status changed from DRAFT to STABLE",
    "userId": "admin",
    "createdOn": "2026-05-19T10:30:00Z"
  },
  {
    "action": "RULESET_CONFIGURED",
    "detail": "Contract ruleset updated",
    "userId": "admin",
    "createdOn": "2026-05-19T10:25:00Z"
  }
]

curl "http://localhost:8080/apis/registry/v3/search/contracts?status=STABLE&ownerTeam=orders-team&limit=10"

# Set global ruleset
curl -X PUT \
  http://localhost:8080/apis/registry/v3/admin/contracts/ruleset \
  -H 'Content-Type: application/json' \
  -d '{
    "domainRules": [{
      "name": "require-non-empty",
      "kind": "CONDITION",
      "type": "CEL",
      "mode": "WRITE",
      "expr": "size(record) > 0",
      "onFailure": "ERROR",
      "disabled": false
    }],
    "migrationRules": []
  }'

# Get global ruleset
curl http://localhost:8080/apis/registry/v3/admin/contracts/ruleset

# Delete global ruleset
curl -X DELETE http://localhost:8080/apis/registry/v3/admin/contracts/ruleset

curl -X POST \
  http://localhost:8080/apis/registry/v3/groups/my-group/contracts \
  -H 'Content-Type: application/x-yaml' \
  --data-binary @my-contract.yaml

{
  "contractId": "orders-contract",
  "version": "1.0.0",
  "projection": {
    "rulesApplied": 2,
    "labelsApplied": 8,
    "tagsApplied": 3,
    "warnings": []
  }
}

curl "http://localhost:8080/apis/registry/v3/groups/my-group/contracts?limit=10&offset=0"

curl http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/export

curl -X POST \
  http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/promote \
  -H 'Content-Type: application/json' \
  -d '{"contractId": "orders-contract", "targetStage": "STAGE"}'

curl "http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/quality?contractId=orders-contract"

{"overall": 0.85, "completeness": 0.83, "compliance": 1.0, "stability": 0.67}

curl -X POST \
  http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/versions/1/contract/execute \
  -H 'Content-Type: application/json' \
  -d '{"mode": "WRITE", "record": {"message": {"totalAmount": 100, "status": "active"}}}'

{"passed": true, "violations": [], "executedRules": 2, "failedRules": 0}

curl -X PUT \
  http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/metadata \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "DRAFT",
    "ownerTeam": "Platform Team",
    "ownerDomain": "payments",
    "supportContact": "platform@example.com",
    "classification": "CONFIDENTIAL",
    "stage": "DEV"
  }'

curl -X POST \
  http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/status \
  -H 'Content-Type: application/json' \
  -d '{ "status": "STABLE" }'