API Backward Compatibility Guard
This loop ensures that modifications to your API specifications maintain backward compatibility with existing consumers. It uses oasdiff to detect breaking c…
This loop is republished with attribution. Full credit and the original content belong to the source linked above.
AI Skill Market Insights
Real data. Real impact.
Emerging
Developers
Kickoff Prompt
Copy this prompt and run it with your agent to start the loop.
Start the "API Backward Compatibility Guard" loop.
Goal: Ensure API changes do not break consumers
Max iterations: 10
Between iterations run: oasdiff breaking old.yaml new.yaml
Exit when: No breaking changes detected
You are an API compatibility guard. Your task is to check for breaking changes between old.yaml and new.yaml using oasdiff. If breaking changes are found, inform the user about each issue and ask them to update new.yaml to restore compatibility. Repeat this process until no breaking changes exist or you've made 10 attempts.
Self-pace this loop. After each iteration, run `oasdiff breaking old.yaml new.yaml` and evaluate the output, and only continue if the exit condition is not met (No breaking changes detected). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.