Sign in
Compatibility (v1)

Test schema compatibility against a particular schema subject-version

Test input schema against a particular version of a subject's schema for compatibility. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config).

post/compatibility/subjects/{subject}/versions/{version}

Path parameters

subjectstring required

Subject of the schema version against which compatibility is to be tested

versionstring required

Version of the subject's schema against which compatibility is to be tested. Valid values for versionId are between [1,2^31-1] or the string "latest"."latest" checks compatibility of the input schema with the last registered schema under the specified subject

Query parameters

normalizeboolean

Whether to normalize the given schema

verboseboolean

Whether to return detailed error messages

Request body

versioninteger

Version number

idinteger

Globally unique identifier of the schema

schemaTypestring

Schema type

schemastring

Schema definition string

propagateSchemaTagsboolean

Example request

{
  "references": [
    {
      "name": "io.confluent.kafka.example.User",
      "subject": "User",
      "version": 1
    }
  ]
}

Response

Compatibility check result.

Changes

No recorded changes to this endpoint across all 1 revision of this API.