package danube_schema

Get desktop application:
View/edit binary Protocol Buffers messages

Schema Registry Service for managing schemas across the Danube cluster

• rpc CheckCompatibility (CheckCompatibilityRequest, CheckCompatibilityResponse)

  SchemaRegistry.proto:20

  Check if a new schema is compatible with existing versions

  message CheckCompatibilityRequest

  SchemaRegistry.proto:109

  Request to check compatibility

  • string subject = 1

  • bytes new_schema_definition = 2

  • string schema_type = 3

  • optional string compatibility_mode = 4

    Override subject's compatibility mode

  message CheckCompatibilityResponse

  SchemaRegistry.proto:117

  Response with compatibility result

  • bool is_compatible = 1

  • repeated string errors = 2

    Incompatibility reasons if not compatible

• rpc ConfigureTopicSchema (ConfigureTopicSchemaRequest, ConfigureTopicSchemaResponse)

  SchemaRegistry.proto:32

  Configure schema settings for a topic (admin-only) Allows admin to assign/change schema subject and validation settings

  message ConfigureTopicSchemaRequest

  SchemaRegistry.proto:149

  Request to configure schema for a topic (admin-only)

  • string topic_name = 1

    Topic to configure (e.g., "/default/user-events")

  • string schema_subject = 2

    Schema subject to assign

  • string validation_policy = 3

    "none", "warn", or "enforce"

  • bool enable_payload_validation = 4

    Enable deep payload validation

  message ConfigureTopicSchemaResponse

  SchemaRegistry.proto:156

  • bool success = 1

  • string message = 2

• rpc DeleteSchemaVersion (DeleteSchemaVersionRequest, DeleteSchemaVersionResponse)

  SchemaRegistry.proto:23

  Delete a specific schema version

  message DeleteSchemaVersionRequest

  SchemaRegistry.proto:123

  Request to delete a schema version

  • string subject = 1

  • uint32 version = 2

  message DeleteSchemaVersionResponse

  SchemaRegistry.proto:129

  Response for delete operation

  • bool success = 1

  • string message = 2

• rpc GetLatestSchema (GetLatestSchemaRequest, GetSchemaResponse)

  SchemaRegistry.proto:14

  Get the latest version of a schema for a subject

  message GetLatestSchemaRequest

  SchemaRegistry.proto:84

  Request to get latest schema for a subject

  • string subject = 1

    Subject name (usually topic name)

• rpc GetSchema (GetSchemaRequest, GetSchemaResponse)

  SchemaRegistry.proto:11

  Get a specific schema by ID and optional version

  message GetSchemaRequest

  SchemaRegistry.proto:63

  Request to get a schema by ID

  • uint64 schema_id = 1

    Global schema ID

  • optional uint32 version = 2

    Optional version, if omitted returns latest

• rpc GetTopicSchemaConfig (GetTopicSchemaConfigRequest, GetTopicSchemaConfigResponse)

  SchemaRegistry.proto:38

  Get current schema configuration for a topic

  message GetTopicSchemaConfigRequest

  SchemaRegistry.proto:174

  Request to get topic schema configuration

  • string topic_name = 1

  message GetTopicSchemaConfigResponse

  SchemaRegistry.proto:178

  • string schema_subject = 1

    Schema subject assigned to topic

  • string validation_policy = 2

    Current validation policy

  • bool enable_payload_validation = 3

    Whether payload validation is enabled

  • uint64 schema_id = 4

    Cached schema_id for the subject

• rpc ListSubjects (ListSubjectsRequest, ListSubjectsResponse)

  SchemaRegistry.proto:41

  List all registered schema subjects

  message ListSubjectsRequest

  SchemaRegistry.proto:185

  (message has no fields)

  message ListSubjectsResponse

  SchemaRegistry.proto:196

  • repeated SubjectSummary subjects = 1

• rpc ListVersions (ListVersionsRequest, ListVersionsResponse)

  SchemaRegistry.proto:17

  List all versions for a subject

  message ListVersionsRequest

  SchemaRegistry.proto:89

  Request to list all versions of a subject

  • string subject = 1

  message ListVersionsResponse

  SchemaRegistry.proto:94

  Response with list of versions

  • repeated SchemaVersionInfo versions = 1

• rpc RegisterSchema (RegisterSchemaRequest, RegisterSchemaResponse)

  SchemaRegistry.proto:8

  Register a new schema or get existing schema ID if identical schema exists

  message RegisterSchemaRequest

  SchemaRegistry.proto:45

  Request to register a new schema

  • string subject = 1

    Subject name (defaults to topic name)

  • string schema_type = 2

    "avro", "json_schema", "protobuf", "bytes", "string", "number"

  • bytes schema_definition = 3

    Schema content (JSON for Avro/JSON Schema, proto for Protobuf)

  • string description = 4

    Human-readable description

  • string created_by = 5

    Creator identifier

  • repeated string tags = 6

    Tags for categorization

  message RegisterSchemaResponse

  SchemaRegistry.proto:55

  Response after registering a schema

  • uint64 schema_id = 1

    Globally unique schema ID

  • uint32 version = 2

    Version number for this subject

  • bool is_new_version = 3

    false if exact schema already exists

  • string fingerprint = 4

    SHA-256 hash of schema for client caching

• rpc SetCompatibilityMode (SetCompatibilityModeRequest, SetCompatibilityModeResponse)

  SchemaRegistry.proto:26

  Set or update compatibility mode for a subject

  message SetCompatibilityModeRequest

  SchemaRegistry.proto:135

  Request to set compatibility mode

  • string subject = 1

  • string compatibility_mode = 2

    "none", "backward", "forward", "full"

  message SetCompatibilityModeResponse

  SchemaRegistry.proto:141

  Response for compatibility mode update

  • bool success = 1

  • string message = 2

• rpc UpdateTopicValidationPolicy (UpdateTopicValidationPolicyRequest, UpdateTopicValidationPolicyResponse)

  SchemaRegistry.proto:35

  Update validation policy for a topic (admin-only)

  message UpdateTopicValidationPolicyRequest

  SchemaRegistry.proto:162

  Request to update validation policy (admin-only)

  • string topic_name = 1

  • string validation_policy = 2

    "none", "warn", or "enforce"

  • bool enable_payload_validation = 3

  message UpdateTopicValidationPolicyResponse

  SchemaRegistry.proto:168

  • bool success = 1

  • string message = 2

Response containing schema details

Used as response type in: SchemaRegistry.GetLatestSchema, SchemaRegistry.GetSchema

• uint64 schema_id = 1

• uint32 version = 2

• string subject = 3

• string schema_type = 4

• bytes schema_definition = 5

• string description = 6

• uint64 created_at = 7

• string created_by = 8

• repeated string tags = 9

• string fingerprint = 10

• string compatibility_mode = 11

Information about a schema version

Used in: ListVersionsResponse

• uint32 version = 1

• uint64 created_at = 2

• string created_by = 3

• string description = 4

• string fingerprint = 5

• uint64 schema_id = 6

Used in: ListSubjectsResponse

• string subject = 1

• string schema_type = 2

  "avro", "json_schema", "protobuf", "bytes", "string", "number"

• uint32 latest_version = 3

• string compatibility_mode = 4

  "NONE", "BACKWARD", "FORWARD", "FULL"

• uint64 schema_id = 5

  Latest schema ID

• repeated string tags = 6