john-okeefe
5f268238c8
- Update api-reference.md with new endpoint paths - Update api-reference.md Books API section → Media Items API section - Update index.md Books API link → Media Items API - Update get_shelf.md cover_url reference from /api/books/ to /api/media-items/
55 lines
1.0 KiB
Markdown
55 lines
1.0 KiB
Markdown
# Get Shelf
|
|
|
|
Get all items on a device's shelf.
|
|
|
|
**Endpoint**: `GET /api/devices/:id/shelves`
|
|
**Auth**: Required
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| id | string (UUID) | Yes | Device UUID |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| Authorization | string | Yes | Bearer token |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/devices/550e8400-e29b-41d4-a716-446655440000/shelves
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"items": [
|
|
{
|
|
"id": "uuid",
|
|
"media_item_id": "uuid",
|
|
"title": "Book Title",
|
|
"authors": ["Author Name"],
|
|
"cover_url": "/api/media-items/uuid/cover",
|
|
"added_at": "2026-02-08T10:00:00Z"
|
|
}
|
|
],
|
|
"total": 15
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 401 | Invalid or expired token |
|
|
| 404 | Device not found |
|
|
|
|
## Try It Out
|
|
|
|
<!-- API Explorer will be inserted here in Phase 3 -->
|