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.
957 B
957 B
Add to Shelf
Add a media item to a device's shelf (Kobo reading shelf).
Endpoint: POST /api/devices/:id/shelves
Auth: Required
Content-Type: application/json
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Yes | Device UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| media_item_id | string (UUID) | Yes | Media item UUID to add to shelf |
Example Request
{
"media_item_id": "550e8400-e29b-41d4-a716-446655440001"
}
Response (201 Created)
{
"message": "Item added to shelf successfully",
"device_id": "uuid",
"media_item_id": "uuid"
}
Error Responses
| Code | Description |
|---|---|
| 400 | Invalid request data |
| 401 | Invalid or expired token |
| 404 | Device or media item not found |
| 409 | Item already on shelf |