john-okeefe
253f56399d
BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
# Create Shelf Mapping
|
|
|
|
Map a collection to a device shelf for syncing.
|
|
|
|
**Endpoint**: `POST /api/devices/{deviceId}/collections`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| deviceId | string (UUID) | Yes | Device UUID |
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| collection_id | string (UUID) | Yes | Collection UUID to map |
|
|
| device_shelf_name | string | Yes | Name of the shelf on the device |
|
|
| sync_direction | string | No | Sync direction (default: "bidirectional") |
|
|
|
|
### Sync Directions
|
|
|
|
| Direction | Description |
|
|
|-----------|-------------|
|
|
| bidirectional | Sync both ways between Bookhoard and device |
|
|
| book_to_hoard | Bookhoard → Device only |
|
|
| device_to_hoard | Device → Bookhoard only |
|
|
| none | No sync (mapping only for reference) |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"collection_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"device_shelf_name": "Sci-Fi",
|
|
"sync_direction": "bidirectional"
|
|
}
|
|
```
|
|
|
|
## Response (201 Created)
|
|
|
|
```json
|
|
{
|
|
"id": "990e8400-e29b-41d4-a716-446655440000",
|
|
"collection_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"collection_name": "Science Fiction",
|
|
"device_shelf_name": "Sci-Fi",
|
|
"sync_direction": "bidirectional",
|
|
"created_at": "2026-02-01T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Use Case
|
|
|
|
Collections can be synced to device-specific shelves (Kobo, KOReader). This allows automatic organization of books on your e-reader based on your Bookhoard collections.
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid request (validation failed) |
|
|
| 401 | Authentication required |
|
|
| 404 | Device or collection not found |
|
|
| 409 | Mapping already exists |
|
|
| 500 | Internal server error |
|
|
|
|
## Try It Out
|