Favourites accessible via API #2826

New Issue

OVERLORD · 2026-02-05T05:21:38+03:00

OVERLORD commented

2026-02-05 05:21:38 +03:00

Originally created by @bytepoets-ssi on GitHub (Jun 1, 2022).

API Endpoint or Feature

At the moment the favourites of a user are not visible in the API. The status should be visible in the following calls as isFavourite: boolean:

GET /api/[shelves|books|chapters|pages]
GET /api/[shelves|books|chapters|pages]/{id}

In addition a user should be able to set/unset them

PUT /api/[shelves|books|chapters|pages]/{id}/favourite

{
    isFavourite: boolean
}

Use-Case

Feature completeness of the API. Make all the information stored in Bookstack available over the API

Additional context

No response

Originally created by @bytepoets-ssi on GitHub (Jun 1, 2022). ### API Endpoint or Feature At the moment the favourites of a user are not visible in the API. The status should be visible in the following calls as `isFavourite: boolean`: - GET /api/[shelves|books|chapters|pages] - GET /api/[shelves|books|chapters|pages]/{id} In addition a user should be able to set/unset them - PUT /api/[shelves|books|chapters|pages]/{id}/favourite ``` { isFavourite: boolean } ``` ### Use-Case Feature completeness of the API. Make all the information stored in Bookstack available over the API ### Additional context _No response_

OVERLORD added the 🔩 API Request label 2026-02-05 05:21:38 +03:00

OVERLORD commented

2026-02-05 05:21:55 +03:00

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

Thanks for the request @bytepoets-ssi.
Are you able to detail your specific use-case for these details? Knowing this helps think about implementation options outside of the ones proposed, while still thinking what works well for your usage.
It also helps ensure efforts are going to actually required features, A use-case of "Feature completeness" is generic and could apply to any endpoints added.

@ssddanbrown commented on GitHub (Jun 1, 2022): Thanks for the request @bytepoets-ssi. Are you able to detail your specific use-case for these details? Knowing this helps think about implementation options outside of the ones proposed, while still thinking what works well for your usage. It also helps ensure efforts are going to actually required features, A use-case of "Feature completeness" is generic and could apply to any endpoints added.

OVERLORD commented

2026-02-05 05:22:02 +03:00

@bytepoets-ssi commented on GitHub (Jun 20, 2022):

The use case here is to gather the information that is stored in Bookstack and other places in a central system. Show all e.g. unread emails, Bookstack pages,...
Favourite entries are highlighted accordingly and can be updated from there.

I thought of a joint endpoint but decided that adding it to the available route to retrieve a page is the more RESTful approach.

@bytepoets-ssi commented on GitHub (Jun 20, 2022): The use case here is to gather the information that is stored in Bookstack and other places in a central system. Show all e.g. unread emails, Bookstack pages,... Favourite entries are highlighted accordingly and can be updated from there. I thought of a joint endpoint but decided that adding it to the available route to retrieve a page is the more RESTful approach.

OVERLORD referenced this issue

2026-02-05 10:23:55 +03:00

[PR #2826] [CLOSED] Apply fixes from StyleCI #6072

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#2826