regression-api-contract

Detect breaking changes in REST, GraphQL, and gRPC API contracts.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/robit-man/transcribe-cli --skill regression-api-contract
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: regression-api-contract
Source: https://github.com/robit-man/transcribe-cli/tree/main/.claude/skills/regression-api-contract
Command: npx skills add https://github.com/robit-man/transcribe-cli --skill regression-api-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automatically detects breaking changes in API contracts across various protocols like REST, GraphQL, and gRPC, preventing unexpected regressions and ensuring backward compatibility.

Core Features & Use Cases

  • Comprehensive API Analysis: Analyzes OpenAPI, GraphQL schemas, and Protobuf definitions.
  • Automated Regression Detection: Identifies removed endpoints, fields, type changes, and other breaking modifications.
  • Semantic Versioning Enforcement: Validates that version bumps align with the severity of changes.
  • Consumer Impact Assessment: Integrates with consumer contract testing (Pact, Spring Cloud Contract) to highlight affected consumers.
  • Use Case: Before deploying a new version of your core API, use this Skill to automatically scan for any changes that could break existing client applications, providing a detailed report and blocking deployment if critical regressions are found.

Quick Start

Run a check for API breaking changes using the provided OpenAPI specification files.

Frequently Asked Questions about regression-api-contract

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

FAQPage Schema
How do I detect breaking changes in an OpenAPI specification before deployment?

You can detect breaking changes in an OpenAPI specification by comparing current definitions against baselines to identify removed endpoints, fields, and type changes. This automated regression detection prevents unexpected regressions and ensures backward compatibility.

Does consumer contract testing work with GraphQL and gRPC schema regression checks?

Yes, consumer contract testing integrates with GraphQL and gRPC regression checks to assess backward compatibility and consumer impact. It analyzes GraphQL schemas and Protobuf definitions alongside REST interfaces to validate modifications against consumer expectations.

What is the best way to automate semantic versioning validation for REST APIs?

The best way to automate semantic versioning validation for REST APIs is to scan for breaking and non-breaking changes, then validate that version bumps align with the severity of those modifications. This ensures version numbers accurately reflect API impact.

Can I use Spring Cloud Contract to block deployments when API regressions are found?

Yes, you can integrate with Spring Cloud Contract to block deployments when critical API regressions are found. By comparing current API definitions against baselines, it highlights affected consumers and prevents unexpected breaking changes from reaching production.

When do I need to compare Protobuf definitions against a baseline?

You need to compare Protobuf definitions against a baseline when modifying gRPC interfaces to prevent unexpected regressions. This comparison validates backward compatibility by detecting removed fields and type changes before deployment.