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.
52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
# Get Metadata
|
|
|
|
Get metadata for a book from KOReader device.
|
|
|
|
**Endpoint**: `GET /api/sync/koreader/metadata/:uuid`
|
|
**Auth**: Required (Device authentication)
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| uuid | string (UUID) | Yes | Book UUID |
|
|
|
|
## Device Authentication
|
|
|
|
This endpoint requires device authentication (not user JWT). Devices authenticate using their device credentials.
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| X-Device-ID | string | Yes | Device UUID |
|
|
| X-Device-Key | string | Yes | Device authentication key |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/sync/koreader/metadata/550e8400-e29b-41d4-a716-446655440000
|
|
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
|
|
X-Device-Key: device-auth-key
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"id": "uuid",
|
|
"title": "Book Title",
|
|
"authors": ["Author Name"],
|
|
"path": "/path/to/book.epub",
|
|
"file_size": 1234567,
|
|
"modified_at": "2026-02-08T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 401 | Device authentication failed |
|
|
| 404 | Book or device not found |
|