mirror of
https://github.com/dgtlmoon/changedetection.io.git
synced 2025-12-13 03:25:45 +00:00
2e4f40b172
Some checks failed
Build and push containers / metadata (push) Has been cancelled
Build and push containers / build-push-containers (push) Has been cancelled
Publish Python 🐍distribution 📦 to PyPI and TestPyPI / Build distribution 📦 (push) Has been cancelled
ChangeDetection.io App Test / lint-code (push) Has been cancelled
Publish Python 🐍distribution 📦 to PyPI and TestPyPI / Test the built package works basically. (push) Has been cancelled
Publish Python 🐍distribution 📦 to PyPI and TestPyPI / Publish Python 🐍 distribution 📦 to PyPI (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-10 (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-11 (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-12 (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-13 (push) Has been cancelled
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