breaking-change-detection

Breaking change detection automatically compares old and new OpenAPI/REST API specs to identify removed endpoints, modified schemas, and changed authentication requirements. It classifies changes by severity and outputs a structured report with migration templates for safe upgrades.

Yes. The Skill analyzes database schemas to find breaking changes like dropped tables, removed columns, or altered data types between versions, enabling you to plan migrations and prevent data loss during schema updates.

Run the orchestrator to compare old vs new API specs and database schemas, producing a breaking-changes-report.md. Integrate this into your CI pipeline to automatically catch breaking changes before release and block deployments when critical issues are detected.

The Skill processes OpenAPI specifications in YAML and JSON formats, SQL database schemas, and API contracts. It uses jq and yq for parsing and diffing, enabling analysis across multiple artifact types in a unified workflow.

The Skill classifies detected changes by impact severity—critical changes block backward compatibility entirely, high changes cause significant disruption, medium changes require adaptation, and low changes are minor. This classification helps prioritize migration efforts and risk assessment.

No. The Skill generates migration guide templates alongside breaking-change reports, reducing manual documentation work and ensuring teams have structured guidance for handling each detected change during version upgrades.