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

1.7 KiB Raw Blame History