https://github.com/swimmwatch/openapi-compare-version
A GitHub Action for comparing OpenAPI specifications version.
https://github.com/swimmwatch/openapi-compare-version
github-actions openapi openapi-specification
Last synced: 10 months ago
JSON representation
A GitHub Action for comparing OpenAPI specifications version.
- Host: GitHub
- URL: https://github.com/swimmwatch/openapi-compare-version
- Owner: swimmwatch
- License: mit
- Created: 2022-05-10T08:39:15.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-22T10:15:48.000Z (over 3 years ago)
- Last Synced: 2024-03-14T19:17:37.127Z (almost 2 years ago)
- Topics: github-actions, openapi, openapi-specification
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# openapi-compare-version
A GitHub Action for comparing OpenAPI specifications version.
## Usage
```yml
- name: "Compare OpenAPI specifications version"
id: compare_res
uses: swimmwatch/openapi-compare-version@v1.0.1
with:
current-spec: "old_spec.json"
new-spec: "new_spec.json"
- name: "Output result"
if: ${{steps.compare_res.outputs.is-diff-version}} == 'true'
run: echo "Version is different"
```
## Options
The following input variables options can/must be configured:
|Input variable|Necessity|Description|Default|
|----|----|----|----|
|`current-spec`|Required|Current specification path||
|`new-spec`|Required|New specification path||
## Outputs
- `is-diff-version`: Difference version state (`true` or `false`).
## License
openapi-compare-version is licensed under the [MIT License](LICENSE).