services.check compatibility of a schema with all versions or a specific version of a subject.
HTTP request
POST https://managedkafka.googleapis.com/v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/compatibility/**}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project}/locations/{location}/schemaRegistries/{schemaRegistry}/compatibility/subjects/*/versions: services.check compatibility with one or more versions of the specified subject. * projects/{project}/locations/{location}/schemaRegistries/{schemaRegistry}/compatibility/subjects/{subject}/versions/{version}: services.check compatibility with a specific version of the subject. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "schema": string, "references": [ { object ( |
Fields | |
---|---|
schema |
Required. The schema payload |
references[] |
Optional. The schema references used by the schema. |
schemaType |
Optional. The schema type of the schema. |
verbose |
Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false. |
Response body
If successful, the response body contains an instance of CheckCompatibilityResponse
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.