Confluent Schema Registry · Schema

Confluent Schema Registry Schema

Schema for a schema object stored in Confluent Schema Registry.

Apache KafkaAvroCompatibilityConfluentData GovernanceData StreamingJSON SchemaOpen SourceProtobufRESTSchema EvolutionSchema Registry

Properties

Name Type Description
subject string The subject the schema is registered under
id integer Globally unique schema ID
version integer Version number within the subject
schemaType string The type of schema
schema string The schema definition as a string
references array References to other schemas
compatibilityLevel string Compatibility level for this subject
View JSON Schema on GitHub

JSON Schema

schema-registry-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.com/schemas/confluent-schema-registry/schema-registry-schema.json",
  "title": "Confluent Schema Registry Schema",
  "description": "Schema for a schema object stored in Confluent Schema Registry.",
  "type": "object",
  "properties": {
    "subject": {
      "type": "string",
      "description": "The subject the schema is registered under"
    },
    "id": {
      "type": "integer",
      "description": "Globally unique schema ID"
    },
    "version": {
      "type": "integer",
      "description": "Version number within the subject"
    },
    "schemaType": {
      "type": "string",
      "enum": ["AVRO", "JSON", "PROTOBUF"],
      "default": "AVRO",
      "description": "The type of schema"
    },
    "schema": {
      "type": "string",
      "description": "The schema definition as a string"
    },
    "references": {
      "type": "array",
      "description": "References to other schemas",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Reference name used in the schema"
          },
          "subject": {
            "type": "string",
            "description": "Subject of the referenced schema"
          },
          "version": {
            "type": "integer",
            "description": "Version of the referenced schema"
          }
        },
        "required": ["name", "subject", "version"]
      }
    },
    "compatibilityLevel": {
      "type": "string",
      "enum": [
        "BACKWARD",
        "BACKWARD_TRANSITIVE",
        "FORWARD",
        "FORWARD_TRANSITIVE",
        "FULL",
        "FULL_TRANSITIVE",
        "NONE"
      ],
      "description": "Compatibility level for this subject"
    }
  },
  "required": ["schema"]
}