Skip to content

API: Include cover image details for book & shelf list responses #5180

@ln-ws

Description

@ln-ws

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions