john-okeefe
4d321528b2
This commit updates all documentation files throughout the project: - Updated IMPLEMENTATION_PLAN.md with new implementation details - Updated PROJECT_GUIDELINES.md with coding standards and practices - Updated README.md with current project information - Updated SCREENSHOT_AUTOMATION.md with new automation details - Added TEST_DATA.md with test fixtures data - Updated cover_image_serving_plan.md with static URL patterns Documentation API updates: - Updated API reference documentation for all endpoints including: - Authentication (login, logout, register, refresh_token) - Book matching (auto_link, bulk_link, link_book, search) - Collections (CRUD operations, shelf mappings, auto-assign rules) - Conflicts (bulk operations, resolve/dismiss) - Devices (registration, approval, shelf management) - Highlights (create, update, delete, get) - Kobo sync (bookmark, markup, initialization, sync) - KOReader sync (library, metadata, bookmarks, progress) - Libraries (CRUD, folders, media items, stats) - Media items (bulk operations, CRUD) - Notes (CRUD operations) - OPDS (acquisition, feeds, publication) - Progress (reading progress tracking) - Queue (device queue management) - Ratings (star ratings) - Scanner (watch mode, scan operations) - Sync protocols (Kobo, KOReader) - Users (profile, password, admin operations) - WebSocket protocols - Updated user guides (admin, dashboard, settings, sync) - Updated device setup guides (Kobo, KOReader) - Updated developer guides (testing, contributing, operations) - Updated scripts/README.md
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
# OPDS Feeds
|
|
|
|
Bookhoard provides OPDS 1.2 feeds for device compatibility.
|
|
|
|
## Get Device Catalog
|
|
|
|
**Endpoint**: `GET /opds/devices/{deviceId}/catalog`
|
|
**Auth**: Device token required
|
|
|
|
### Query Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------- | -------- | -------------------------------------- |
|
|
| page | integer | No | Page number (default: 1) |
|
|
| per_page | integer | No | Items per page (default: 50, max: 200) |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /opds/devices/kobo-id/catalog?page=1&per_page=50
|
|
```
|
|
|
|
### Response (200 OK - OPDS 1.2 XML)
|
|
|
|
```xml
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<feed xmlns="http://www.w3.org/2005/Atom"
|
|
xmlns:opds="http://opds-spec.org/2010/"
|
|
xmlns:dc="http://purl.org/dc/elements/1.1/">
|
|
<id>urn:uuid:device-id</id>
|
|
<title>Bookhoard Library</title>
|
|
<updated>2026-02-01T12:00:00Z</updated>
|
|
|
|
<link rel="self" href="http://localhost:8765/opds/devices/kobo-id/catalog"/>
|
|
<link rel="search" href="http://localhost:8765/opds/devices/kobo-id/search"/>
|
|
<link rel="start" href="http://localhost:8765/opds/devices/kobo-id/nav"/>
|
|
|
|
<entry>
|
|
<id>urn:uuid:bookhoard-uuid-123</id>
|
|
<dc:title>The Hobbit</dc:title>
|
|
<dc:creator>J.R.R. Tolkien</dc:creator>
|
|
<updated>2026-02-01T10:00:00Z</updated>
|
|
|
|
<link href="http://localhost:8765/opds/devices/kobo-id/download/uuid-123"
|
|
type="application/epub+zip"
|
|
rel="http://opds-spec.org/acquisition/open-access"/>
|
|
|
|
<link href="http://localhost:8765/opds/devices/kobo-id/download/uuid-123?format=kepub"
|
|
type="application/vnd.kobo+xml+zip"
|
|
rel="alternate"/>
|
|
|
|
<dc:identifier id="bookhoard">uuid-123</dc:identifier>
|
|
<meta property="bookhoard:sha256">abc123...</meta>
|
|
</entry>
|
|
</feed>
|
|
```
|
|
|
|
## Search OPDS Catalog
|
|
|
|
**Endpoint**: `GET /opds/devices/{deviceId}/search`
|
|
**Auth**: Device token required
|
|
|
|
### Query Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------ | -------- | ------------ |
|
|
| q | string | Yes | Search query |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /opds/devices/kobo-id/search?q=Hobbit
|
|
```
|
|
|
|
### Response (200 OK - OPDS 1.2 XML with search results)
|
|
|
|
Returns OPDS feed with matching books.
|