diff --git a/docs/developer/api-reference.md b/docs/developer/api-reference.md index 046cd43..916bf11 100644 --- a/docs/developer/api-reference.md +++ b/docs/developer/api-reference.md @@ -986,25 +986,39 @@ GET /opds/devices/{deviceId}/catalog?page={page}&per_page={per_page} - `page` (optional): Page number (default: 1) - `per_page` (optional): Items per page (default: 50, max: 200) +The feed is paginated via standard OPDS link relations. Clients (e.g. KOReader) +walk pages by following the `rel="next"` link until it is absent. OpenSearch +paging metadata (`totalResults`, `itemsPerPage`, `startIndex`) is also included. + **Response** (200 - OPDS 1.2 XML): ```xml + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"> urn:uuid:device-id Bookhoard Library 2026-02-01T12:00:00Z - - - + + + + + + + + + 1814 + 50 + 51 urn:uuid:bookhoard-uuid-123 - The Hobbit - J.R.R. Tolkien + The Hobbit + J.R.R. Tolkien 2026-02-01T10:00:00Z + + Bookhoard + Search the Bookhoard library + UTF-8 + UTF-8 + + +``` + +When called **with** a `q` parameter, **Response** (200 - OPDS 1.2 XML with +search results, including `opensearch:totalResults`). ### List Available Formats