Sign in
LibraryService

GetShelf

Gets a shelf. Returns NOT_FOUND if the shelf does not exist.

get/v1/shelves/{shelf}

Path parameters

shelfstring required

The shelf id.

Response

OK

namestring required

The resource name of the shelf. Shelf names have the form shelves/{shelf_id}. The name is ignored when creating a shelf.

themestring

The theme of the shelf

next_sort_atstring date

The next sorting date.

created_atstring date-time

The creation date and time.

updated_atstring date-time

The last update date and time.

Changes

Changed in 6 of the 12 revisions of this API.35

  • v1ac9d37cae0e01See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

  • v1639a4ec995ca1See the full diff
    • ○

      the response property became required for the status

      response-property-became-required

  • v100e696b6b84a1See the full diff
    • ○

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

      response-property-pattern-added

  • v12a0f5e3b87341See the full diff
    • ○

      api operation id GetShelf removed and replaced with LibraryService_GetShelf

      api-operation-id-removed

  • v10dea6034d9691See the full diff
    • ○

      api operation id LibraryService_GetShelf removed and replaced with GetShelf

      api-operation-id-removed

  • v11f7e8ced536921See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ○

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

      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