John O'Keefe
fa00d6d3cb
Beam drafted 15 frontmatter'd docs (saved-filters CRUD, dashboard
sections/preferences/restore, system config/settings, series list + books);
Claude verified shapes against handlers and pinned the registry:
- saved-filters: SavedFilterResponse pinned by type (RFC3339 timestamps here,
unlike most of the API); create/update share CreateSavedFilterRequest
(resource_type oneof media-items|collections|devices)
- dashboard: preferences GET pin {hidden_collections, collection_order,
items_per_section}; PUT returns full UserDashboardPreferences row; sections
wrapper {sections}
- system: GET+PUT /api/system/config are admin-defined key/value maps — new
AnyJSONObject sentinel (gate shape-checks without key comparison; request
side too). UpdateSystemConfiguration returns {status, message} — verified,
not guessed. GET /api/system/settings returns []SettingEntry.
- series: {series[{name, library_id, book_count, total_in_series,
cover_paths, last_entry_at}], total, limit, offset}; books by
?name=&library_id= with family-lens 403
Dedupe: deleted dashboard.md, system/config.md, system/settings.md — each
covered the same endpoints as Beam's per-endpoint files (content merged by
the gate-verified shapes; old prose recoverable from git).
Beam clarifications confirmed: scanner routes are WO5 (docs exist);
progress/books-match are WO5.
1.3 KiB
1.3 KiB
method, path, auth, area
| method | path | auth | area |
|---|---|---|---|
| PUT | /api/system/config | jwt+admin | system |
Update System Configuration
Updates one or more system-wide configuration keys. Admin only. When
base_url is provided, derived keys (opds_base_url, api_base_url) are
updated automatically. default_timezone is validated as a timezone.
Example request
{
"base_url": "https://books.example.com",
"default_timezone": "UTC"
}
Example response
{
"status": "success",
"message": "System configuration updated"
}
Fields
| Field | Type | Required | Notes |
|---|---|---|---|
| (any key) | string | No | Arbitrary config key/value pairs |
Errors
| Status | Body | When |
|---|---|---|
| 400 | {"error": "invalid request format"} / {"error": "invalid timezone"} |
malformed body or bad timezone |
| 401 | {"error": "unauthorized"} |
no/invalid JWT |
| 403 | {"error": "admin access required"} |
non-admin |
| 500 | {"error": "failed to update config key: ..."} / {"error": "failed to update default timezone"} / {"error": "failed to update derived config key: ..."} |
unexpected server error |