skills.rest
Sokoliem
SokoliemCOMMUNITY
Explore all skills by this author →
GitHub

api-contract

Review API contracts for breaking changes, deprecations, and compatibility issues.

Updated Aug 23, 2026
Search Tags:#versioning#api#openapi#schema#deprecation#review#contract
One-click install
npx skills add https://github.com/Sokoliem/ultraprompt --skill api-contract-sokoliem
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract
Source: https://github.com/Sokoliem/ultraprompt/tree/main/skills/api-contract
Command: npx skills add https://github.com/Sokoliem/ultraprompt --skill api-contract-sokoliem

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides disciplined API contract design and review by dispatching to reviewer/integration-contract-reviewer with a focus on API contracts, enabling safe evolution and preventing breaking changes.

Core Features & Use Cases

  • Dispatch policy routing to the contract reviewer or integration-contract-reviewer for changes affecting public surfaces
  • Distinctive judgment emphasizing compatibility, deprecation planning, and consumer impact assessment
  • Workflow guidance for surface inventory, versioning decisions, contract tests, and changelog updates

Quick Start

Route a proposed public API change to the contract reviewer for validation.

Frequently Asked Questions about 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 schema?▼

API contract review detects breaking changes by analyzing the public surface affected by proposed modifications across endpoints and schemas to ensure compatibility for consumers.

What is the best way to plan API deprecations and consumer migration paths?▼

The best way to plan API deprecations is to review the API contract to assess consumer impact, document the deprecation plan, and define a clear migration path for affected users.

How do I review an API contract for versioning and compatibility issues?▼

Reviewing an API contract for versioning involves identifying the public surface affected by changes and applying contract validation to detect compatibility issues across endpoints and configurations.

When do I need an API contract review for schema modifications?▼

You need an API contract review whenever a proposed change affects the public surface, ensuring contract tests, changelog entries, and deprecation plans are prepared for safe evolution.

How to prepare contract tests and changelog entries for endpoint updates?▼

Preparing contract tests and changelog entries for endpoint updates requires identifying affected public surfaces, validating compatibility, and documenting the migration path for consumers.

Can I use this API contract review for OpenAPI endpoint configurations?▼

Yes, you can use API contract review for OpenAPI endpoint configurations to detect deprecations and compatibility issues across schemas, ensuring a clear migration path for consumers.

Related Skills

Explore More Software Engineering Skills→
dhruvinrsonidhruvinrsoni

api-implementation

Generate backend API route handlers, request validation, and response serialization from an OpenAPI specification.

Community
Advanced
apassuelloapassuello

validating-api-contracts

Generate Pact consumer tests and validate responses against OpenAPI specifications.

Community
Advanced
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
proffesor-for-testingproffesor-for-testing
436

contract-testing

Verify microservice API providers against consumer-driven Pact contracts in CI/CD pipelines.

Community
Advanced