0 Fork 0

Files

T

John O'Keefe 18084de7a6 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.

2026-10-24 17:59:27 -04:00

2.3 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/collections/test-rules	jwt	collections

Test Rule

Test which books would match given rules without saving.

Endpoint: POST /api/collections/test-rules Auth: Required Content-Type: application/json

Request Body

Field	Type	Required	Description
rules	array	Yes	Array of rule objects to test

Rule Object

Field	Type	Required	Description
field	string	Yes	Field to match on (genre, author, series, language, publisher, copyright_year, tags)
operator	string	Yes	Comparison operator (equals, not_equals, contains, not_contains, starts_with, ends_with, greater_than, less_than)
value	string/number	Yes	Value to compare against

Example Request

{
  "rules": [
    {
      "field": "genre",
      "operator": "equals",
      "value": "Science Fiction"
    },
    {
      "field": "author",
      "operator": "contains",
      "value": "Asimov"
    }
  ]
}

Response (200 OK)

{
  "matches": [
    {
      "media_item_id": "660e8400-e29b-41d4-a716-446655440000",
      "title": "Foundation",
      "author": "Isaac Asimov",
      "cover_image_path": "/covers/foundation.jpg",
      "match_reason": "Matched rule: genre equals Science Fiction"
    }
  ],
  "total": 42
}

Use Case

Test rules before creating a collection to verify correct book matching. This endpoint shows which books would be added without actually modifying any collections.

Error Responses

Code	Description
400	Invalid request (validation failed)
401	Authentication required
500	Internal server error

2.3 KiB Raw Blame History