Skip to content

ListNamespaces

Description

      description: |
        List all child namespace names of the parent namespace `id`.

Request Schema

    ListNamespacesRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        page_token:
          $ref: "#/components/schemas/PageToken"
        limit:
          $ref: "#/components/schemas/PageLimit"

Response Schema

    ListNamespacesResponse:
      type: object
      required:
        - namespaces
      properties:
        namespaces:
          type: array
          uniqueItems: true
          description: |
            The list of names of the child namespaces relative to the parent namespace `id` in the request.
          items:
            type: string
        page_token:
          $ref: "#/components/schemas/PageToken"

Page Token

    PageToken:
      description: |
        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.
      type: string
      nullable: true

Page Limit

    PageLimit:
      description: |
        An inclusive upper bound of the 
        number of results that a caller will receive.
      type: integer
      nullable: true