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.
107 lines
2.9 KiB
YAML
107 lines
2.9 KiB
YAML
info:
|
|
name: Sync with Annotations
|
|
type: http
|
|
seq: 4
|
|
|
|
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 Libra"}'
|
|
body:
|
|
type: json
|
|
json:
|
|
ReadingSync:
|
|
- ContentId: book-uuid
|
|
PercentRead: 55.0
|
|
EntitlementId: entitlement-id
|
|
RemainingTimeMinutes: 120
|
|
FirstReadTime: '2026-01-25T10:00:00Z'
|
|
LastModified: '2026-01-30T20:00:00Z'
|
|
BookmarkSync:
|
|
- ContentId: book-uuid
|
|
BookmarkText: Important quote
|
|
BookmarkType: annotation
|
|
BookmarkTitle: Chapter 4 - The Truth
|
|
- ContentId: book-uuid
|
|
BookmarkText: Another quote
|
|
BookmarkType: annotation
|
|
BookmarkTitle: Chapter 5
|
|
- ContentId: book-uuid
|
|
BookmarkText: Note to myself
|
|
BookmarkType: note
|
|
BookmarkTitle: Personal note
|
|
|
|
docs: |-
|
|
## Sync with Multiple Annotations
|
|
|
|
Synchronizes reading progress with multiple highlights and notes.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/sync/kobo/markup
|
|
|
|
**Authentication:** Bearer token
|
|
|
|
**Headers:**
|
|
- `Authorization`: Bearer {{kobo_device_token}}
|
|
- `x-kobo-device`: Device info (Model: "Kobo Libra")
|
|
|
|
**Request Body:**
|
|
- `ReadingSync` (array): Single book progress
|
|
- `BookmarkSync` (array): Multiple annotations
|
|
- Can include highlights (annotation type)
|
|
- Can include notes (note type)
|
|
- Each has: ContentId, BookmarkText, BookmarkType, BookmarkTitle
|
|
|
|
**Response:**
|
|
- `progress_synced` (boolean): Progress update status
|
|
- `annotations_synced` (integer): Number of annotations synced
|
|
- `highlights_count` (integer): Highlights synced
|
|
- `notes_count` (integer): Notes synced
|
|
- `conflicts` (array): Any annotation conflicts resolved
|
|
- `timestamp` (string): Sync completion time
|
|
|
|
**Status Codes:**
|
|
- 200: Successful sync
|
|
- 401: Unauthorized
|
|
- 400: Invalid annotation data
|
|
|
|
**Kobo Annotation Types:**
|
|
- **Highlights:** Selected text passages
|
|
- 5 preset colors available
|
|
- Can have chapter titles
|
|
- Exportable to PDF/Mobile
|
|
- **Notes:** Personal annotations
|
|
- Free-form text
|
|
- Can be attached to highlights
|
|
- Separate from highlights
|
|
- **Bookmarks:** Location markers
|
|
- Chapter positions
|
|
- Quick navigation
|
|
|
|
**Sync Behavior:**
|
|
- Duplicates detected by content matching
|
|
- Most recent edit wins conflicts
|
|
- Annotations linked to book content
|
|
- Chapter references preserved
|
|
- Order maintained from device
|
|
|
|
**Kobo Notebook Export:**
|
|
- All annotations appear in Kobo "Notebook"
|
|
- Can be exported to PDF
|
|
- Can be exported to Mobile (text)
|
|
- Organized by book
|
|
- Shows highlight context
|
|
|
|
**Use Cases:**
|
|
- Study and research
|
|
- Book club discussion prep
|
|
- Content review
|
|
- Sharing insights
|
|
- Personal learning archive
|