List names of namespaces
Create namespace entry
Get namespace by id
Name | Located in | Description | Required | Schema |
---|
id | path | | Yes | string |
Delete namespace by id
Ensure all schemas under this namespace is deleted, otherwise it will throw error
Name | Located in | Description | Required | Schema |
---|
id | path | | Yes | string |
Update namespace entity by id
Name | Located in | Description | Required | Schema |
---|
id | path | | Yes | string |
body | body | | Yes | object |
List schemas under the namespace
Name | Located in | Description | Required | Schema |
---|
id | path | | Yes | string |
Get latest schema
Returns latest schema in it's own data type. For protobuf response type would be 'application/octet-stream'. Avro, json schema response type would be 'application/json'
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
Code | Description | Schema |
---|
200 | A successful schema response. Based on schema format, response will return different content types. For avro and json schemas response type is application/json . For protobuf response type is application/octet-stream . | |
default | An unexpected error response. | rpcStatus |
Create schema under the namespace
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
body | body | Request payload should be equivalent to curl --data-binary option | Yes | binary |
Delete specified schema
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
Update only schema metadata
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
body | body | | Yes | object |
Check schema compatibility
Checks comptibility with existing latest schema
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
body | body | | Yes | binary |
X-Compatibility | header | | No | string |
Create schema under the namespace. Returns version number, unique ID and location
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
List all version numbers for schema
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
Delete specified version of the schema
Name | Located in | Description | Required | Schema |
---|
namespaceId | path | | Yes | string |
schemaId | path | | Yes | string |
versionId | path | | Yes | integer |
Global Search API
Name | Located in | Description | Required | Schema |
---|
namespaceId | query | | No | string |
schemaId | query | | No | string |
query | query | | Yes | string |
history | query | | No | boolean |
versionId | query | | No | integer |
Name | Type | Description | Required |
---|
SchemaCompatibility | string | | |
Name | Type | Description | Required |
---|
SchemaFormat | string | | |
Name | Type | Description | Required |
---|
typeUrl | string | | No |
value | byte | | No |
Name | Type | Description | Required |
---|
code | integer | | No |
message | string | | No |
details | [ protobufAny ] | | No |
Name | Type | Description | Required |
---|
v1beta1CheckCompatibilityResponse | object | | |
Name | Type | Description | Required |
---|
version | integer | | No |
id | string | | No |
location | string | | No |
Name | Type | Description | Required |
---|
message | string | | No |
Name | Type | Description | Required |
---|
message | string | | No |
Name | Type | Description | Required |
---|
message | string | | No |
Name | Type | Description | Required |
---|
data | byte | | No |
Name | Type | Description | Required |
---|
data | byte | | No |
Name | Type | Description | Required |
---|
namespaces | [ string ] | | No |
Name | Type | Description | Required |
---|
schemas | [ string ] | | No |
Name | Type | Description | Required |
---|
versions | [ integer ] | | No |
Name | Type | Description | Required |
---|
namespaceId | string | | No |
schemaId | string | | No |
versionId | integer | | No |
fields | [ string ] | | No |
types | [ string ] | | No |
path | string | | No |
Name | Type | Description | Required |
---|
total | long | | No |