John O'Keefe
ae9588f1c6
Beam backfilled auth core (login/register/refresh/logout/profile) and devices
core (list/update/delete/shelf CRUD/sidecar/register flow) with frontmatter,
provenance, and labeled examples. All claimed shapes verified against
handlers: AuthResponse {access_token, refresh_token omitempty, token_type,
expires_in, user}, update device {device_updated, device}, shelf wrappers,
DeviceAuthStatusResponse.
Claude registry verification: 15 entries pinned by type (LoginRequest,
RegisterRequest, AuthResponse, RefreshTokenRequest/Response, UserProfile,
DeviceListResponse, DeviceUpdateRequest, AddToShelfRequest, SidecarConfig,
DeviceRegistrationRequest/Response, DeviceAuthStatusRequest/Response).
Removed revoke_device.md — name-only duplicate of delete_device.md (same
DELETE /api/devices/:id route; was the last audit-orphan doc).
Gate catches this round (subtle Go serialization facts, now pinned in docs):
- uuid.UUID arrays never serialize as omitted: register/status response
ALWAYS carries device_id (all-zeros while pending) despite omitempty
- update device request binds device_name, not name
- register response includes device_id alongside registration_id
- list devices response is a {devices, total} wrapper
66 lines
1.4 KiB
Markdown
66 lines
1.4 KiB
Markdown
---
|
|
method: GET
|
|
path: /api/devices/:id/shelves
|
|
auth: jwt
|
|
area: devices
|
|
---
|
|
<!-- source: internal/handlers/media.go:301 MediaHandler.GetShelf -->
|
|
|
|
# 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 example-response
|
|
{
|
|
"status": "success",
|
|
"device_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"shelf_name": "",
|
|
"books": [
|
|
{
|
|
"id": "uuid",
|
|
"media_item_id": "uuid",
|
|
"title": "Book Title",
|
|
"author": "Author Name",
|
|
"file_path": "",
|
|
"mime_type": "",
|
|
"shelf_name": "",
|
|
"shelf_position": 0,
|
|
"revision_number": 0,
|
|
"added_at": "2026-02-08T10:00:00Z"
|
|
}
|
|
],
|
|
"total": 15
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ------------------------ |
|
|
| 401 | Invalid or expired token |
|
|
| 404 | Device not found |
|