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

+90
View File
@@ -770,4 +770,94 @@ var Schemas = map[string]Schema{
"GET /opds/devices/:deviceId/catalog": {},
"GET /opds/devices/:deviceId/download/:bookId": {},
"GET /opds/devices/:deviceId/cover/:bookId": {},
// --- Beam batch 10: book-matching + collections remainder ---
"POST /api/sync/books/query": {
// Plugin/sync-protocol variant of GET /api/books/match (body, not
// query params; unfiltered legacy path).
Request: services.BookQueryRequest{},
Response: services.BookQueryResponse{},
},
"POST /api/sync/bulk-link-books": {
Request: handlers.BulkLinkBooksRequest{},
Response: json.RawMessage(`{
"results": [], "total": 0, "successful": 0, "failed": 0
}`),
},
"POST /api/sync/auto-link-books": {
Request: handlers.AutoLinkBooksRequest{},
Response: json.RawMessage(`{
"auto_linked": 0, "results": []
}`),
},
"GET /api/devices/:deviceId/sync/unlinked-books": {
Response: json.RawMessage(`{
"unlinked": [], "total": 0
}`),
},
"GET /api/sync/unlinked-books/:id/suggestions": {
Response: json.RawMessage(`{
"unlinked_book_id": "", "title_from_device": "", "sha256": "",
"suggestions": [], "total_suggestions": 0, "action": ""
}`),
},
"GET /api/devices/:id/file-aliases": {
Response: json.RawMessage(`{
"device_id": "", "aliases": [], "total": 0
}`),
},
"POST /api/devices/:id/file-aliases": {
// Inline request struct in handler.
Request: json.RawMessage(`{
"media_item_id": "", "file_path": "", "file_sha256": "",
"confidence_score": 0
}`),
Response: json.RawMessage(`{
"id": "", "media_item_id": "", "device_id": "", "file_path": "",
"file_sha256": "", "confidence_score": 0, "last_seen_at": ""
}`),
},
"PUT /api/devices/:id/file-aliases/:aliasId": {
// Partial update — pointer fields.
Request: json.RawMessage(`{
"media_item_id": "", "file_sha256": "", "confidence_score": 0
}`),
Response: json.RawMessage(`{
"id": "", "media_item_id": "", "file_path": "",
"file_sha256": "", "confidence_score": 0, "last_seen_at": ""
}`),
},
"DELETE /api/devices/:id/file-aliases/:aliasId": {
Response: json.RawMessage(`{"message": ""}`),
},
"POST /api/collections/:id/rules": {
// First rule converts a static collection to smart.
Request: handlers.AddRuleRequest{},
Response: json.RawMessage(`{
"collection_id": "", "rule": {}, "is_smart": false
}`),
},
"DELETE /api/collections/:id/rules/:ruleId": {
Response: json.RawMessage(`{
"collection_id": "", "is_smart": false
}`),
},
"POST /api/collections/test-rules": {
Request: handlers.TestRulesRequest{},
Response: json.RawMessage(`{"matches": [], "total": 0}`),
},
"POST /api/collections/:id/books": {
// Bulk add: {operations: [{collection_id, book_ids:[...]}]}.
Request: json.RawMessage(`{
"operations": [{"collection_id": "", "book_ids": []}]
}`),
Response: json.RawMessage(`{"results": [], "total": 0}`),
},
"POST /api/devices/:id/collections": {
Request: handlers.CreateDeviceMappingRequest{},
Response: json.RawMessage(`{
"id": "", "collection_id": "", "device_id": "",
"device_shelf_name": "", "sync_direction": "", "created_at": ""
}`),
},
}