souryeahdeep/APISentry
Catches breaking OpenAPI changes in Spring Boot PRs and flags affected frontend files.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| build-command | Command to build the jar | — | mvn -B -q -DskipTests package |
| jar-glob | Glob pattern matching the built jar | — | target/*.jar |
| ci-profile | Spring profile to boot with in CI | — | ci |
| port | Port the app listens on | — | 8080 |
| health-path | Path used both as a readiness check and to fetch the OpenAPI spec | — | /v3/api-docs |
| baseline-path | Path (relative to repo root) where the committed baseline spec lives | — | openapi/spec.json |
| consumer-dirs | Newline-separated list of frontend app source directories to scan for impacted files | — | "" |
| fail-on | Minimum oasdiff severity that fails the check (ERR or WARN) | — | ERR |
| startup-timeout | Seconds to wait for the app to become ready | — | 60 |
Outputs
no outputs