Area: API Documentation
Priority: P3 — Low
Description
API consumers need to understand what changed between releases. Without a changelog, breaking changes are discovered only after a production failure. Track OpenAPI deltas per release.
Acceptance Criteria
Technical Notes
- Use
openapi-diff to compute deltas
- Each breaking change needs explicit confirmation in PR template
Description
API consumers need to understand what changed between releases. Without a changelog, breaking changes are discovered only after a production failure. Track OpenAPI deltas per release.
Acceptance Criteria
docs/API_CHANGELOG.mdfrom OpenAPI diffs between consecutive releasesapi-diffverifies non-backward-compatible changes are intentionally taggedTechnical Notes
openapi-diffto compute deltas