0 Fork 0

Files

T

John O'Keefe 25ef0d12ba docs(kobo,koreader,collections): Beam WO5 batch 6 — 12 endpoints

Kobo emulation + KOReader calibre-compatible surface backfilled with
device-token auth; collections reorder + update_rule created.

Claude registry: 12 entries. kobo/koreader emulation endpoints all bind
arbitrary protocol POST bodies (markup/bookmark/gettests/sync-from-server,
koreader progress/bookmarks) — registered as AnyJSONObject, not bodyless as
first drafted. Initialization returns the library sync payload, not the init
response.

Contract correction in update_rule.md: the route is SetRuleEnabled ({enabled}
required -> {collection_id, is_smart}); Beam's draft invented rule-field
updates. Reordered response/status: {item_ids} -> {status: reordered}.

make test 9/9.

2026-10-24 16:25:00 -04:00

1.2 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
GET	/api/sync/koreader/library	device-token	koreader

Get Library

Get library metadata for KOReader device.

Endpoint: GET /api/sync/koreader/library Auth: Required (Device authentication)

Device Authentication

This endpoint requires device authentication (not user JWT). Devices authenticate using their device credentials.

Request Headers

Header	Type	Required	Description
X-Device-ID	string	Yes	Device UUID
X-Device-Key	string	Yes	Device authentication key

Example Request

GET /api/sync/koreader/library
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
X-Device-Key: device-auth-key

Response (200 OK)

{
  "last_sync": null,
  "library_sync": null,
  "total_books": null
}

Error Responses

Code	Description
401	Device authentication failed
404	Device not found

1.2 KiB Raw Blame History