John O'Keefe
a86bdac87e
The pre-tree rules machinery is deleted: no row ever carried a rules array or a non-default match mode (verified in the dev DB), the web never read the envelope keys, and the Android app consumes none of it. Dead code gets no documentation. Removed: - PUT /api/collections/:id/match-mode — endpoint, route, and the UpdateCollectionMatchMode query. The tree's root mode owns any|all. - auto_assign_rules / rule_match_mode from every envelope (create/list/detail/update), from the create/update request shapes, and from the schema: both columns DROPPED (schema.sql carries idempotent DROP COLUMN IF EXISTS heals for existing DBs; sqlc regenerated). - The rules CRUD service layer (AddRule/SetRuleEnabled/RemoveRule + validateRule + UpdateCollectionRulesJSON), ParseRules / EnabledRules / IsSmartCollection, RulesToFilterTree (+ the SSR preload branch), the legacy branch of EvaluateSmartMembership, and SmartEvalOptions.MatchMode. IsCollectionSmart = tree presence; create-path isSmart = collection_type=smart OR a filter_tree. Kept (live consumers): POST /api/collections/preview still evaluates rules payloads in memory (the custom-section builder's preview), and include_auto stays on the list (the Android app sends it). The custom-section builder's SAVE was already broken — its stringified auto_assign_rules payload failed request binding (probed live: 400 invalid request). Create now rejects that payload loudly with a 400 naming the retirement, instead of silently creating a hollow static section; custom-section-builder.md carries the flag. The builder's tree migration remains the flagged follow-up. Test-side (asymmetry rule — deleted behavior, deleted tests): TestPodcastSmartCollections rewritten onto trees (mode lives in the tree root), match-mode subtests and tree_wins_over_legacy_rules deleted, TestRulesToFilterTree deleted, contract-pin envelope keys retracted per the contract_pins 2026-10-31 retirement entry. Mirrors hand-synced: openapi.yaml, bruno create/update, docs/api/*.md, docs/schema.go, api.d.ts. Full container suite green (155s).
74 lines
2.0 KiB
Markdown
74 lines
2.0 KiB
Markdown
---
|
|
method: GET
|
|
path: /api/collections/:id
|
|
auth: jwt
|
|
area: collections
|
|
---
|
|
<!-- source: internal/handlers/collections.go:243 CollectionHandler.GetCollection -->
|
|
|
|
# Get Collection
|
|
|
|
Returns one collection with its books and, for smart collections, the
|
|
computed Up Next entries.
|
|
|
|
## Example request
|
|
|
|
```text
|
|
GET /api/collections/550e8400-e29b-41d4-a716-446655440000
|
|
```
|
|
|
|
## Example response
|
|
|
|
```json example-response
|
|
{
|
|
"id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"user_id": "8f14e45f-ceea-467f-a429-0b21bfc0b1a2",
|
|
"name": "To Read",
|
|
"description": "Books I want to read soon",
|
|
"color": "#00FF00",
|
|
"icon": "📖",
|
|
"view_settings": { "kobo": { "view_mode": "grid" } },
|
|
"books": [],
|
|
"book_count": 0,
|
|
"is_smart": false,
|
|
"up_next": [],
|
|
"created_at": "2026-10-24 13:57:01.81234 +0000 UTC"
|
|
}
|
|
```
|
|
|
|
`created_at` uses Go's `time.String()` format, not RFC3339. `books` and
|
|
`up_next` are book-card arrays; `up_next` items carry
|
|
`id`, `title`, `author`, `cover`, `format`, `progress`.
|
|
|
|
## Query parameters
|
|
|
|
| Param | Type | Notes |
|
|
| ----- | ---- | ----- |
|
|
| library_id | uuid | optional; scopes items/counts to one library (invalid values are rejected with 400) |
|
|
|
|
## Response fields
|
|
|
|
| Field | Type | Notes |
|
|
| ----- | ---- | ----- |
|
|
| id | string (uuid) | |
|
|
| user_id | string (uuid) | owner |
|
|
| name | string | |
|
|
| description | string | |
|
|
| color | string | |
|
|
| icon | string | |
|
|
| view_settings | object | |
|
|
| filter_tree | object \| null | the unified filter tree (qf DSL); null = static |
|
|
| books | array | book cards in this collection |
|
|
| book_count | number | length of `books` |
|
|
| is_smart | boolean | |
|
|
| up_next | array | smart collections only: computed next-up entries |
|
|
| created_at | string | |
|
|
|
|
## Errors
|
|
|
|
| Status | Body | When |
|
|
| ------ | ---- | ---- |
|
|
| 400 | `{"error": "invalid collection id"}` / `{"error": "invalid library_id"}` | malformed id(s) |
|
|
| 404 | `{"error": "collection not found"}` | no such collection |
|
|
| 500 | `{"error": "..."}` | unexpected server error |
|