mirror of
https://github.com/dgtlmoon/changedetection.io.git
synced 2026-11-18 20:54:26 +00:00
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>
Directory of docs
Regenerating API Documentation
Modern Interactive API Docs (Recommended)
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:
- Edit
docs/api-spec.yamlwith new endpoints, parameters, or response schemas - Run
npm run build-docsto regenerate the HTML documentation - Commit both the YAML spec and generated HTML files