docs(schedule): document pending-change cancellation and the CANCELLATION audit action #254

New issue

Open

opened 2026-10-03 10:45:33 +00:00 by gabogg · 0 comments

gabogg commented

2026-10-03 10:45:33 +00:00

Owner

P3 follow-up from PR #177 review pass 5 (spec axis).

Finding

PR #177 limited DELETE /api/occupancy/pending-changes/{id} to SCHEDULE_EXCEPTION* types (other types get 422 VALIDATION_ERROR) and added a CANCELLATION settings-audit action. The docs don't reflect either change:

docs/api/README.md:104 still calls the route "Cancel Pending Settings Change", which reads as if any change type can be cancelled.
Neither CONTEXT.md nor ADR 0008 lists CANCELLATION among the audit actions (submission, historical correction, operational activation), or says that only schedule exceptions can be cancelled.

Acceptance Criteria

The API docs name the route's real scope and its 422/404 responses.
CONTEXT.md, or the relevant ADR, lists the four settings-audit actions and the cancellation rule.
scripts/check_docs.py passes.

P3 follow-up from PR #177 review pass 5 (spec axis). ### Finding PR #177 limited `DELETE /api/occupancy/pending-changes/{id}` to `SCHEDULE_EXCEPTION*` types (other types get 422 `VALIDATION_ERROR`) and added a `CANCELLATION` settings-audit action. The docs don't reflect either change: - `docs/api/README.md:104` still calls the route "Cancel Pending Settings Change", which reads as if any change type can be cancelled. - Neither CONTEXT.md nor ADR 0008 lists `CANCELLATION` among the audit actions (submission, historical correction, operational activation), or says that only schedule exceptions can be cancelled. ### Acceptance Criteria - The API docs name the route's real scope and its 422/404 responses. - CONTEXT.md, or the relevant ADR, lists the four settings-audit actions and the cancellation rule. - `scripts/check_docs.py` passes.

gabogg added this to the Historical passenger-flow backfill milestone

2026-10-03 10:45:33 +00:00

gabogg added the

ready-for-agent

enhancement

labels

2026-10-03 10:45:33 +00:00

gabogg removed this from the Historical passenger-flow backfill milestone

2026-10-03 12:13:42 +00:00