0 Fork 0

Files

T

John O'Keefe 25ef0d12ba docs(kobo,koreader,collections): Beam WO5 batch 6 — 12 endpoints

Kobo emulation + KOReader calibre-compatible surface backfilled with
device-token auth; collections reorder + update_rule created.

Claude registry: 12 entries. kobo/koreader emulation endpoints all bind
arbitrary protocol POST bodies (markup/bookmark/gettests/sync-from-server,
koreader progress/bookmarks) — registered as AnyJSONObject, not bodyless as
first drafted. Initialization returns the library sync payload, not the init
response.

Contract correction in update_rule.md: the route is SetRuleEnabled ({enabled}
required -> {collection_id, is_smart}); Beam's draft invented rule-field
updates. Reordered response/status: {item_ids} -> {status: reordered}.

make test 9/9.

2026-10-24 16:25:00 -04:00

1.2 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
PUT	/api/collections/:id/rules/:ruleId	jwt	collections

Update Collection Rule

Despite the route name, this endpoint toggles a rule's enabled state only. It does not update the rule's field/operator/value — rules are replaced wholesale via Create Collection (auto_assign_rules) or added via the rules endpoint.

Example request

{
  "enabled": false
}

Example response

{
  "collection_id": "550e8400-e29b-41d4-a716-446655440000",
  "is_smart": true,
  "enabled": null,
  "field": null,
  "id": null,
  "operator": null,
  "priority": null,
  "value": null
}

Request fields

Field	Type	Required	Notes
enabled	boolean	yes	toggles the rule on/off

Errors

Status	Body	When
400	`{"error": "invalid collection id"}` / `{"error": "rule id required"}` / `{"error": "invalid request"}`	malformed
404	`{"error": "rule not found"}`	no such rule
500	`{"error": "..."}`	unexpected server error

1.2 KiB Raw Blame History