You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When making a READ request to the /books/{id} endpoint, the response includes a cover object containing the cover image data for the specified book. However, when making a LIST request to the /books endpoint, the response does not include this cover object.
Including the cover object in the LIST response would allow users to retrieve cover image data for all books in a single request, rather than needing to make separate requests for each book's cover image. This enhancement would reduce the overhead of fetching cover images and improve the efficiency of implementing book search functionalities.
Describe the benefits this would bring to existing BookStack users
Reduces the overhead associated with making multiple requests to fetch cover images.
Simplifies API usage by providing a more comprehensive response in a single request.
Can the goal of this request already be achieved via other means?
Yes, it is currently possible to achieve this by making individual requests for each book's cover image. However, this method increases the number of API calls and associated overhead.
Have you searched for an existing open/closed issue?
I have searched for existing issues and none cover my fundamental request
How long have you been using BookStack?
3 months to 1 year
Additional context
No response
The text was updated successfully, but these errors were encountered:
Thanks for the request @ln-ws,
I agree with this addition it's something we already do in the UI (list books with cover images).
I'm going to update this to also mention shelves since it's the same scenario there.
I've assigned this for the next feature release.
ssddanbrown
changed the title
Include the cover property in the response for a LIST request on the /books endpoint
API: Include cover image details for book & shelf list responses
Oct 14, 2024
Describe the feature you'd like
When making a
READ
request to the/books/{id}
endpoint, the response includes a cover object containing the cover image data for the specified book. However, when making aLIST
request to the/books
endpoint, the response does not include this cover object.Including the cover object in the
LIST
response would allow users to retrieve cover image data for all books in a single request, rather than needing to make separate requests for each book's cover image. This enhancement would reduce the overhead of fetching cover images and improve the efficiency of implementing book search functionalities.Describe the benefits this would bring to existing BookStack users
Can the goal of this request already be achieved via other means?
Yes, it is currently possible to achieve this by making individual requests for each book's cover image. However, this method increases the number of API calls and associated overhead.
Have you searched for an existing open/closed issue?
How long have you been using BookStack?
3 months to 1 year
Additional context
No response
The text was updated successfully, but these errors were encountered: