This repository is now deprecated. We moved to a new repository architecture containing multiple actions that you can find here

GitHub action for comparing OpenAPI specs, based on oasdiff tool

Copy and paste the following snippet into your build .yml file:

- name: Running OpenAPI Spec diff action
  id: test_breaking_changes
  uses: Tufin/oasdiff-action@v2.1.3
  with:
    base: 'specs/base.yaml'
    revision: 'specs/revision-breaking-changes.yaml'
    format: 'text'
    check-breaking: true
    fail-on-diff: true

Required path of original OpenAPI spec in YAML or JSON format

Required path of revised OpenAPI spec in YAML or JSON format

Optional output format: yaml, text or html (default "yaml")

Optional fail with non 0 exit code if a difference is found

Optional display breaking changes (new method)

Optional display breaking changes (old method)