mirror of
https://github.com/dgtlmoon/changedetection.io.git
synced 2026-10-29 10:05:45 +00:00
dgtlmoonandClaude Opus 5.5
a7031ae0c9
* API - `GET /api/v1/watch` add `with_errors=1` filter, `recheck_all=1` no longer rechecks paused watches (#4506) `recheck_all=1` now rechecks only the watches that were listed (honouring `tag` and the new `with_errors` filter) and skips paused watches, matching the UI "Recheck all" behaviour. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * bump docs --------- 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