0 Fork 0

Files

T

John O'Keefe cc893f758e feat(docs): drift gate — docs frontmatter validated against real routes

Every API doc that declares frontmatter (method/path/auth/area) is now
checked by a unit test against three sources of truth:

1. Route registration: internal/router/*.go is parsed the way echo resolves
   it (group prefixes concatenate; scanner.go's parameterized groups seeded).
   Doc paths that no longer exist fail. (This is the check that would have
   caught the /api/api/admin/hash-conflicts split.)
2. Auth: frontmatter auth label must match the middleware chain
   (none|jwt|jwt+admin|device-token|optional-jwt).
3. Shapes: internal/docs/schema.go registry — example-request decoded with
   unknown fields DISALLOWED (typo guard), required-by-validate fields must
   appear (staleness guard), example-response top-level key set compared
   both directions against the marshaled handler type (or a RawMessage pin
   for hand-built map responses).

Five collections docs are the pilots with real handler shapes; notable
corrections they pin: update returns 201 (not 200), list excludes smart
collections unless include_auto=true, rule priority is 1-10 higher-wins
(docs claimed 1=highest), created_at is Go time.String() not RFC3339,
hide_finished/show_up_next toggles documented. CollectionResponse hoisted
out of GetCollections/GetBookCollections as CollectionSummary /
BookCollectionSummary so the registry can pin real types.

The gate fails on missing registry entries by design — that is the
maintenance contract. Known pre-existing (not this commit): vet copy-lock
warnings in media.go.

2026-10-24 14:41:02 -04:00

2.1 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
PUT	/api/collections/:id	jwt	collections

Update Collection

Updates name/metadata, replaces the rule set, and merges view settings. Note the quirk: the success status is 201, not 200 (historical).

The playlist toggles hide_finished / show_up_next are accepted as top-level single-element arrays (an htmx form artifact — the LAST value wins) and are merged into view_settings server-side. JSON clients may prefer to set view_settings.hide_finished / view_settings.show_up_next directly.

Example request

{
  "name": "To Read (2026)",
  "description": "Updated description",
  "color": "#33CCFF",
  "icon": "📚",
  "auto_assign_rules": [],
  "view_settings": { "hide_finished": true },
  "hide_finished": ["true"],
  "show_up_next": ["true"]
}

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "8f14e45f-ceea-467f-a429-0b21bfc0b1a2",
  "name": "To Read (2026)",
  "description": "Updated description",
  "color": "#33CCFF",
  "icon": "📚",
  "auto_assign_rules": null,
  "view_settings": { "hide_finished": true, "show_up_next": true },
  "created_at": "2026-10-24 13:57:01.81234 +0000 UTC"
}

created_at uses Go's time.String() format, not RFC3339.

Request fields

Field	Type	Required	Notes
name	string	yes
description	string	no
color	string	no
icon	string	no
auto_assign_rules	array	no	replaces the whole rule set (rule object shape: see Create Collection)
view_settings	object	no	merged into stored settings
hide_finished	array	no	single-element string array `["true"]`/`["false"]`; merged into view_settings
show_up_next	array	no	same shape as `hide_finished`

Errors

Status	Body	When
400	`{"error": "invalid collection id"}` / `{"error": "invalid request"}`	malformed id or body
500	`{"error": "..."}`	unexpected server error

2.1 KiB Raw Blame History