v1

latestOpenAPI 3.1.1Apache 2.02026-07-2654130166.5 KB

Namespace

Metadata

Create a new namespace

Create new namespace id.

During the creation process, the implementation may modify user-provided properties, such as adding additional properties like created_at to user-provided properties, omitting any specific property, or performing actions based on any property value.

post/v1/namespace/{id}/create

Request body

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

idstring[]

modestring

There are three modes when trying to create a namespace, to differentiate the behavior when a namespace of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are:

Create: the operation fails with 409.
ExistOk: the operation succeeds and the existing namespace is kept.
Overwrite: the existing namespace is dropped and a new empty namespace with this name is created.

propertiesobject

Properties stored on the namespace, if supported by the implementation.

Response

Result of creating a namespace

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

transaction_idstring

Optional transaction identifier

propertiesobject

Properties after the namespace is created.

If the server does not support namespace properties, it should return null for this field. If namespace properties are supported, but none are set, it should return an empty object.