api-contract-reviewer

Name: api-contract-reviewer
Availability: InStock
Author: andreicr1

Identify and describe breaking API changes from diffs across endpoints and request/response shapes.

Updated Mar 14, 2026

Search Tags:#versioning #api #review #breaking-changes #contract #api-design #error-compatibility

Ready to run

npx skills add https://github.com/Andreicr1/netz-analysis-engine --skill api-contract-reviewer-andreicr1

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-contract-reviewer
Source: https://github.com/Andreicr1/netz-analysis-engine/tree/main/.gemini/skills/api-contract-reviewer
Command: npx skills add https://github.com/Andreicr1/netz-analysis-engine --skill api-contract-reviewer-andreicr1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Evaluates code changes that touch API interfaces to protect contract stability and client compatibility, flagging potential breakages before they reach production.

Core Features & Use Cases

Breaking-change detection: flags renamed endpoints, removed routes, changed response shapes, or altered status codes that existing clients depend on.
Versioning discipline: detects missing version bumps, deprecations, or migration needs to keep downstream integrations intact.
Error-shape consistency: ensures uniform error formats across endpoints and helps enforce a stable error contract.

Quick Start

Review the diff for API changes and generate a contract-impact assessment.

Frequently Asked Questions about api-contract-reviewer

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

FAQPage Schema

How do I detect breaking changes in an API diff?▼

To detect breaking changes in an API diff, evaluate modifications across endpoints, request and response shapes, and serialization. This analysis flags renamed endpoints, removed routes, altered status codes, and changed response shapes to assess contract impact and protect client compatibility.

What is API contract safety and why is it needed?▼

API contract safety protects client compatibility and contract stability by evaluating code changes that touch API interfaces. It is needed to flag potential breakages, such as altered response shapes or removed routes, ensuring downstream integrations remain intact before changes reach production.

How do I enforce API versioning discipline and error-shape consistency?▼

Enforce API versioning discipline and error-shape consistency by analyzing diffs to detect missing version bumps, deprecations, and migration needs. The review ensures uniform error formats across endpoints to maintain a stable error contract for downstream integrations.

What is the best way to assess contract impact for API design changes?▼

The best way to assess contract impact for API design changes is to analyze endpoint diffs and serialization modifications. This approach documents whether changes are additive or breaking and notes the required migrations or version bumps to keep clients compatible.

Does this API review work with serialization and response shape changes?▼

Yes, this API review works directly with serialization and response shape changes. It applies analysis across request and response shapes to determine whether modifications are additive or breaking, flagging altered status codes and changed structures that existing clients depend on.

When do I need to document required migrations for API breaking changes?▼

You need to document required migrations for API breaking changes when diffs show removed routes, renamed endpoints, or altered response shapes. The contract impact assessment identifies these breaking modifications and explicitly notes the necessary version bumps or deprecations.