John O'Keefe
25ef0d12ba
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.
57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
---
|
|
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
|
|
pull, so the device's first-page position is never pushed (which would
|
|
conflict with server-side progress for books already mid-read).
|
|
|
|
**Endpoint**: `GET /api/sync/koreader/resolve`
|
|
**Auth**: Required (Device authentication)
|
|
|
|
## Query Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------ | -------- | ------------------------------------ |
|
|
| sha256 | string | Yes | File content hash (64 hex characters) |
|
|
|
|
Resolution is format-aware: the hash is checked against both
|
|
`media_items.file_sha256` and `media_item_formats.file_sha256`, so a
|
|
converted file (KEPUB/PDF) matches its media item too.
|
|
|
|
## Device Authentication
|
|
|
|
This endpoint requires device authentication (not user JWT). Devices
|
|
authenticate using their device credentials.
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/sync/koreader/resolve?sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
|
|
Authorization: Bearer {device_token}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json example-response
|
|
{
|
|
"book_uuid": "550e8400-e29b-41d4-a716-446655440000"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | -------------------------------------------- |
|
|
| 400 | Missing or malformed `sha256` parameter |
|
|
| 401 | Device authentication failed |
|
|
| 404 | No book in the library matches the given hash |
|