| name | api-contract-review |
| description | API and contract review for OpenAPI/AsyncAPI/protobuf changes, backwards compatibility, schemas, status codes, and examples. |
| license | MIT |
Purpose
API and contract review for OpenAPI/AsyncAPI/protobuf changes, backwards compatibility, schemas, status codes, and examples.
Review focus
- breaking response shape
- missing status code
- schema mismatch
- undocumented error
- OpenAPI example gap
- event compatibility
Method
- Inspect changed files and diff hunks relevant to this skill.
- Use repository-native tools when available.
- Prefer exact evidence from changed code.
- Emit findings using the shared JSONL finding contract.
- Avoid style-only comments unless they create maintainability or correctness risk.
Tooling hints
- Use
grep or editor search before opening files.
- Use
git, grep, and gh CLI. These are universally available and sufficient for all review tasks.
- Do not depend on tools beyond
git, grep, cat, head, wc, and gh.