John O'Keefe
e21e1facde
All remaining endpoint docs frontmatter'd: media-item bulk ops + audio surface, collections book-listing/preview, koreader rating/review/stats plugin protocol, hash-conflicts JSON list. Scope call (Claude): resolve_hash_conflict.md DELETED — the resolve POST renders an htmx fragment (renderResolved), a web-admin flow under rule 3; only the GET list is a JSON API. update_media_review skipped by Beam (correct): ratings/upsert_media_review.md already covers the PUT. Registry: 16 entries. koreader rating/review/stats all bind koreaderBookRef (query or body) — odd=half-star rating scale; audio track endpoint serves raw bytes (ServeContent, Range) — response nil. Fixed drift: deleted_annotations doc's secondary restore/purge fences unlabeled (gate validates labeled blocks against the ONE frontmatter route); chapters example labeled. UNVERIFIED: 1 (koreader book-ref fields, push_stats). make test 9/9.
46 lines
1.0 KiB
Markdown
46 lines
1.0 KiB
Markdown
---
|
|
method: POST
|
|
path: /api/collections/preview
|
|
auth: jwt
|
|
area: collections
|
|
---
|
|
<!-- source: internal/handlers/collections.go:1241 CollectionHandler.PreviewCollection -->
|
|
|
|
# Preview Collection
|
|
|
|
Previews which books would match a set of rules without saving.
|
|
|
|
## Example request
|
|
|
|
```json example-request
|
|
{
|
|
"library_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"rules": [],
|
|
"manual_book_ids": [],
|
|
"limit": 20
|
|
}
|
|
```
|
|
|
|
## Example response
|
|
|
|
```json example-response
|
|
{
|
|
"items": []
|
|
}
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Notes |
|
|
| ----- | ---- | -------- | ----- |
|
|
| library_id | string (uuid) | Yes | Library to preview against |
|
|
| rules | array | No | Rule objects |
|
|
| manual_book_ids | array of string (uuid) | No | Manually included books |
|
|
| limit | int | No | Max items (default 20) |
|
|
|
|
## Errors
|
|
|
|
| Status | Body | When |
|
|
| ------ | ---- | ---- |
|
|
| 400 | `{"error": "Invalid request"}` / `{"error": "invalid library_id"}` / `{"error": "library not found"}` | malformed |
|
|
| 500 | `{"error": "..."}` | unexpected server error | |