List names of namespaces
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1ListNamespacesResponse |
default | An unexpected error response. | rpcStatus |
Create namespace entry
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
body | body | Yes | v1beta1CreateNamespaceRequest |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1CreateNamespaceResponse |
default | An unexpected error response. | rpcStatus |
Get namespace by id
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
id | path | Yes | string |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1GetNamespaceResponse |
default | An unexpected error response. | rpcStatus |
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 |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1DeleteNamespaceResponse |
default | An unexpected error response. | rpcStatus |
Update namespace entity by id
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
id | path | Yes | string | |
body | body | Yes | object |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1UpdateNamespaceResponse |
default | An unexpected error response. | rpcStatus |
List schemas under the namespace
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
id | path | Yes | string |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1ListSchemasResponse |
default | An unexpected error response. | rpcStatus |
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 |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1CreateSchemaResponse |
default | An unexpected error response. | rpcStatus |
Delete specified schema
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
namespaceId | path | Yes | string | |
schemaId | path | Yes | string |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1DeleteSchemaResponse |
default | An unexpected error response. | rpcStatus |
Update only schema metadata
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
namespaceId | path | Yes | string | |
schemaId | path | Yes | string | |
body | body | Yes | object |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1UpdateSchemaMetadataResponse |
default | An unexpected error response. | rpcStatus |
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 |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1CreateSchemaResponse |
default | An unexpected error response. | rpcStatus |
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 |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1GetSchemaMetadataResponse |
default | An unexpected error response. | rpcStatus |
List all version numbers for schema
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
namespaceId | path | Yes | string | |
schemaId | path | Yes | string |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1ListVersionsResponse |
default | An unexpected error response. | rpcStatus |
Delete specified version of the schema
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
namespaceId | path | Yes | string | |
schemaId | path | Yes | string | |
versionId | path | Yes | integer |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1DeleteVersionResponse |
default | An unexpected error response. | rpcStatus |
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 |
Code | Description | Schema |
---|---|---|
200 | A successful response. | v1beta1SearchResponse |
default | An unexpected error response. | rpcStatus |
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 |
---|---|---|---|
id | string | Yes | |
format | SchemaFormat | No | |
compatibility | SchemaCompatibility | No | |
description | string | No |
Name | Type | Description | Required |
---|---|---|---|
namespace | v1beta1Namespace | No |
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 |
---|---|---|---|
namespace | v1beta1Namespace | No |
Name | Type | Description | Required |
---|---|---|---|
format | SchemaFormat | No | |
compatibility | SchemaCompatibility | No | |
authority | string | 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 |
---|---|---|---|
id | string | No | |
format | SchemaFormat | No | |
Compatibility | SchemaCompatibility | No | |
description | string | No | |
createdAt | dateTime | No | |
updatedAt | dateTime | 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 |
Name | Type | Description | Required |
---|---|---|---|
hits | [ v1beta1SearchHits ] | No | |
meta | v1beta1SearchMeta | No |
Name | Type | Description | Required |
---|---|---|---|
namespace | v1beta1Namespace | No |
Name | Type | Description | Required |
---|---|---|---|
format | SchemaFormat | No | |
compatibility | SchemaCompatibility | No | |
authority | string | No |
Can you improve this documentation? These fine people already did:
Hari krishna & Ravi SuhagEdit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
Ctrl+k | Jump to recent docs |
← | Move to previous article |
→ | Move to next article |
Ctrl+/ | Jump to the search field |