#659·shiori

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: GET for list, POST for 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.
  • /api/v1/bookmarks/:id: PUT/PATCH for modification, GET for retrieving information, DELETE for deletion.
  • /api/v1/bookmarks/:id/cache: POST call that allows a single bookmark cache regeneration (re-download archive, rebuild ebook, ...).
    • Fix #634
  • /api/v1/bookmarks/cache: POST call 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