ARS.FLOW
← Back to API Contract Diff Checker

API Contract Diff Checker Documentation

Runtime-generated docs from the validated registry. Use this page as the in-app skill reference while external source repositories are still being finalized.

Workflow summary

Compares old/new API specifications and produces deterministic breaking-change reports suitable for CI and release gates.

Version
0.1.0
Updated
Apr 22, 2026
Reliability
high
Risk
high

Verification and assets

  • schema validation
  • manual review required

Included files

  • scripts/compare_openapi.py (script) - Compares OpenAPI path/method surfaces and flags deterministic breaking changes.
  • references/breaking-change-rules.md (reference) - Ruleset for classifying contract diffs as breaking or non-breaking.
  • references/versioning-guidance.md (reference) - Version bump guidance for breaking API revisions.

Inputs

  • old_contract (json) - Previous stable API specification.
  • new_contract (json) - Proposed updated API specification.

Outputs

  • contract_diff_report (markdown) - Human-readable summary of contract changes.
  • breaking_changes (json) - Machine-readable breaking change list.

Source metadata

Declared source URL in registry:

https://github.com/SHREYAS290601/ars.flow-skills/tree/main/skills/api-contract-diff-checker