jellyfin/OpenAPI Diff
Compare two OpenAPI specifications and detect breaking changes using openapitools/openapi-diff
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit May 1, 2026
- License
- MIT
Pinned Snippet
uses: jellyfin/openapi-diff-action@43ef40a960b1d7f41087551b03cf54d007fe6606 # v1.1.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| old-spec | Path or URL to the old/base OpenAPI specification | yes | — |
| new-spec | Path or URL to the new/head OpenAPI specification | yes | — |
| html | Path to write HTML diff report | no | "" |
| markdown | Path to write Markdown diff report | no | "" |
| json | Path to write JSON diff report | no | "" |
| asciidoc | Path to write Asciidoc diff report | no | "" |
| text | Path to write plain text diff report | no | "" |
| fail-on-breaking | Fail the action if breaking changes are detected | no | false |
| fail-on-changed | Fail the action if any changes are detected (breaking or compatible) | no | false |
| headers | HTTP headers to use when fetching remote specs via URL (format: "Header1=Value1,Header2=Value2"). Only applies to URL specs, ignored for local files. | no | "" |
| log-level | Log level (TRACE, DEBUG, INFO, WARN, ERROR, OFF) | no | ERROR |
| add-pr-comment | Add diff results as a PR comment | no | false |
| github-token | GitHub token for posting PR comments (required if add-pr-comment is true) | no | "" |
| artifact-name | Name for the uploaded artifact containing report files | no | openapi-diff-report |
Outputs
| name | description |
|---|---|
| state | Diff state: no_changes, compatible, or incompatible |
| has-changes | Whether any changes were detected (true/false) |
| is-breaking | Whether breaking changes were detected (true/false) |