Describe a namespace

Describe the detailed information for namespace id.

post/v1/namespace/{id}/describe

Path parameters

idstring required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query parameters

delimiterstring

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Request body

{"stackTrail":"components:schemas:DescribeNamespaceRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context for a request as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nREST NAMESPACE ONLY\nContext entries are passed via HTTP headers using the naming convention\n`x-lance-ctx-<key>: <value>`. For example, a context entry\n`{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.\n"}

idstring[]

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ]
}

Response

Returns a namespace, as well as any properties stored on the namespace if namespace properties are supported by the server.

{"stackTrail":"components:schemas:DescribeNamespaceResponse:properties:properties","oasType":"schema","type":"unknown","description":"Properties stored on the namespace, if supported by the server. 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.","example":{"owner":"Ralph","created_at":"1452120468"},"nullable":true}

Example response

{
  "properties": {
    "owner": "Ralph",
    "created_at": "1452120468"
  }
}