Test compatibility of a schema for the subject and version.

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

Path parameters

  • subject string Required

    The subject name. Use [:.:] for context-qualified subjects, or just for the default context.

  • version string Required

    The schema version to check compatibility against. Use an integer for a specific version or 'latest' for the most recent version.

Query parameters

  • verbose boolean

    If true, includes more verbose information about the compatibility check, for example the reason the check failed.

Body

  • schema string
  • schemaType string
  • references array[object]
    Hide references attributes Show references attributes object
    • name string

      The name used to reference this schema in the dependent schema definition.

    • subject string

      The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.

    • version integer

      The version of the referenced schema.

  • metadata object

    A map of user-defined properties associated with this schema

    Hide metadata attribute Show metadata attribute object
    • properties object

      Accepted values may be string, number, or boolean. All values are converted to strings.

      Hide properties attribute Show properties attribute object
      • * string Additional properties

Body

  • schema string
  • schemaType string
  • references array[object]
    Hide references attributes Show references attributes object
    • name string

      The name used to reference this schema in the dependent schema definition.

    • subject string

      The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.

    • version integer

      The version of the referenced schema.

  • metadata object

    A map of user-defined properties associated with this schema

    Hide metadata attribute Show metadata attribute object
    • properties object

      Accepted values may be string, number, or boolean. All values are converted to strings.

      Hide properties attribute Show properties attribute object
      • * string Additional properties

Body

  • schema string
  • schemaType string
  • references array[object]
    Hide references attributes Show references attributes object
    • name string

      The name used to reference this schema in the dependent schema definition.

    • subject string

      The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.

    • version integer

      The version of the referenced schema.

  • metadata object

    A map of user-defined properties associated with this schema

    Hide metadata attribute Show metadata attribute object
    • properties object

      Accepted values may be string, number, or boolean. All values are converted to strings.

      Hide properties attribute Show properties attribute object
      • * string Additional properties

Responses

POST /compatibility/subjects/{subject}/versions/{version} 
curl \
 --request POST 'http://localhost:8081/compatibility/subjects/{subject}/versions/{version}' \
 --header "Content-Type: application/vnd.schemaregistry.v1+json"
curl \
 --request POST 'http://localhost:8081/compatibility/subjects/{subject}/versions/{version}' \
 --header "Content-Type: application/vnd.schemaregistry+json"
curl \
 --request POST 'http://localhost:8081/compatibility/subjects/{subject}/versions/{version}' \
 --header "Content-Type: application/json" \
 --data '{"schema":"string","schemaType":"string","references":[{"name":"string","subject":"string","version":42}],"metadata":{"properties":{"additionalProperty1":"string","additionalProperty2":"string"}}}'
Request examples 
{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
}
Request examples 
{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
}
Request examples 
{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
}
Response examples (200) 
{
  "is_compatible": true,
  "messages": [
    "string"
  ]
}
Response examples (200) 
{
  "is_compatible": true,
  "messages": [
    "string"
  ]
}
Response examples (200) 
{
  "is_compatible": true,
  "messages": [
    "string"
  ]
}
Response examples (409) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (409) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (409) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (422) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (422) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (422) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (500) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (500) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (500) 
{
  "error_code": 42,
  "message": "string"
}