api-compat

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

3|1|Updated Nov 29, 2025
One-click install
npx skills add https://github.com/indrasvat/claude-code-skills --skill api-compat
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-compat
Source: https://github.com/indrasvat/claude-code-skills/tree/main/skills/api-compat
Command: npx skills add https://github.com/indrasvat/claude-code-skills --skill api-compat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The skill helps teams ensure API compatibility by automatically detecting breaking changes across protobuf, OpenAPI/Swagger, GraphQL, and Go exported interfaces.

Core Features & Use Cases

  • Inspect API definitions for compatibility across major formats (protobuf, OpenAPI, GraphQL, Go).
  • Baseline and compare changes against a common base to surface breaking changes early.
  • Use cases include validating PRs, CI checks, and release vetting before shipping APIs.

Quick Start

Provide a quick compatibility report for the changed API definition files.

Frequently Asked Questions about api-compat

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

FAQPage Schema
How do I detect API breaking changes before release?

Detect API breaking changes before release by analyzing protobuf, OpenAPI, GraphQL, and Go interface definitions against a baseline. This read-only analysis surfaces incompatible modifications early in code evolutions or PR reviews.

Can I check OpenAPI breaking changes in a pull request?

Check OpenAPI breaking changes in a pull request by comparing the updated Swagger or OpenAPI schema against a common base. The analysis uses oasdiff when available and falls back to manual diff inspection.

Does API compatibility checking work with GraphQL and protobuf?

API compatibility checking works with GraphQL and protobuf by inspecting schema definitions for breaking changes. It applies available tooling like buf for protobuf and falls back to manual diff inspection when tools are unavailable.

How do I validate Go exported interfaces for breaking changes?

Validate Go exported interfaces for breaking changes by comparing the updated definitions against a baseline. This safe, read-only analysis identifies incompatible modifications during code evolutions or schema migrations.

What is the best way to automate API compatibility checks for schema migrations?

Automate API compatibility checks for schema migrations by running a read-only analysis that diffs protobuf, GraphQL, OpenAPI, or Go definitions against a common base. This surfaces breaking changes early for release vetting.

Do I need buf installed to inspect protobuf breaking changes?

You do not need buf installed to inspect protobuf breaking changes. The analysis uses buf when present but automatically falls back to manual diff inspection of the API definitions when the tool is unavailable.