https://github.com/tufin/oasdiff-action
GitHub action for comparing OpenAPI specs
https://github.com/tufin/oasdiff-action
Last synced: about 1 month ago
JSON representation
GitHub action for comparing OpenAPI specs
- Host: GitHub
- URL: https://github.com/tufin/oasdiff-action
- Owner: Tufin
- License: apache-2.0
- Created: 2022-03-30T07:00:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-14T13:02:42.000Z (about 2 years ago)
- Last Synced: 2025-04-07T16:16:58.033Z (2 months ago)
- Language: Shell
- Size: 26.4 KB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⛔️ DEPRECATED
This repository is now deprecated. We moved to a new repository architecture containing multiple actions that you can find [here](https://github.com/oasdiff/oasdiff-action)
# oasdiff-action
[](https://github.com/Tufin/oasdiff-action/actions)
GitHub action for comparing OpenAPI specs, based on [oasdiff](https://github.com/Tufin/oasdiff) tool
## How to use?
Copy and paste the following snippet into your build .yml file:
```
- name: Running OpenAPI Spec diff action
id: test_breaking_changes
uses: Tufin/[email protected]
with:
base: 'specs/base.yaml'
revision: 'specs/revision-breaking-changes.yaml'
format: 'text'
check-breaking: true
fail-on-diff: true
```
## Inputs
### `base`
**Required** path of original OpenAPI spec in YAML or JSON format
### `revision`
**Required** path of revised OpenAPI spec in YAML or JSON format
### `format`
**Optional** output format: yaml, text or html (default "yaml")
### `fail-on-diff`
**Optional** fail with non 0 exit code if a difference is found
### `check-breaking`
**Optional** display breaking changes (new method)
### `breaking-only` [Deprecated]
**Optional** display breaking changes (old method)