John O'Keefe
a85bc8af9b
Audited every request (247 .yml files) against the routes the server
actually registers (extracted from internal/router, group prefixes
resolved). Results:
- 44 stale requests: deleted where the endpoint no longer exists
(universal-progress GET/PUT /api/progress/:id — routes never existed,
the handlers were deleted in H1; queue stats/clear-failed/process;
admin profile page; auth/account) and FIXED where the endpoint exists
under a different path (kobo token-in-path scheme: every
/api/sync/kobo/<seg> and /api/v1/kobo/<seg> URL now carries
{{kobo_device_token}}; /sync/* missing their /api prefix; koreader
/api/v1/koreader/sync/* -> /api/sync/koreader/*; link-book and
unlinked-books moved to /api/devices/:id/sync/*).
- koreader Sync Highlights/Sync Notes pointed at endpoints that never
existed with a body shape to match — rewritten against POST
/api/sync/koreader/bookmarks (the annotations funnel carries
highlights and notes arrays).
- 9 files the GUI refused to load: 4 had bruno-invalid script type
"tests" (converted to after-response), 4 were info/type:collection
doc files with bogus http blocks (converted to folder.yml folder
docs), 1 had a dead pre-YAML schema and no route (deleted).
- devices/koreader requests now carry request-level bearer auth
({{koreader_device_token}}) — they inherited the collection's user-JWT
bearer, which device endpoints rightly reject — and their bodies
reference {{media_item_id}} instead of dead placeholder uuids.
- environments: opds_base_url was empty (every OPDS request missed the
/opds prefix); set to http://localhost:8765/opds and un-doubled the
prefix in opds/scenarios.
Known limitation, for the handoff: bru CLI cannot execute .yml request
bodies (the collection is GUI OpenCollection format; the CLI runner
reads bodies from .bru files only). A .bru migration is the remaining
bruno work if CLI runs are wanted.
92 lines
2.6 KiB
YAML
92 lines
2.6 KiB
YAML
info:
|
|
name: Sync Multiple Books Progress
|
|
type: http
|
|
seq: 3
|
|
|
|
http:
|
|
method: POST
|
|
url: '{{base_url}}/api/sync/kobo/{{kobo_device_token}}/markup'
|
|
auth: inherit
|
|
headers:
|
|
- key: Content-Type
|
|
value: application/json
|
|
- key: x-kobo-device
|
|
value: '{"DeviceId":"{{kobo_device_id}}","Model":"Kobo Aura"}'
|
|
body:
|
|
type: json
|
|
json:
|
|
ReadingSync:
|
|
- ContentId: book-1-uuid
|
|
PercentRead: 25.0
|
|
EntitlementId: entitlement-1
|
|
RemainingTimeMinutes: 240
|
|
FirstReadTime: '2026-01-25T10:00:00Z'
|
|
LastModified: '2026-01-30T18:00:00Z'
|
|
- ContentId: book-2-uuid
|
|
PercentRead: 78.5
|
|
EntitlementId: entitlement-2
|
|
RemainingTimeMinutes: 45
|
|
FirstReadTime: '2026-01-25T14:00:00Z'
|
|
LastModified: '2026-01-30T20:00:00Z'
|
|
BookmarkSync: []
|
|
|
|
docs: |-
|
|
## Sync Multiple Books Progress
|
|
|
|
Synchronizes reading progress for multiple books in a single request.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/sync/kobo/markup
|
|
|
|
**Authentication:** Bearer token
|
|
|
|
**Headers:**
|
|
- `Authorization`: Bearer {{kobo_device_token}}
|
|
- `x-kobo-device`: Device information (Model: "Kobo Aura")
|
|
|
|
**Request Body:**
|
|
- `ReadingSync` (array): Multiple progress items
|
|
- Each item contains: ContentId, PercentRead, EntitlementId, etc.
|
|
- `BookmarkSync` (array): Empty for progress-only batch
|
|
|
|
**Response:**
|
|
- `total` (integer): Total items in request
|
|
- `synced` (integer): Successfully synced
|
|
- `failed` (integer): Failed items
|
|
- `results` (array): Per-item results
|
|
- `ContentId` (string): Book UUID
|
|
- `status` (string): `synced`, `failed`, `skipped`
|
|
- `error` (string, optional): Error message if failed
|
|
|
|
**Status Codes:**
|
|
- 200: Batch sync completed
|
|
- 207: Multi-status (some succeeded, some failed)
|
|
- 401: Unauthorized
|
|
- 413: Payload too large (>1MB)
|
|
|
|
**Batch Sync Advantages:**
|
|
- Efficient sync of entire library
|
|
- Reduces HTTP overhead
|
|
- Faster for devices with many books
|
|
- Atomic operation (all or nothing by default)
|
|
|
|
**Kobo Batch Sync Behavior:**
|
|
- Triggered when device connects after being offline
|
|
- Occurs during manual "Sync now" operation
|
|
- Limited to 100 books per request
|
|
- Progress updates shown on device
|
|
- Failed items retried individually
|
|
|
|
**Performance:**
|
|
- Typical batch: 10-50 books in 1-3 seconds
|
|
- Large batch: 50-100 books in 3-8 seconds
|
|
- Timeout: 30 seconds
|
|
- Rate limit: 10 batches per minute per device
|
|
|
|
**Use Cases:**
|
|
- Initial device sync after registration
|
|
- Catch-up sync after extended offline period
|
|
- Library-wide progress update
|
|
- Pre-sync before device firmware update
|