john-okeefe
253f56399d
BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
57 lines
1.1 KiB
Markdown
57 lines
1.1 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.
|
|
|
|
## Try It Out
|
|
|
|
<!-- API Explorer will be inserted here in Phase 3 -->
|