docs(book-matching,collections): Beam batch 10 — 15 endpoints

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.
This commit is contained in:
John O'Keefe committed 2026-10-24 17:59:27 -04:00
1 parent 7a7b2ab82a
commit 18084de7a6
16 files changed
+334 -72

No files matched your search

@@ -1,3 +1,11 @@
---
method: POST
path: /api/collections/:id/rules
auth: jwt
area: collections
---
<!-- source: internal/handlers/collections.go:877 CollectionHandler.AddRule -->
# Add Auto-Assign Rule
Add an automatic book assignment rule to a collection.
@@ -49,7 +57,7 @@ Add an automatic book assignment rule to a collection.
### Example Request
```json
```json example-request
{
"field": "genre",
"operator": "equals",
@@ -61,15 +69,11 @@ Add an automatic book assignment rule to a collection.
## Response (201 Created)
```json
```json example-response
{
"id": "rule-uuid-here",
"field": "genre",
"operator": "equals",
"value": "Science Fiction",
"priority": 1,
"enabled": true,
"created_at": "2026-02-01T10:00:00Z"
"collection_id": null,
"is_smart": null,
"rule": null
}
```
+25 -1
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/collections/:id/books
auth: jwt
area: collections
---
<!-- source: internal/handlers/collections.go:506 CollectionHandler.AddBooks -->
# Bulk Assign Books
Add multiple books to a collection at once.
@@ -20,7 +28,7 @@ Add multiple books to a collection at once.
### Example Request
```json
```json example-request
{
"book_ids": [
"660e8400-e29b-41d4-a716-446655440000",
@@ -40,6 +48,22 @@ Books added to collection successfully. No response body.
- This is more efficient than adding books individually
- Maximum 1000 books per request
```json example-response
{
"results": [
{
"book_id": "660e8400-e29b-41d4-a716-446655440001",
"status": "added"
}
],
"total": 1
}
```
Each result carries the operation outcome for one book (`added`/`error`
variants come from the per-book loop; malformed ids report their own
status instead of failing the batch).
## Error Responses
| Code | Description |
@@ -1,3 +1,11 @@
---
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.
@@ -31,7 +39,7 @@ Map a collection to a device shelf for syncing.
### Example Request
```json
```json example-request
{
"collection_id": "550e8400-e29b-41d4-a716-446655440000",
"device_shelf_name": "Sci-Fi",
@@ -41,14 +49,14 @@ Map a collection to a device shelf for syncing.
## Response (201 Created)
```json
```json example-response
{
"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"
"created_at": "2026-02-01T10:00:00Z",
"device_id": null
}
```
@@ -1,3 +1,11 @@
---
method: DELETE
path: /api/collections/:id/rules/:ruleId
auth: jwt
area: collections
---
<!-- source: internal/handlers/collections.go:960 CollectionHandler.RemoveRule -->
# Remove Auto-Assign Rule
Remove an automatic book assignment rule from a collection.
@@ -17,6 +25,16 @@ Remove an automatic book assignment rule from a collection.
Rule deleted successfully. No response body.
```json example-response
{
"collection_id": "550e8400-e29b-41d4-a716-446655440000",
"is_smart": true
}
```
`is_smart` reflects the collection state AFTER removal — removing the
last rule converts a smart collection back to static.
## Error Responses
| Code | Description |
+10 -2
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/collections/test-rules
auth: jwt
area: collections
---
<!-- source: internal/handlers/collections.go:996 CollectionHandler.TestRules -->
# Test Rule
Test which books would match given rules without saving.
@@ -22,7 +30,7 @@ Test which books would match given rules without saving.
### Example Request
```json
```json example-request
{
"rules": [
{
@@ -41,7 +49,7 @@ Test which books would match given rules without saving.
## Response (200 OK)
```json
```json example-response
{
"matches": [
{