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.
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
---
|
|
method: GET
|
|
path: /api/series/books
|
|
auth: jwt
|
|
area: series
|
|
---
|
|
<!-- source: internal/handlers/series.go:112 SeriesHandler.GetSeriesBooks -->
|
|
|
|
# Get Series Books
|
|
|
|
Returns the books belonging to a named series within a library.
|
|
|
|
## Example response
|
|
|
|
```json example-response
|
|
{
|
|
"name": "The Witcher",
|
|
"library_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"books": [
|
|
{
|
|
"media_item_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"title": "The Last Wish",
|
|
"author": "Andrzej Sapkowski",
|
|
"cover_image_path": "",
|
|
"has_conflict": false,
|
|
"format_group": "ebook",
|
|
"badge": ""
|
|
}
|
|
],
|
|
"total": 1
|
|
}
|
|
```
|
|
|
|
## Query parameters
|
|
|
|
| Param | Type | Required | Notes |
|
|
| ----- | ---- | -------- | ----- |
|
|
| name | string | Yes | Series name |
|
|
| library_id | uuid | Yes | Library containing the series (must be visible) |
|
|
|
|
## Errors
|
|
|
|
| Status | Body | When |
|
|
| ------ | ---- | ---- |
|
|
| 400 | `{"error": "name required"}` / `{"error": "library_id required"}` / `{"error": "invalid library_id"}` | missing or malformed params |
|
|
| 403 | `{"error": "library not accessible"}` | library not in visible set |
|
|
| 500 | `{"error": "Failed to load series books"}` | unexpected server error | |