api-diff

Compare two OpenAPI 3.x or Swagger 2.0 specs and generate a changelog of breaking and non-breaking changes. Detect removed endpoints, new required parameters, type changes, schema modifications, enum changes, security changes, server URL changes, and deprecations. Use when asked to diff APIs, compare API versions, detect breaking changes, generate API changelogs, or review API spec changes. Triggers on "API diff", "API changelog", "breaking changes", "OpenAPI compare", "spec diff", "API version compare".

Safety Notice

This listing is from the official public ClawHub registry. Review SKILL.md and referenced scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "api-diff" with this command: npx skills add charlie-morrison/api-diff

API Diff — Changelog Generator

Compare two OpenAPI/Swagger specs and generate a detailed changelog with breaking change detection.

Quick Diff

python3 scripts/api_diff.py old-spec.json new-spec.json

Output Formats

# Text (default)
python3 scripts/api_diff.py old.json new.json

# JSON
python3 scripts/api_diff.py old.json new.json --format json

# Markdown
python3 scripts/api_diff.py old.json new.json --format markdown

CI/CD Integration

# Fail if breaking changes found
python3 scripts/api_diff.py old.json new.json --fail-on-breaking
echo $?  # 0 = no breaking, 1 = breaking found

# Show only breaking changes
python3 scripts/api_diff.py old.json new.json --breaking-only

What It Detects

Endpoint Changes

ChangeBreaking?Description
Endpoint removedYesPath+method no longer exists
Endpoint addedNoNew path+method
Endpoint deprecatedNoMarked as deprecated

Parameter Changes

ChangeBreaking?Description
Required param addedYesNew mandatory parameter
Optional param addedNoNew optional parameter
Param removed (required)YesRequired parameter removed
Param type changedYesData type changed
Param became requiredYesOptional → required
Param became optionalNoRequired → optional

Schema Changes

ChangeBreaking?Description
Schema removedYesDefinition removed
Required property addedYesNew mandatory field
Optional property addedNoNew optional field
Property removedYesField removed
Property type changedYesData type changed
Enum value removedYesAllowed value removed
Enum value addedNoNew allowed value

Other Changes

ChangeBreaking?Description
Response code removedYesHTTP status no longer returned
Response code addedNoNew HTTP status
Security changedYesAuth requirements changed
Server URLs changedNoBase URL changed
API version changedNoInfo version updated

Requirements

  • Python 3.6+
  • No external dependencies (stdlib only)
  • Input: JSON format OpenAPI 3.x or Swagger 2.0 specs

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Open Registry RecordOpen in ClawHub

Related Skills

Related by shared tags or category signals.

General

Grab Company

Provides detailed insights on Grab's evolution, business model, market position, and significance in Southeast Asia's digital economy and super app landscape.

Registry SourceRecently Updated
90hanxueyuan
General

CV-Driven Job Hunter

Asiste en una búsqueda laboral proactiva basada en el CV del usuario — analiza perfil, sugiere banda salarial, escanea boards y career pages, califica matche...

Registry SourceRecently Updated
111askenaz
General

Changelog Linter

Validate CHANGELOG.md files against the Keep a Changelog format (keepachangelog.com). Checks version ordering, date formats, section types, link references,...

Registry SourceRecently Updated
970charlie-morrison
General

Bosch Company

Bosch is the world's largest automotive Tier 1 supplier, focusing on automotive parts, industrial tech, consumer goods, and energy solutions with a foundatio...

Registry SourceRecently Updated
100hanxueyuan