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
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
# Get Media Item
|
|
|
|
Retrieve details of a specific media item.
|
|
|
|
**Endpoint**: `GET /api/media-items/{media_id}`
|
|
**Auth**: Required
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------ | -------- | --------------- |
|
|
| media_id | string | Yes | Media item UUID |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
| ------------- | ------ | -------- | ------------ |
|
|
| Authorization | string | Yes | Bearer token |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/media-items/uuid-here
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"id": "uuid",
|
|
"library_id": "uuid",
|
|
"title": "Book Title",
|
|
"author": "Author Name",
|
|
"description": "Book description",
|
|
"file_path": "/path/to/book.epub",
|
|
"file_size": 1024000,
|
|
"mime_type": "application/epub+zip",
|
|
"cover_image_path": "/path/to/cover.jpg",
|
|
"series": "Series Name",
|
|
"series_number": 1,
|
|
"tags": ["sci-fi", "space opera"],
|
|
"tags_search": ["sci fi", "space opera"],
|
|
"contributors": ["Author Name", "ACME CORP."],
|
|
"contributors_search": ["author name", "acme corp"],
|
|
"language": "en",
|
|
"page_count": 350,
|
|
"genre": "Science Fiction",
|
|
"copyright_year": 2023,
|
|
"created_at": "2026-01-31T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | -------------------------------------------- |
|
|
| 401 | Invalid or expired token |
|
|
| 403 | User does not have access to this media item |
|
|
| 404 | Media item not found |
|