Skip to content

REST Implementation Non-Standard Operation - ListNamespaces

REST Route Definition

  /v1/namespace/{id}/list:
    parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - name: 'page_token'
        in: query
        schema:
          $ref: '#/components/schemas/PageToken'
      - name: 'limit'
        in: query
        schema:
          $ref: '#/components/schemas/PageLimit'
    get:
      tags:
        - Namespace
        - Metadata
      summary: List namespaces
      operationId: ListNamespaces
      description: |
        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
      responses:
        200:
          $ref: '#/components/responses/ListNamespacesResponse'
        400:
          $ref: '#/components/responses/BadRequestErrorResponse'
        401:
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        403:
          $ref: '#/components/responses/ForbiddenErrorResponse'
        404:
          $ref: '#/components/responses/NotFoundErrorResponse'
        406:
          $ref: '#/components/responses/UnsupportedOperationErrorResponse'
        503:
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        5XX:
          $ref: '#/components/responses/ServerErrorResponse'