Works with the AI Agents you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseDotsDots+21 more

    API Breaking-Change Detector — CI Guardrail

    1

    The skill also walks a seven-category ERR checklist on every run, proving the negative when no breaking changes are found, and explicitly states the CI exit code.

    $19

    Secure checkout via Stripe

    Money-back guarantee

    Converts to your local currency at checkout

    Security scanned
    API Breaking-Change Detector — CI Guardrail

    API Breaking-Change Detector — CI Guardrail

    Example session with this skill installed

    Compare openapi-v1.yaml and openapi-v2.yaml. Flag breaking changes and generate all artifacts. The new version removes the 'email' field from the User schema response.

    • Read your context and instructions
    • Compiled the api breaking-change detector

    Analysis complete. A breaking change was detected in the User schema. All artifacts have been generated.

    API Contract Diff — v1.0.0 → v1.1.0

    Engine: manual-read
    Base: openapi-v1.yaml (v1.0.0)
    New: openapi-v2.yaml (v1.1.0)

    Summary

    SeverityCountNotes
    ERR1Removed response field in User schema
    WARN0none
    INFO0none

    Exit code: 1 — breaking changes detected.

    Breaking changes (ERR)

    • GET /users/{id} — Removed response field email from the User schema. This will break clients expecting this property.
      • Remediation: Restore the email field or mark it as deprecated if a new field replaces it.

    ERR checklist

    CategoryResult
    Deleted endpointpass
    Modified path parameterpass
    Status code shiftpass
    Removed response fieldfail
    New required request fieldpass
    Type narrowingpass
    Enum value removalpass

    API_CHANGELOG.md

    
    # API Changelog
    ## [1.1.0]
    ### Breaking Changes
    - Removed `email` property from `User` response object in `GET /users/{id}`.
    

    diff.json

    {
      "schema_version": "1.0",
      "engine": "manual-read",
      "summary": { "err": 1, "warn": 0, "info": 0 },
      "exit_code": 1,
      "breaking": [
        {
          "id": "ERR-001",
          "rule": "removed-response-field",
          "location": "GET /users/{id}",
          "field": "User.email",
          "description": "Removed property 'email' from response.",
          "remediation": "Restore field or start deprecation cycle."
        }
      ],
      "warnings": [],
      "info": [],
      "unchanged": ["POST /users", "GET /health"],
      "err_checklist": {
        "removed_response_field": "fail"
      }
    }
    

    Next steps

    1. Review BREAKING_CHANGES.md for full remediation details.
    2. Revert the field removal or update the ignore_file if this is an intentional break.
    3. Run the diff again to verify the fix.
    openapi-v1.yaml

    Connects securely to your tools. The creator never sees your data.

    About this skill

    API Breaking-Change Detector is a Claude Code skill for detecting backward-incompatible changes between OpenAPI 3.x specifications. It performs semantic contract diffing on JSON or YAML specs and classifies every difference into three severity levels: ERR (breaking), WARN (non-breaking risk), and INFO (additive or metadata). The skill catches deleted endpoints, modified path parameters, removed response fields, new required request fields, type narrowing, and enum value removal—the exact changes that break existing API clients.

    Every run produces a complete artifact set in a single pass: API_CHANGELOG.md, BREAKING_CHANGES.md, diff.json (schema-conformant, with breaking, warnings, and info arrays always present), and—when a deprecation or approved break exists—DEPRECATION_PLAN.md. The skill also walks a seven-category ERR checklist on every run, proving the negative when no breaking changes are found, and explicitly states the CI exit code.

    Use cases: pull request gating, contract drift audits, version comparison before release, and automated changelog generation. Compatible with oasdiff, api-governor, and OpenAPI Comparator, or fully functional as a manual-read fallback when no tool is available.

    Keywords: OpenAPI breaking change detector, API contract diff, backward compatibility checker, CI/CD API guardrail, semantic diff OpenAPI, contract drift detection, oasdiff skill.

    Requires valid OpenAPI 3.x specs. Cannot resolve external $ref pointers if files are missing. Scope limited to contract structure, not runtime behavior.

    How to use

    1. 1

      Connect your agent to the Agensi MCP

      Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup

    2. 2

      Sign in to Agensi

      Your agent shows a sign-in link. Sign in and click Allow.

    3. 3

      Ask for what you need

      Your agent loads this skill and uses it on your task. It always asks before any payment.

    Reviews

    No reviews yet

    Be one of the first to try it. Every listed skill goes through the trust checks below.

    Security scanned

    Checked by our 8-point scan before listing

    Fresh listing

    Recently published to Agensi

    Money-back guarantee

    Doesn't do what its page promises? You get your money back.

    Trust & safety

    Security scan

    Security scan passed 1 month ago

    Permissions

    Terminal / Shell
    Listed1 month ago
    Updated24 days ago

    What's inside

    Frequently Asked Questions

    This skill acts as an automated quality gate in your CI/CD pipeline, performing a deep structural comparison of OpenAPI specs to flag deleted fields, modified parameters, or renamed endpoints that would otherwise crash downstream services.

    The detector is designed for any AI agent or CI tool that supports OpenAPI 3.x (JSON/YAML) and can execute shell-based logic, including GitHub Actions, GitLab CI, and Jenkins.

    Yes, the skill categorizes changes into ERR, WARN, and INFO levels, allowing you to set the detector to only block builds (exit code 1) when critical breaking changes are found while allowing minor additions.

    Upon purchase, you receive the integrated detection logic, pre-configured reporting templates for changelogs, and the automated guardrail scripts ready to be added to your workflow.

    While the skill is highly robust, it requires valid OpenAPI 3.x files to run and cannot resolve external $ref pointers if they are hosted on private servers not accessible during the analysis phase.

    New in APIs & Backend