compatibilities
Creates, updates, deletes, gets or lists a compatibilities resource.
Overview
| Name | compatibilities |
| Type | Resource |
| Id | confluent.schema_registry.compatibilities |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
test_compatibility_by_subject_name | exec | subject, version | normalize, verbose | 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). |
test_compatibility_for_subject | exec | subject | verbose | Test input schema against a subject's schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. 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). |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
subject | string | Subject of the schema version against which compatibility is to be tested |
version | string | 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 |
normalize | boolean | Whether to normalize the given schema |
verbose | boolean | Whether to return detailed error messages |
Lifecycle Methods
- test_compatibility_by_subject_name
- test_compatibility_for_subject
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).
EXEC confluent.schema_registry.compatibilities.test_compatibility_by_subject_name
@subject='{{ subject }}' --required,
@version='{{ version }}' --required,
@normalize={{ normalize }},
@verbose={{ verbose }}
@@json=
'{
"version": {{ version }},
"id": {{ id }},
"schemaType": "{{ schemaType }}",
"references": "{{ references }}",
"schema": "{{ schema }}",
"metadata": "{{ metadata }}",
"ruleSet": "{{ ruleSet }}",
"schemaTagsToAdd": "{{ schemaTagsToAdd }}",
"schemaTagsToRemove": "{{ schemaTagsToRemove }}",
"propagateSchemaTags": {{ propagateSchemaTags }}
}'
;
Test input schema against a subject's schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. 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).
EXEC confluent.schema_registry.compatibilities.test_compatibility_for_subject
@subject='{{ subject }}' --required,
@verbose={{ verbose }}
@@json=
'{
"version": {{ version }},
"id": {{ id }},
"schemaType": "{{ schemaType }}",
"references": "{{ references }}",
"schema": "{{ schema }}",
"metadata": "{{ metadata }}",
"ruleSet": "{{ ruleSet }}",
"schemaTagsToAdd": "{{ schemaTagsToAdd }}",
"schemaTagsToRemove": "{{ schemaTagsToRemove }}",
"propagateSchemaTags": {{ propagateSchemaTags }}
}'
;