APapicurio
Compatibility

POST /compatibility/subjects/{subject}/versions

Changed on

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

subjectstring required

Subject of the schema version to check compatibility against.

Query parameters

verboseboolean

If true, includes reason when compatibility fails. Default is false.

normalizeboolean

If true, normalize the schema before checking compatibility. Default is false.

Headers

X-Registry-GroupIdstring

Group id in Apicurio Registry.

Request body

schemastring required

The schema definition as a string.

schemaTypestring

The schema format (AVRO, PROTOBUF, JSON). Default is AVRO.

metadataobject

Optional metadata associated with the schema.

ruleSetobject

Optional ruleset configuration for the schema.

Response

Compatibility check result.

is_compatibleboolean required

True if the schema is compatible, false otherwise.

messagesstring[]

Error messages explaining compatibility violations (only present when verbose=true).

Example response

{
  "is_compatible": true
}

Changes

  • v8a2f9ca447c9bRevision changes
    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/vnd.schemaregistry.v1+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.schemaregistry+json)