shishir99-code/DocGuard Drift Check
Eliminate API documentation drift. Validate your code against your OpenAPI spec on every pull request.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| spec | Path to the OpenAPI spec file (YAML or JSON) | no | openapi.yaml |
| source | Source directory to scan for API code | no | . |
| framework | Force a specific framework parser (auto, fastapi) | no | auto |
| fail-on | When to fail the check: any, drift-only, missing | no | any |
| python-version | Python version to use | no | 3.11 |
Outputs
| name | description |
|---|---|
| drift-score | The drift score (0.0 = synced, 1.0 = fully drifted) |
| report | Path to the generated JSON drift report |