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.
This commit is contained in:
John O'Keefe committed 2026-10-24 16:25:00 -04:00
1 parent b77eab7ffd
commit 25ef0d12ba
13 files changed
+268 -57

No files matched your search

+12 -11
View File
@@ -1,3 +1,11 @@
---
method: GET
path: /api/sync/koreader/library
auth: device-token
area: koreader
---
<!-- source: internal/handlers/koreader.go:1391 KOReaderHandler.GetLibrary -->
# Get Library
Get library metadata for KOReader device.
@@ -26,18 +34,11 @@ X-Device-Key: device-auth-key
## Response (200 OK)
```json
```json example-response
{
"books": [
{
"id": "uuid",
"title": "Book Title",
"authors": ["Author Name"],
"file": "book.epub",
"size": 1234567
}
],
"total": 42
"last_sync": null,
"library_sync": null,
"total_books": null
}
```
+9 -1
View File
@@ -1,3 +1,11 @@
---
method: GET
path: /api/sync/koreader/metadata/:uuid
auth: device-token
area: koreader
---
<!-- source: internal/handlers/koreader.go:1025 KOReaderHandler.GetMetadata -->
# Get Metadata
Get a book's stored progress and annotations for a KOReader device —
@@ -23,7 +31,7 @@ Authorization: Bearer {device_token}
## Response (200 OK)
```json
```json example-response
{
"uuid": "774641f9-317b-4087-8e04-53bb4392ae56",
"title": "1984",
+12 -6
View File
@@ -1,4 +1,13 @@
# Resolve Book
---
method: GET
path: /api/sync/koreader/resolve
auth: device-token
area: koreader
---
<!-- source: internal/handlers/koreader.go:1002 KOReaderHandler.ResolveBook -->
# Resolve Book:<|end|><|start|> assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
/home/nymusicman/Code/bookhoard/docs/developer/api/koreader/sync_bookmarks.md
Map a book's file SHA-256 to its Bookhoard UUID without touching progress
state. Used by devices to link a freshly downloaded book before their first
@@ -32,12 +41,9 @@ Authorization: Bearer {device_token}
## Response (200 OK)
```json
```json example-response
{
"book_uuid": "550e8400-e29b-41d4-a716-446655440000",
"sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"title": "Book Title",
"author": "Author Name"
"book_uuid": "550e8400-e29b-41d4-a716-446655440000"
}
```
+10 -2
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/sync/koreader/bookmarks
auth: device-token
area: koreader
---
<!-- source: internal/handlers/koreader.go:1456 KOReaderHandler.SyncBookmarks -->
# Sync Bookmarks
Sync bookmarks, notes, and highlights from a KOReader device (bidirectional — the response also returns the server's current state for the book so the device can reconcile).
@@ -52,7 +60,7 @@ KOReader paints highlights from a fixed palette of color names; the web reader u
### Example Request
```json
```json example-request
{
"book_sha256": "64-hex-char-sha256",
"bookmarks": [
@@ -83,7 +91,7 @@ KOReader paints highlights from a fixed palette of color names; the web reader u
## Response (200 OK)
```json
```json example-response
{
"sync_status": "ok",
"bookmarks_synced": 1,
+12 -3
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/sync/koreader/progress
auth: device-token
area: koreader
---
<!-- source: internal/handlers/koreader.go:418 KOReaderHandler.SyncProgress -->
# Sync Progress
Push reading progress from a KOReader device.
@@ -42,7 +50,7 @@ Authorization: Bearer {device_token}
Content-Type: application/json
```
```json
```json example-request
{
"books": [
{
@@ -67,11 +75,12 @@ Content-Type: application/json
## Response (202 Accepted)
```json
```json example-response
{
"sync_status": "ok",
"books_synced": 1,
"timestamp": "2026-09-26T21:25:09Z"
"timestamp": "2026-09-26T21:25:09Z",
"device_updated": null
}
```