LibraryService

MergeShelves

Merges two shelves by adding all books from the shelf named other_shelf_name to shelf name, and deletes other_shelf_name. Returns the updated shelf. The book ids of the moved books may not be the same as the original books.

Returns NOT_FOUND if either shelf does not exist. This call is a no-op if the specified shelves are the same.

post/v1/shelves/{shelf}:merge

Path parameters

shelfstring required

The shelf id.

Request body

namestring required

The name of the shelf we're adding books to.

other_shelf_namestring required

The name of the shelf we're removing books from and deleting.

Response

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.77

Apr 11, 2022v1ac9d37cae0e02See the full diff
- ▲
  the request's body type changed from no type to object
  request-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
Feb 23, 2022v1639a4ec995ca21See the full diff
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
Jan 12, 2022v100e696b6b84a1See the full diff
- ○
  the response's property pattern ^shelves/[a-z2-7]{26}$ was added for the status
  response-property-pattern-added
Jan 11, 2022v12a0f5e3b87341See the full diff
- ○
  api operation id MergeShelves removed and replaced with LibraryService_MergeShelves
  api-operation-id-removed
Jan 11, 2022v10dea6034d9691See the full diff
- ○
  api operation id LibraryService_MergeShelves removed and replaced with MergeShelves
  api-operation-id-removed
Dec 9, 2021v11f7e8ced536933See the full diff
- ▲
  the request's body type changed from object to no type
  request-body-type-changed
- ▲
  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 request property became optional
  request-property-became-optional
- ○
  the request property became optional
  request-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

Full history