John O'Keefe
18084de7a6
WO3 sync internals resolved: the book-matching docs ARE the sync surface
(books/query, link-book, bulk/auto-link, unlinked-books, suggestions,
file-alias CRUD) + collections rule/test/bulk-assign/shelf-mapping
surface.
Dedupe resolved (Claude call): search_books.md declared
GET /api/books/match but its BODY documents POST /api/sync/books/query —
both routes exist and are distinct (query-param device protocol vs JSON
body plugin protocol). Repointed search_books.md frontmatter to the POST
route; get_book_matches.md keeps the GET.
Claude registry: 15 entries (one pre-existing link-book entry deduped).
Drift fixed by gate: auto-link request {confidence_threshold, limit} not
{device_id, threshold}; bulk-link link objects {unlinked_book_id,
media_item_id, confidence_score} not {device_id, book_id, ...};
responses {results,total,successful,failed}/{auto_linked,results}; added
missing example-responses (bare delete, remove-rule is_smart-after
semantics, bulk-assign per-book results). make test 9/9.
78 lines
2.4 KiB
Markdown
78 lines
2.4 KiB
Markdown
---
|
|
method: POST
|
|
path: /api/devices/:id/collections
|
|
auth: jwt
|
|
area: collections
|
|
---
|
|
<!-- source: internal/handlers/collections.go:686 CollectionHandler.CreateDeviceMapping -->
|
|
|
|
# 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 example-request
|
|
{
|
|
"collection_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"device_shelf_name": "Sci-Fi",
|
|
"sync_direction": "bidirectional"
|
|
}
|
|
```
|
|
|
|
## Response (201 Created)
|
|
|
|
```json example-response
|
|
{
|
|
"id": "990e8400-e29b-41d4-a716-446655440000",
|
|
"collection_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"device_shelf_name": "Sci-Fi",
|
|
"sync_direction": "bidirectional",
|
|
"created_at": "2026-02-01T10:00:00Z",
|
|
"device_id": null
|
|
}
|
|
```
|
|
|
|
## 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
|