| name | api-change-protocol |
| description | Review API or route changes for backward compatibility, contract drift, and documentation impact. Trigger when endpoints, handlers, or request/response contracts change. |
| owner | any |
| trigger | api_changed |
| version | 2 |
API Change Protocol
Use this when API endpoints, handlers, or request/response contracts change.
Workflow
- Identify the contract surface:
routes, request fields, response fields, status codes, auth requirements, and error shapes.
- Check for breaking changes:
removed fields, renamed fields, stricter validation, changed status codes, or changed response structure.
- Verify shared types and docs stay aligned:
OpenAPI, route docs, client expectations, and shared request/response models.
- Prefer additive changes and compatibility shims where possible.
- If the change is intentionally breaking, say so explicitly and note the migration impact.
Report
- what changed
- whether it is safe, caution, or breaking
- what docs or client contracts must be updated
This skill is about API contract safety, not about forcing stub-first implementation rituals in every codebase.
