Detect breaking schema changes before rebuilding packages
A required request property was added without a major-version discussion.
- Focused work estimate
- 4h + prerequisites
- Priority in the scenario
- High
- Engineering practice
- Compatibility · API contracts
Estimated field mix
- API design60%
- Developer tooling40%
Field percentages are editorial estimates of the ticket's engineering focus. They total 100%; they are not measured time, proficiency scores, or ownership evidence.
Review it, then add it to your workspace.
The board opens an editable draft; nothing is saved until you confirm it. Sign-in and workspace permissions apply, and Demo boards remain ephemeral.
Project context
A fictional partner platform publishes TypeScript clients. Generator upgrades create noisy diffs, occasional runtime mismatches, and uncertainty about which schema was packaged.
Setup prerequisites
- Create a small public API schema and two local mock server versions; use a temporary local package registry or archive files.
Preceding work
Complete these dependencies, or supply their agreed outputs before taking this ticket.
Acceptance criteria
- Classify request and response changes separately.
- Flag removed operations and narrowed accepted values.
- Require an explicit reviewed explanation for allowed exceptions.
Implementation constraints
- Do not treat every additive response field as breaking.
Verification to include
- Detect a required-input addition.
- Accept a documented additive field and reject an expired exception.
Deliverables
- Compatibility diff command.
Rollout and recovery
Run advisory first; enforce after reviewing known baseline exceptions.
Value of the work
For the engineer: Practice reproducible generation, compatibility reviews, and package provenance.
For the team: Reduce partner integration surprises with reviewable clients and recoverable releases.
Evidence boundaries
Outcome Evidence: Tests, patches, and runbooks are requested deliverables. They become Outcome Evidence only through a qualified Mission and immutable Evidence IDs.
Ownership Evidence: Independent adaptation must be observed under a declared verification policy and cite immutable Evidence IDs. Completing a planning ticket establishes no Ownership Evidence.