v1

latestOpenAPI 3.0.32026-07-1711821.4 KB
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

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.