Sign in
LibraryService

ListShelves

Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

get/v1/shelves

Query parameters

page_sizeinteger

Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default.

page_tokenstring

A token identifying a page of results the server should return. Typically, this is the value of [ListShelvesResponse.next_page_token][google.example.library.v1.ListShelvesResponse.next_page_token] returned from the previous call to ListShelves method.

Response

OK

next_page_tokenstring

A token to retrieve next page of results. Pass this value in the [ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token] field in the subsequent call to ListShelves method to retrieve the next page of results.

Changes

Changed in 7 of the 12 revisions of this API.66

  • v1ac9d37cae0e02See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the shelves/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

  • v1639a4ec995ca1See the full diff
    • ○

      the response property shelves/items/name became required for the status 200

      response-property-became-required

  • v100e696b6b84a1See the full diff
    • ○

      the shelves/items/name response's property pattern ^shelves/[a-z2-7]{26}$ was added for the status 200

      response-property-pattern-added

  • v126b3bc7b51691See the full diff
    • ▲

      for the query request parameter page_size, the type/format was changed from string/ to integer/int32

      request-parameter-type-changed

  • v12a0f5e3b87341See the full diff
    • ○

      api operation id ListShelves removed and replaced with LibraryService_ListShelves

      api-operation-id-removed

  • v10dea6034d9691See the full diff
    • ○

      api operation id LibraryService_ListShelves removed and replaced with ListShelves

      api-operation-id-removed

  • v11f7e8ced536932See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ▲

      the response property shelves/items/name became optional for the status 200

      response-property-became-optional

    • ▲

      the shelves/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ○

      for the query request parameter page_size, the type/format was generalized from integer/int32 to string/

      request-parameter-type-generalized

    • ○

      the shelves/items/name response's property pattern ^shelves/[a-z2-7]{26}$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog