Use automated verification checks
What each automated check reads, and what happens when one fails.
In short
A verification stage can hold automated checks that read the evidence for you: runs, suite runs, load tests and change reviews of the API's exact version. Each check shows passed, failed or waiting, with the reason and the run it read.
Before you start
- Who: adding checks to a stage needs "Run API verification". Anyone who can see the verification reads the checks.
- Plan: verification is part of plans that include API verification. Load-test checks need a plan with load testing.
- First: a workflow with the stage you want to add checks to.
Steps
- Add checks to a stage in "Workflows & policies".
- During a verification, open the stage and read "Automated checks".
- Choose "Check again" to read the latest evidence now.
Result: the stage completes when its checks pass; a failing check fails the stage.
Good to know
- Checks look only at the verification's own version and update after every run, suite run, load test and change review.
- A run counts only when it sent the saved request exactly. Trying a changed draft never counts.
- Adding a header changes the contract, because it includes what the request sends. Accept the detected change to get a new version.
If something goes wrong
- A check keeps waiting: the latest run returned a different contract and the change awaits review. It fails if the change is ignored.
- The API shows Verification failed after approval: an automated check failed later. The workflow either holds the stage or takes approvals back, as the policy says.
Related
- /help/api-testing/verification-workflows
- /help/api-testing/change-intelligence