skills.rest
resultakak
resultakakCOMMUNITY
Explore all skills by this author →
Website𝕏@resultakakGitHub

api-contract-review

Compare latest API contracts against baseline to surface compatibility issues.

Updated May 11, 2026
Search Tags:#versioning#openapi#graphql#idempotency#breaking-changes#api-contracts#error-model
One-click install
npx skills add https://github.com/resultakak/argos --skill api-contract-review-resultakak
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-review
Source: https://github.com/resultakak/argos/tree/main/skills/api-contract-review
Command: npx skills add https://github.com/resultakak/argos --skill api-contract-review-resultakak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates a rigorous review of REST/OpenAPI/GraphQL/WebSocket contracts to ensure versioning discipline, proper error modeling, idempotency, and correct auth scopes before releases.

Core Features & Use Cases

  • Detect breaking changes across OpenAPI/GraphQL/WS specs, including added required fields, removed fields, and type changes.
  • Validate idempotency guarantees and consistency of operation semantics across endpoints.
  • Ensure consistent error models per RFC 7807 and unified error envelopes, plus pagination patterns.
  • Recommend release strategies and SDK compatibility checks for new versions.

Quick Start

Review the latest API specification (OpenAPI/GraphQL/WS) and generate a structured contract review highlighting breaking changes, idempotency concerns, and auth scope gaps.

Frequently Asked Questions about api-contract-review

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

FAQPage Schema
How do I detect breaking changes in an OpenAPI or GraphQL spec?▼

API contract review compares the latest OpenAPI, GraphQL, or WebSocket specs against a baseline to surface compatibility issues. It applies versioning, idempotency, and auth scope rules to determine breakage risk and generate actionable remediation steps.

How do I automate API contract reviews before release?▼

Automate API contract reviews by processing the latest OpenAPI, GraphQL, or WS specifications to validate versioning discipline, idempotency, and error models. The review produces a concise report with actionable diffs, risk levels, and recommended next steps for release planning.

Does this API contract review validate idempotency and auth scopes?▼

Yes, API contract review validates idempotency guarantees and consistency of operation semantics across endpoints. It also checks authentication scopes and pagination patterns to determine breakage risk and suggest remediation before release.

How do I check if my API error models follow RFC 7807?▼

Checking API error models against RFC 7807 involves validating unified error envelopes and consistent error patterns across endpoints. Automated contract review ensures your error models comply with standard formatting before release.

What is the best way to compare API versions for SDK compatibility?▼

The best way to compare API versions for SDK compatibility is to run an automated contract review that identifies breaking changes and recommends release strategies. This surfaces versioning discipline issues and generates compatibility checks for new versions.

Related Skills

Explore More Software Engineering Skills→
BrunoAMSilvaBrunoAMSilva

openapi-to-application-code

Generate framework-specific application scaffolds from OpenAPI specifications.

Community
Advanced
murphytruemanmurphytrueman
155

cicd-integration

Generate CI/CD pipeline configurations for design system quality checks.

Community
Advanced
abzhawabzhaw

openapi-spec-generation

Generate, validate, and maintain OpenAPI 3.1 specifications from code and designs.

Community
Advanced
anton-abyzovanton-abyzov
156

confluent-schema-registry

Manage Avro, Protobuf, and JSON Schema compatibility and evolution via Confluent Schema Registry.

Community
Advanced