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.
54 lines
1.7 KiB
YAML
54 lines
1.7 KiB
YAML
info:
|
|
name: Sync from Bookhoard to Kobo
|
|
type: http
|
|
seq: 1
|
|
http:
|
|
method: POST
|
|
url: '{{base_url}}/api/sync/kobo/{{kobo_device_token}}/sync-from-server'
|
|
auth: inherit
|
|
body:
|
|
type: json
|
|
jsonBody: "[\n {\n \"ContentId\": \"{{bookUUID"
|
|
headers:
|
|
- key: Authorization
|
|
value: Bearer {{koboToken
|
|
|
|
docs: |-
|
|
## Sync from Bookhoard to Kobo
|
|
|
|
Server-initiated sync pushing progress, bookmarks, and highlights from Bookhoard to Kobo device. Two-way sync endpoint.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/sync/kobo/sync-from-server
|
|
|
|
**Authentication:** Bearer token with Kobo device identification
|
|
|
|
**Headers:**
|
|
- `x-kobo-device` (string): JSON string containing Kobo device info
|
|
- `DeviceId`: Kobo device ID
|
|
- `Model`: Kobo device model
|
|
- `SerialNumber`: Kobo device serial number
|
|
|
|
**Request Body:** Array of sync data objects
|
|
- `ContentId` (string): Book UUID
|
|
- `PercentRead` (number): Reading progress percentage (0-100)
|
|
- `LastModified` (string): ISO 8601 timestamp
|
|
- `Bookmarks` (array, optional): Array of bookmark objects
|
|
- `BookmarkId`: Unique bookmark ID
|
|
- `ContentId`: Book UUID
|
|
- `BookmarkText`: Bookmark text/note
|
|
- `BookmarkType`: Type (bookmark, annotation, etc.)
|
|
- `BookmarkTitle`: Bookmark title
|
|
- `Highlights` (array, optional): Array of highlight objects (same structure as bookmarks)
|
|
|
|
**Response:**
|
|
- Sync result confirmation
|
|
|
|
**Status Codes:**
|
|
- 200: Success
|
|
- 401: Unauthorized
|
|
- 500: Internal server error
|
|
|
|
**Note:** Allows Bookhoard server to push updates to Kobo device, including reading progress, bookmarks, and highlights.
|