Files
dgtlmoonandClaude Opus 5.5 4963ad21ac API - Watch list and search show each watch's paused and notification_muted (#4685) (#4686)
Both are the watch's own setting, same as the single watch GET. "Pause all" and
"mute all" stay separate (all_paused/all_muted in /systeminfo), folding them in
would be wrong info and a client writing the values back would pause every watch.

Spec: SearchResult now matches the real response (no "watches" wrapper).

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-05 23:25:10 +01:00
..
2026-10-28 14:17:21 +01:00
2025-08-24 00:48:17 +02:00
2025-08-24 00:48:17 +02:00
2026-10-28 12:21:49 +01:00

Directory of docs

Regenerating API Documentation

To regenerate the modern API documentation, run from the docs/ directory:

# Install dependencies (first time only)
npm install

# Generate the HTML documentation from OpenAPI spec using Redoc
npm run build-docs

OpenAPI Specification

The OpenAPI specification (docs/api-spec.yaml) is the source of truth for API documentation. This industry-standard format enables:

  • Interactive documentation - Test endpoints directly in the browser
  • SDK generation - Auto-generate client libraries for any programming language
  • API validation - Ensure code matches documentation
  • Integration tools - Import into Postman, Insomnia, API gateways, etc.

Important: When adding or modifying API endpoints, you must update docs/api-spec.yaml to keep documentation in sync:

  1. Edit docs/api-spec.yaml with new endpoints, parameters, or response schemas
  2. Run npm run build-docs to regenerate the HTML documentation
  3. Commit both the YAML spec and generated HTML files