API Versioning Checker
Compare API endpoints across versions, detect breaking changes, and document them
Example Prompt
Compare our API v2 and v3 specs, find all breaking changes, and create a migration guide PR
About
Reads API specification files across different version branches in the repository to identify breaking changes such as removed endpoints, changed request signatures, and altered response schemas. Documents all breaking changes and creates a PR with the migration guide.
Workflow Steps
Read the API specification file from the previous version branch
📃 Read Repo FileRead the API specification file from the current version branch
📃 Read Repo FileCompare the two specifications to detect breaking changes in endpoints, schemas, and parameters
🧠 Structured ReasoningWrite a migration guide documenting all breaking changes and upgrade steps
✏️ Write FileCreate a pull request with the migration guide for team review
🔀 Create Pull RequestTools Used
Write File
Write or overwrite a file at a specified path with the given content
Create Pull Request
Open a pull request in a GitHub repository with title, body, base and head branches
Read Repo File
Read the contents of a file from a GitHub repository at a specific branch or commit
Structured Reasoning
Break down a complex problem into sequential reasoning steps with explicit chain-of-thought