← Back to Docs
Recipe

API/version migration guide writer

Generate a complete migration guide when you bump a dependency or switch an API surface. Structured diff, breaking changes, and step-by-step upgrade path.

What it does

  • Compares two API versions or library releases
  • Flags removed, deprecated, and renamed symbols
  • Generates before/after code snippets
  • Outputs a Markdown guide ready for your changelog

Quick start

curl -X POST https://api.getnimbus.net/v1/recipe/migration \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -d '{"from": "v2.1.0", "to": "v3.0.0", "repo": "my-sdk"}'

Nimbus scans the changelog, diffs the public surface, and returns a structured guide in under 8 seconds.

Output format

BREAKINGRemoved methods, changed signatures, dropped options
DEPRECATEDSymbols still present but scheduled for removal
ADDEDNew APIs, options, or capabilities in the target version

Supported sources

npm, PyPI, crates.io, Go modules, Maven Central, and any repository with a machine-readable changelog or OpenAPI spec.

Explore all recipes