APIv1: Bookmarks

[fmartingr]

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 Remove old cache if updating cache done without problem #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

[Monirzadeh]

Hi.
I don't know how you want to impeliment API for adding bookmark but if it possible please return something that we can distinguish between internal error and bookmark exist.
Currently shiori return status 500 if bookmark exist.

[fmartingr]

Hi. I don't know how you want to impeliment API for adding bookmark but if it possible please return something that we can distinguish between internal error and bookmark exist. Currently shiori return status 500 if bookmark exist.

Yeah, on successful creation the response would be 201 and on duplicated 409.