john-okeefe
b44e4e4709
Clean up API documentation files by removing Phase X references: Remove 'API Explorer will be inserted here in Phase X' placeholders from: - 70+ API endpoint documentation files - Authentication endpoints (login, logout, register, refresh) - User endpoints (profile, settings, password) - Device endpoints (registration, sync, shelves) - Library endpoints (CRUD, folders, visibility) - Media endpoints (items, progress, highlights, notes) - Admin endpoints (users, analytics) - Sync endpoints (Kobo, KOReader) - OPDS endpoints - Scanner endpoints - Queue endpoints These placeholders were from planning documents and have no meaning to API consumers. The documentation is now clean and ready for use.
53 lines
1.0 KiB
Markdown
53 lines
1.0 KiB
Markdown
# OPDS Publication
|
|
|
|
OPDS navigation and publication feeds.
|
|
|
|
## Navigation Feed
|
|
|
|
**Endpoint**: `GET /opds/devices/{deviceId}/nav`
|
|
**Auth**: Device token required
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
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
|
|
|
|
```http
|
|
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
|
|
|
|
```http
|
|
GET /opds/devices/kobo-id/shelves/Favorites
|
|
```
|
|
|
|
### Response (200 OK - OPDS 1.2 XML)
|
|
|
|
Returns OPDS feed with books on the specified device shelf.
|