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
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# Download Media Item
|
|
|
|
Download a media item file (EPUB, PDF, etc.) from the Bookhoard server.
|
|
|
|
**Endpoint**: `GET /api/media-items/:uuid/download`
|
|
**Auth**: None (public endpoint for Kobo devices)
|
|
**Content-Type**: Binary file download
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------ | -------- | --------------- |
|
|
| uuid | string | Yes | Media item UUID |
|
|
|
|
## Response
|
|
|
|
**Success (200 OK)**: Binary file data
|
|
|
|
**Response Headers**:
|
|
|
|
- `Content-Type`: `application/epub+zip`, `application/pdf`, or appropriate MIME type
|
|
- `Content-Disposition`: `attachment; filename="filename.epub"`
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | --------------------------------- |
|
|
| 404 | Media item not found |
|
|
| 500 | Server error during file download |
|
|
|
|
## Example
|
|
|
|
```bash
|
|
curl -O http://localhost:8765/api/media-items/550e8400-e29b-41d4-a716-446655440000/download
|
|
```
|
|
|
|
## Notes
|
|
|
|
- **Public endpoint**: No authentication required for Kobo device downloads
|
|
- **File format**: Returns the original file format (EPUB, PDF, etc.)
|
|
- **Kobo integration**: Designed for direct downloads from Kobo e-readers
|
|
- **Cover images**: Use `/api/media-items/:uuid/cover` for cover images
|