LAlance-format
Namespace
Metadata

List namespaces

Changed on

List all child namespace names of the parent namespace id.

REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the ListNamespacesRequest information in the following way:

  • id: pass through path parameter of the same name
  • page_token: pass through query parameter of the same name
  • limit: pass through query parameter of the same name
get/v1/namespace/{id}/list

Request

  • Base URL
    http://localhost:2333
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /oauth/token
    • or HTTP bearer
    • or API key in header x-api-key

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.

page_tokenstring nullable

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

Pagination token from a previous request

limitinteger nullable

An inclusive upper bound of the number of results that a caller will receive.

Maximum number of items to return

Response

A list of namespaces

contextunknown
namespacesstring[] required

The list of names of the child namespaces relative to the parent namespace id in the request.

page_tokenstring nullable

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

Example response

{
  "context": {
    "key": "context"
  },
  "page_token": "page_token",
  "namespaces": [
    "namespaces",
    "namespaces"
  ]
}

Changes

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5d6099d672d3Revision changes
    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • breaking

      the response property's min was decreased from 400.00 to 0.00 for the response status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status