api-contract-validation

Breaking changes in OpenAPI specs occur when endpoints are removed, request parameters become required, or response schemas change incompatibly. This Skill compares your current OpenAPI/Swagger spec against a baseline version, classifies changes by severity, and generates a structured report identifying which modifications could break client applications.

Yes. This Skill integrates into CI/CD workflows to automatically compare OpenAPI specs on each commit or pull request, detecting breaking changes before deployment. It outputs a JSON summary and artifacts that your pipeline can use to gate or warn on risky contract modifications.

By validating OpenAPI contracts against a baseline before changes ship, you catch incompatible modifications early and can adopt versioned strategies proactively. This Skill surfaces breaking changes and suggests remediation, helping you maintain backward compatibility or plan graceful deprecations.

Yes. The Skill locates OpenAPI/Swagger specs whether hand-written or auto-generated from REST API frameworks, then applies the same diff and validation pipeline to detect breaking changes regardless of how the specification was created.

The Skill can update or initialize the baseline during validation runs. If no baseline exists, it establishes one from your current spec; on subsequent runs, it compares against that stored version and flags any breaking modifications.

Reports include a structured JSON summary categorizing changes by severity, identifying removed endpoints or schema fields, and listing additions or modifications that could impact clients. Artifacts are saved with full details for integration with monitoring and approval workflows.