bookhoard

Files

T

john-okeefe ed71ee5c99 docs(api): add comprehensive Collections API documentation

Create detailed API reference for collection management endpoints:

Sections Included:
- Overview of collections feature
- All CRUD endpoints (Create, Read, Update, Delete, List)
- Book management endpoints (Add, Remove, Bulk Remove, List)
- Rule testing endpoint (Test rules before saving)
- Device shelf mapping endpoints
- Error response documentation
- Rate limiting information
- Bruno test collection references

Detailed Documentation:
- Request/response examples with actual JSON
- Path parameter descriptions
- Query parameter documentation
- Request body field specifications
- Supported rule fields and operators
- Sync direction options for shelf mappings
- Complete error response formats

Special Features Documented:
- Auto-assign rules with priority
- Per-device view settings
- Collection to shelf mapping
- Bulk operations efficiency
- Rule testing for preview
- Case-insensitive matching
- Numeric comparisons for years

API Endpoints Covered:
- GET /api/collections - List all collections
- POST /api/collections - Create collection
- GET /api/collections/{id} - Get collection details
- PUT /api/collections/{id} - Update collection
- DELETE /api/collections/{id} - Delete collection
- POST /api/collections/{id}/books - Add books
- DELETE /api/collections/{id}/books/{bookId} - Remove book
- POST /api/collections/{id}/books/bulk-remove - Bulk remove
- GET /api/collections/{id}/books - List collection books
- POST /api/collections/test-rules - Test rules
- GET /api/devices/{deviceId}/collections - Get shelf mappings
- POST /api/devices/{deviceId}/collections - Create mapping
- PUT /api/devices/{deviceId}/collections/{collectionId} - Update mapping
- DELETE /api/devices/{deviceId}/collections/{collectionId} - Delete mapping

This documentation enables developers to:
- Integrate collection management into third-party apps
- Build custom collection UIs
- Automate collection organization
- Integrate with mobile apps

Format: Markdown with code examples
Version: 1.0
Date: 2026-02-01

2026-02-01 01:02:31 -05:00

Code/bookmann

docs/Code/bookmann/IMPLEMENTATION_PLAN.md: Add comprehensive implementation plan

2026-01-31 18:00:28 -05:00

devices

docs(devices): add comprehensive OPDS wireless delivery documentation

2026-02-01 01:02:09 -05:00

API_REFERENCE.md

docs: add implementation plan and update documentation

2026-01-31 18:25:27 -05:00

COLLECTIONS_API.md

docs(api): add comprehensive Collections API documentation