actions-marketplace-validations/OpenAPI Diff Action
A GitHub Action to identify differences between OpenAPI specifications. It uses OpenAPITools/openapi-diff.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| old-spec | Old specification filename | yes | — |
| new-spec | New specification filename | yes | — |
| header | Use given header for authorization | no | "" |
| query | Use query param for authorization | no | "" |
| log | Use given level for log (TRACE, DEBUG, INFO, WARN, ERROR, OFF) | no | ERROR |
| markdown | Export diff as markdown in given file | no | .tmp/markdown |
| json | Export diff as JSON in given file | no | .tmp/json |
| text | Export diff as text in given file | no | .tmp/text |
| html | Export diff as HTML in given file | no | .tmp/html |
| fail-on | Fail if API changed but is backward compatible ('changed' value) or changes broke backward compatibility ('incompatible' value) | no | "" |
Outputs
| name | description |
|---|---|
| state | Output diff state: no_changes, incompatible, compatible |