jorisjonkers-dev/API Contract Checks
Validate committed OpenAPI specs and generated TypeScript contracts against fresh outputs.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| profile | Service profile name shown in drift reports. | yes | — |
| spec-path | Committed OpenAPI spec path. | yes | — |
| export-command | Command that exports the fresh OpenAPI spec in place at spec-path. | yes | — |
| spec-normalize-command | Optional command that normalizes spec-path after export. | no | "" |
| types-paths | Newline- or comma-separated committed generated TypeScript artifact paths. | no | "" |
| types-generate-command | Command that regenerates the declared TypeScript artifacts in place. | no | "" |
| types-normalize-command | Optional command that normalizes the generated TypeScript artifacts after generation. | no | "" |
| guidance | Maintainer-facing regeneration command or note printed when drift is detected. | yes | — |
| breaking-check | Run semantic OpenAPI breaking-change detection against the base spec. | no | false |
| breaking-base-ref | Git ref containing the previous committed spec. Empty auto-detects origin/$GITHUB_BASE_REF. | no | "" |
| breaking-base-spec-path | Optional previous spec file. May equal spec-path; it is snapshotted before export. | no | "" |
| breaking-fail-on | oasdiff severity threshold, WARN or ERR. | no | ERR |
| oasdiff-version | Pinned oasdiff CLI version. | no | 1.20.0 |
Outputs
no outputs