apinotes/ApiNotes OpenAPI Validate & Diff
Validate OpenAPI specs and detect breaking changes on every PR. Powered by apinotes.io
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 19, 2026
- License
- MIT
Pinned Snippet
uses: apinotes/openapi-validate@2f686a6553d1b46f12b32b1827f1d4e248749cce # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | Your ApiNotes API key (get one free at apinotes.io/dashboard/settings). Optional for public repositories — GitHub Actions on public repos are validated for free without a key. | no | "" |
| spec-path | Path to your OpenAPI spec file (e.g., openapi.yaml, docs/api.json) | yes | openapi.yaml |
| diff-enabled | Enable breaking change detection by diffing against base branch | no | true |
| fail-on-errors | Fail the workflow if validation errors are found | no | true |
| fail-on-breaking | Fail the workflow if breaking changes are detected | no | false |
| api-url | ApiNotes API base URL (override for self-hosted) | no | https://api.apinotes.io/api/v1 |
| comment-on-pr | Post results as a PR comment | no | true |
Outputs
| name | description |
|---|---|
| valid | Whether the spec is valid (true/false) |
| errors-count | Number of validation errors |
| warnings-count | Number of validation warnings |
| breaking-changes-count | Number of breaking changes detected |
| version | Detected OpenAPI version |