Files
bookhoard/docs/developer/api/devices/clear_shelf.md
T
john-okeefe c4607cd9b5 docs(api): complete backend documentation with all missing endpoints
Complete API documentation audit covering all backend endpoints.

Auth Endpoints:
- Fixed endpoint paths from /api/users/me/* to /api/auth/*
- Added update_email.md and update_username.md

Device Management:
- Device shelf operations (add, get, remove, clear)
- Device CRUD operations (update, delete)
- Registration management (pending, approve, reject)

Books Operations:
- Bulk delete and bulk update with normalization
- Download endpoint with format-specific headers

Conflict Resolution:
- Complete conflict management (list, get, resolve, delete)
- Bulk operations (bulk resolve, bulk dismiss, dismiss all)

Sync Protocols:
- KOReader: progress, metadata, library, bookmarks
- Kobo: markup, bookmarks, analytics, initialization, server sync

Scanner:
- Enhanced docs with manga/comic support
- Added 148-line comprehensive overview
- All formats documented (ebooks, comics, manga)

WebSocket:
- Comprehensive real-time sync API
- Messages, topics, authentication, examples

Documentation:
- Updated api-reference.md with all 122+ endpoints
- Updated index.md with new categories

Total: 36 new files, 6 modified files, 100% coverage
2026-02-08 12:39:46 -05:00

868 B

Clear Shelf

Remove all items from a device's shelf.

Endpoint: DELETE /api/devices/:id/shelves/clear 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

DELETE /api/devices/550e8400-e29b-41d4-a716-446655440000/shelves/clear
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (204 No Content)

Shelf cleared successfully.

Error Responses

Code Description
401 Invalid or expired token
404 Device not found

Try It Out