skills.rest
marcusgoll
marcusgollCOMMUNITY
Explore all skills by this author →
Website𝕏@marcusgollGitHub

breaking-change-detector

Detect breaking API, schema, and interface changes with severity levels and migration paths.

91|10|Updated Oct 4, 2025
Search Tags:#versioning#API#schema#migration#breaking-change
One-click install
npx skills add https://github.com/marcusgoll/Spec-Flow --skill breaking-change-detector
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: breaking-change-detector
Source: https://github.com/marcusgoll/Spec-Flow/tree/main/.codex/skills/breaking-change-detector
Command: npx skills add https://github.com/marcusgoll/Spec-Flow --skill breaking-change-detector

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Detects potential breaking API/schema/interface changes before implementation and recommends safe migration paths.

Core Features & Use Cases

  • Detect breaking changes (API removal, payload changes, schema shifts)
  • Severity classification (CRITICAL/HIGH/MEDIUM)
  • Migration strategies (deprecation, versioning, redirects)

Quick Start

Validate proposed changes against api-strategy.md; propose a migration plan before changes are implemented.

Frequently Asked Questions about breaking-change-detector

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect breaking changes in my API before deployment?▼

Breaking change detection identifies modifications to API routes, payloads, and contracts that disrupt client integrations. Compare proposed changes against your api-strategy.md to catch removals, schema shifts, and interface alterations before they reach production, preventing integration failures.

What counts as a breaking change in API versioning?▼

Breaking changes include removing API endpoints, altering response schemas, changing parameter requirements, and modifying interface contracts. These differ from safe updates like adding optional fields or new endpoints, which don't disrupt existing client code.

How do I create a migration plan when I need to change an API schema?▼

Migration planning maps safe transition paths using deprecation warnings, API versioning, or request redirects. The Skill suggests strategies based on change severity (CRITICAL, HIGH, MEDIUM) and validates that a plan exists before deployment proceeds.

Can I use breaking change detection across development, staging, and production workflows?▼

Yes, apply breaking change detection at every deployment stage—development, staging, and production—to validate route modifications, schema alterations, and interface updates consistently across your entire workflow.

What should I do if a breaking change is classified as CRITICAL?▼

CRITICAL severity changes block deployment until you propose a migration strategy. Develop a deprecation timeline, versioning scheme, or client notification plan that allows existing integrations to adapt before the breaking change takes effect.

Related Skills

Explore More Software Engineering Skills→
Prathmesh2000Prathmesh2000
1

api-versioning

Define API versioning strategies and deprecation timelines with migration guides.

Community
Advanced
cslsoftwarescslsoftwares

version-orchestrator

Coordinate semver bumps, deprecations, migrations, and release notes across environments.

Community
Advanced
proffesor-for-testingproffesor-for-testing
436

contract-testing

Verify microservice API providers against consumer-driven Pact contracts in CI/CD pipelines.

Community
Advanced
indrasvatindrasvat
3

api-compat

Detect breaking changes in protobuf, OpenAPI, GraphQL, and Go API definitions.

Community
Advanced