Files
bookhoard/docs/developer/api/opds/publication.md
T
John O'Keefe 7a7b2ab82a docs(highlights,notes,opds,progress,analytics): Beam batch 9 — 13 endpoints
Highlights + notes CRUD (media-item scoped, jwt), progress delete,
reading-stats analytics, and the OPDS trio frontmatter'd. OPDS docs are
the first XML entries: example-response intentionally omitted (Atom
responses), gate contract honored via nil-Response registry pins.

Gate fix: group .Use() middleware now parsed (opds.Use(DeviceAuth...
Authenticate) previously resolved to auth 'none'). Registry: 13 entries.
Drift fixed by gate: reading-stats key names (total_reading_time_minutes,
most_active_day_of_week, daily_reading_minutes — draft invented
reading_time_hours/books_completed); notes/highlights list endpoints
return BARE arrays (no {notes:[]}/{highlights:[]} wrapper); create-note
request has no percentage_location/epubcfi_location. New
/tmp/merge_arrays.py handles array-example merges.

make test 9/9.
2026-10-24 17:47:07 -04:00

1.2 KiB

method, path, auth, area
method path auth area
GET /opds/devices/:deviceId/cover/:bookId device-token opds

OPDS Publication

OPDS navigation and publication feeds.

Navigation Feed

Endpoint: GET /opds/devices/{deviceId}/nav Auth: Device token required

Example Request

GET /opds/devices/kobo-id/nav

Response (200 OK - OPDS 1.2 Navigation XML)

Returns OPDS navigation feed with links to:

  • Root catalog
  • Search
  • Collections/shelves
  • Filtered views (by author, series, etc.)

Publication Feeds by Collection

Endpoint: GET /opds/devices/{deviceId}/collections/{collectionId} Auth: Device token required

Example Request

GET /opds/devices/kobo-id/collections/collection-uuid

Response (200 OK - OPDS 1.2 XML)

Returns OPDS feed with books in the specified collection.

Publication Feeds by Shelf

Endpoint: GET /opds/devices/{deviceId}/shelves/{shelfName} Auth: Device token required

Example Request

GET /opds/devices/kobo-id/shelves/Favorites

Response (200 OK - OPDS 1.2 XML)

Returns OPDS feed with books on the specified device shelf.