Documentation
Use Ovyero from any CI
GitHub Actions has a ready-made workflow (GitHub). Any other CI system can call the HTTP API directly: send a file, read the verdict, fail the build on GATE.
Steps
- Store your Ovyero API key as a secret in your CI system (the examples call it
OVYERO_API_KEY). - For each changed file,
POSTits name and content to/api/v1/govern/file:jq -n --arg f "$FILE" --rawfile c "$FILE" '{filename:$f, content:$c}' \ | curl -fsS -X POST https://ovyero.visnryentertainment.com/api/v1/govern/file \ -H "Authorization: Bearer $OVYERO_API_KEY" \ -H "Content-Type: application/json" --data-binary @- - Read
verdictin the JSON response:PASS,WARNorGATE. Fail the build when it isGATE(passedisfalse).
Several files in one request
POST /api/v1/govern/files-bulk with {"files":[{"filename":"…","content":"…"}, …]}, up to 100 files per request. The response is {"verdicts":[…],"count":N}, one verdict object per file in the same shape as the single-file call.
Reading the response
findingsis a per-domain summary;violationsis the flat list of individual issues (message, line).coverageisfull,partial,baselineornone. A PASS whose coverage is notfullmeans the file was not fully reviewed, not that it is clean;coverage_notesays why.audit_ididentifies the record written to your audit ledger.
Limits
- The govern endpoints have their own rate limit (600 requests a minute by default). A
429means slow down and retry. - The Free plan covers one developer and up to 2 repositories.
Full endpoint list: API. Problems: Troubleshooting.