Integrated Governance Checks
APIGit shows governance findings in real time while you edit your API specifications. The platform re-checks your specification against the selected ruleset as you work.
How to Access Governance Validation
Follow these steps to access governance validation during editing:
- Open your API specification in editing mode
- Navigate to the Governance tab in the upper-right corner of the interface
- Review the validation panel that appears, displaying any rule violations detected in your specification
- Use the ruleset dropdown menu to switch between rulesets and view specific validation results
Governance applies only to OpenAPI documents, so the tab is hidden for other files. Outside edit mode, you can see the same results read-only by choosing governance from the viewer menu.
The dropdown always lists OpenAPI Best Practice and OWASP Top 10 Security. In an organization repository covered by a governance policy, it also lists the profiles of those policies under Custom Profiles.
Interactive Issue Resolution
The governance validation panel lists each finding with its severity icon, line number and message:
- Use the filter next to the dropdown to show all findings, or only errors, warnings or infos. Each filter shows its count.
- Click on any violation to be automatically directed to the exact line in your specification where the issue exists
- Make corrections directly in the editor and see violations resolve in real time
$refs to other files in the repository are followed, including uncommitted changes. A finding inside a referenced file has no line number in the current spec, so clicking it does not jump to a line.
The results are for your information. They do not stop you from committing.
