APIv1: Bookmarks
Author: fmartingrCreated Jul 21, 2023Updated May 13, 2026
Labelstype:enhancementcomponent:frontendcomponent:backend
Migrate the legacy bookmarks API to the new router and API specification
Acceptance criteria
/api/v1/bookmarks:GETfor list,POSTfor creation.- Bookmark creation should allow all current features (create archive/readable) plus ebook creation. But all these fields should be put inside another (
_creation_options?) instead of mixed with the object attributes.
- Bookmark creation should allow all current features (create archive/readable) plus ebook creation. But all these fields should be put inside another (
/api/v1/bookmarks/:id:PUT/PATCHfor modification,GETfor retrieving information,DELETEfor deletion./api/v1/bookmarks/:id/cache:POSTcall that allows a single bookmark cache regeneration (re-download archive, rebuild ebook, ...).- Fix #634
/api/v1/bookmarks/cache:POSTcall that allows multiple bookmarks cache regeneration (re-download archive, rebuild ebook, ...).- Logic should be moved to domains
- All endpoints should be properly tested.
- All endpoints should use swagger definitions.
- All endpoints require the user to be authenticated, only owners can create, modify and delete bookmarks.
Relates to: #640 Fixes: #634
Source: go-shiori/shiori