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.
82 lines
2.4 KiB
YAML
82 lines
2.4 KiB
YAML
info:
|
|
name: Get Kobo Library
|
|
type: http
|
|
seq: 6
|
|
|
|
http:
|
|
method: GET
|
|
url: '{{base_url}}/api/sync/kobo/{{kobo_device_token}}/v1/initialization'
|
|
auth: inherit
|
|
|
|
docs: |-
|
|
## Get Kobo Library
|
|
|
|
Retrieves the user's Kobo library metadata for device sync.
|
|
|
|
**Method:** GET
|
|
|
|
**Endpoint:** /api/sync/kobo/library
|
|
|
|
**Authentication:** Bearer token
|
|
|
|
**Query Parameters:**
|
|
None (returns entire library)
|
|
|
|
**Response:**
|
|
- `books` (array): Library items
|
|
- `ContentId` (string): Unique book identifier
|
|
- `Title` (string): Book title
|
|
- `Author` (string): Author name
|
|
- `Publisher` (string): Publisher name
|
|
- `Description` (string): Book description
|
|
- `ISBN` (string, optional): ISBN-13
|
|
- `PublicationDate` (string): Release date
|
|
- `EntitlementId` (string): Kobo entitlement ID
|
|
- `CrossRevisionId` (string): Revision identifier
|
|
- `MimeType` (string): Content type (application/epub+zip)
|
|
- `FileSize` (integer): File size in bytes
|
|
- `CoverImageId` (string): Cover image identifier
|
|
- `DownloadUrls` (object): Download URLs
|
|
- `download_url` (string): Direct download link
|
|
- `download_acquisition_url` (string): OPDS acquisition URL
|
|
- `sync_metadata` (object):
|
|
- `last_sync` (string): Last library sync timestamp
|
|
- `total_books` (integer): Total book count
|
|
- `has_updates` (boolean): Whether updates are available
|
|
|
|
**Status Codes:**
|
|
- 200: Success
|
|
- 401: Unauthorized
|
|
- 403: Device not approved
|
|
|
|
**Library Sync Purpose:**
|
|
- Kobo device needs to know available books
|
|
- Enables download via device browser
|
|
- Provides metadata for device display
|
|
- Supports Kobo's "My Books" feature
|
|
- Enables on-device purchasing integration
|
|
|
|
**Kobo Device Usage:**
|
|
- Device fetches library on registration
|
|
- Refreshed daily or on manual sync
|
|
- User can browse library on device
|
|
- Books downloaded wirelessly to device
|
|
- Supports "Buy on Kobo, read on device" workflow
|
|
|
|
**Authentication Methods:**
|
|
This endpoint uses **Bearer token authentication** (token in Authorization header).
|
|
Alternative: Use `/sync/kobo/{token}/library` with token in URL path.
|
|
|
|
**Performance:**
|
|
- Typical response: 50-200KB for 100 books
|
|
- Processing time: 200-800ms
|
|
- Cache duration: 5 minutes
|
|
- Pagination available for large libraries (>500 books)
|
|
|
|
**Use Cases:**
|
|
- Initial device registration
|
|
- Library refresh on device
|
|
- Book discovery on device
|
|
- Download link generation
|
|
- Metadata sync for OPDS
|