Create Book and add to Shelf #3370

New Issue

OVERLORD · 2026-02-05T06:31:15+03:00

OVERLORD commented

2026-02-05 06:31:15 +03:00

Originally created by @McHill007 on GitHub (Nov 30, 2022).

API Endpoint or Feature

It would be great to have an optional parameter in create/update book api endpoint to directly assign the book to a shelf.

{ "name": "My own book", "description": "This is my own little book", "shelf_id" 1 }

Use-Case

We are creating books out of github automatically and would like to assign them to a specific shelf directly.
We need to get the shelf , parse the books and update shelf with new assignment.

I think it would reduce the work if the assignment can be done directly while creating or updating a book.

Additional context

No response

Originally created by @McHill007 on GitHub (Nov 30, 2022). ### API Endpoint or Feature It would be great to have an optional parameter in create/update book api endpoint to directly assign the book to a shelf. `{ "name": "My own book", "description": "This is my own little book", "shelf_id" 1 }` ### Use-Case We are creating books out of github automatically and would like to assign them to a specific shelf directly. We need to get the shelf , parse the books and update shelf with new assignment. I think it would reduce the work if the assignment can be done directly while creating or updating a book. ### Additional context _No response_

OVERLORD added the 🔩 API Request label 2026-02-05 06:31:15 +03:00

OVERLORD closed this issue

2026-02-05 06:31:20 +03:00

OVERLORD commented

2026-02-05 06:31:23 +03:00

@ssddanbrown commented on GitHub (Dec 1, 2022):

Thanks for the request, but I'm not sure if the use-case is significant enough to make this worthwhile.
I generally want to avoid adding tangential features, or optional abilities to endpoints, in the name of optimizing specific use-cases since needing to handling such elements creeps the scope of the specific endpoints and adds technical dept.

I'd maybe be a little more open about the addition of specific add/remove book endpoints for shelves, so would still require an extra request to put the book on a shelf but would avoid having to get & parse the shelf first.

@ssddanbrown commented on GitHub (Dec 1, 2022): Thanks for the request, but I'm not sure if the use-case is significant enough to make this worthwhile. I generally want to avoid adding tangential features, or optional abilities to endpoints, in the name of optimizing specific use-cases since needing to handling such elements creeps the scope of the specific endpoints and adds technical dept. I'd maybe be a little more open about the addition of specific add/remove book endpoints for shelves, so would still require an extra request to put the book on a shelf but would avoid having to get & parse the shelf first.

OVERLORD commented

2026-02-05 06:31:26 +03:00

@ssddanbrown commented on GitHub (Mar 6, 2023):

As per my previous message, I would not want to add the specific implementation requested here, and there's been no follow-up conversation, so I'll therefore close this off.

@ssddanbrown commented on GitHub (Mar 6, 2023): As per my previous message, I would not want to add the specific implementation requested here, and there's been no follow-up conversation, so I'll therefore close this off.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#3370