name: api-contract-checker description: Validate API changes against an expected contract. Use when a mid-level developer needs to detect breaking changes. metadata: version: "1.0.1"
API Contract Checker
Purpose
Validate API changes against an expected contract.
Inputs to request
- Old and new API specs or examples.
- Versioning policy and client expectations.
- Known consumers and usage patterns.
Workflow
- Compare endpoints, request/response fields, and status codes.
- Identify breaking changes and backward-compatible adjustments.
- Suggest versioning or migration notes.
Output
- Breaking change report with mitigation steps.
Quality bar
- Flag any removal or behavior change clearly.
- Recommend safe rollouts for clients.