Include the cover property in the response for a LIST request on the /books endpoint #4927

New Issue

OVERLORD · 2026-02-05T09:26:58+03:00

OVERLORD commented

2026-02-05 09:26:58 +03:00

Originally created by @ln-ws on GitHub (Aug 26, 2024).

Describe the feature you'd like

A response for a READ request on the /books/{id} endpoint contains the cover object for the book requested. Using this object, one can acquire the Cover image data for that specific book. A response for a LIST request on the other hand does not contain such object.
If one were to implement a search for for the existing books, they would have to request the cover image for each book seperately. This increases overhead.

Describe the benefits this would bring to existing BookStack users

Reduces overhead
Simplifies usage of the API

Can the goal of this request already be achieved via other means?

Yes. You would have to iterativly request the cover images for each book seperately.

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?

Not using yet, just scoping

Additional context

No response

Originally created by @ln-ws on GitHub (Aug 26, 2024). ### Describe the feature you'd like A response for a `READ` request on the /books/{id} endpoint contains the `cover` object for the book requested. Using this object, one can acquire the Cover image data for that specific book. A response for a `LIST` request on the other hand does not contain such object. If one were to implement a search for for the existing books, they would have to request the cover image for each book seperately. This increases overhead. ### Describe the benefits this would bring to existing BookStack users - Reduces overhead - Simplifies usage of the API ### Can the goal of this request already be achieved via other means? Yes. You would have to iterativly request the cover images for each book seperately. ### Have you searched for an existing open/closed issue? - [X] I have searched for existing issues and none cover my fundamental request ### How long have you been using BookStack? Not using yet, just scoping ### Additional context _No response_

OVERLORD added the 🔨 Feature Request label 2026-02-05 09:26:58 +03:00

OVERLORD closed this issue

2026-02-05 09:26:59 +03:00

OVERLORD commented

2026-02-05 09:27:01 +03:00

@ln-ws commented on GitHub (Aug 26, 2024):

Duplicate post

@ln-ws commented on GitHub (Aug 26, 2024): Duplicate post

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#4927

Include the cover property in the response for a LIST request on the /books endpoint #4927