📜

API Changelog Generator

Code & Development · by AIDiveForge · Apr 20, 2026 · Beginner

Diff two OpenAPI specs into a human-readable changelog with breaking-change flags, ready for release notes.

🧠 Why it works

Hand-written API changelogs skew toward shiny new features and under-report breaking changes because the developer remembers the new endpoint but forgets the tightened enum. Mechanical diff ensures breaking changes appear in the release notes — which is what consumers actually need.

⚙️ How it works

Parse both specs into canonical JSON. 2. Walk the tree and produce per-path, per-method, per-parameter diffs. 3. Apply rules: removed endpoint = breaking; narrowed enum = breaking; widened enum = non-breaking; added required field in request = breaking; removed required field in response = breaking. 4. For each entry, prompt the LLM for a one-sentence human summary using the canonical diff as context. 5. Emit markdown grouped by change category with breaking flagged in bold.

Description

Compares two versions of an OpenAPI / JSON Schema file and produces a categorized changelog: Added, Changed, Deprecated, Breaking. Each entry cites the affected endpoint and field, and breaking changes include a short note on migration steps.

Install this skill

A Claude skill is a skill.md file with YAML frontmatter and a markdown body. Drop the file into your tool of choice — or pick a different format if you use Cursor, Windsurf, Copilot, or something else.

Format Download skill.md

Quick install — paste into your terminal

mkdir -p ~/.claude/skills/api-changelog-generator \
  && curl -L https://aidiveforge.com/skill/api-changelog-generator.skill-md \
       -o ~/.claude/skills/api-changelog-generator/skill.md

Save to ~/.claude/skills/api-changelog-generator/skill.md

🧠 Why it works

⚙️ How it works

Description

Install this skill

Recommended Use

Report compatibility

Suggest a pairing