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.
52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
---
|
|
method: PUT
|
|
path: /api/collections/:id/rules/:ruleId
|
|
auth: jwt
|
|
area: collections
|
|
---
|
|
<!-- source: internal/handlers/collections.go:922 CollectionHandler.UpdateRule (SetRuleEnabled) -->
|
|
|
|
# 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](create_collection.md) (`auto_assign_rules`) or added via
|
|
the rules endpoint.
|
|
|
|
## Example request
|
|
|
|
```json example-request
|
|
{
|
|
"enabled": false
|
|
}
|
|
```
|
|
|
|
## Example response
|
|
|
|
```json 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 |
|