Why this matters
Prevents client breakage, reduces support load, and keeps contracts reliable.
If a PR changes an API route/controller signature (path, method, params, request/response schema), update the API specification in the same PR. To enable this check, reference the spec file path in the PR (e.g., `openapi.yaml`, `swagger.json`). If multiple specs exist, update the relevant one. Warn when code and spec drift (new params not documented, status codes changed, response shape changed).
Prevents client breakage, reduces support load, and keeps contracts reliable.
Side-by-side examples engineers can pattern-match during review.
Adds required query param but does not update openapi.yaml.Updates controller + openapi.yaml with schema changes and examples.route changed; openapi.yaml untouchedroute changed; openapi.yaml updated accordinglyFrom the same buckets as this rule.
For changes that affect architecture, data models, external APIs, security posture, deployment topology, or cost (>10%), create an ADR in docs/adr/ using the standard template (Context, Decision, Consequences) and link the PR and issue IDs.