0 Fork 0

Files

T

John O'Keefe ae9588f1c6 docs(auth,devices): Beam WO5 batch 3 — 15 endpoints backfilled, registry pinned

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

2026-10-24 15:48:18 -04:00

1.5 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/devices/:id/shelves	jwt	devices

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_ids	array of string	Yes	Media item UUIDs to add to shelf
shelf_name	string	No	Shelf name (default "Default")
shelf_position	int	No	Starting shelf position

Example Request

{
  "media_item_ids": ["550e8400-e29b-41d4-a716-446655440001"],
  "shelf_name": "Default",
  "shelf_position": 0
}

Response (200 OK)

{
  "status": "success",
  "added_count": 1,
  "shelf_name": "Default",
  "total_count": 1
}

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

1.5 KiB Raw Blame History