Review and decide a verification
Approve, request changes or reject, and attach the evidence behind your decision.
In short
When a verification stage names you, the review waits under "My reviews". You approve, request changes or reject one exact version of the API, with the evidence behind your decision. A rejection can raise a bug on a board.
Before you start
- Who: a stage must name you (by person, team, role or holders of "Review API verification"). The permission alone decides nothing. Passing a review on, restarting or cancelling needs "Run API verification"; verifying by override needs "Override API verification".
- Plan: verification is part of plans that include API verification.
- First: a verification must be running with a stage open for you.
Steps
- Open "My reviews", or the notification. Only reviews you may decide now are listed.
- Open the review and check the version number. Your decision counts only for that version.
- Choose the failed test the checks read, or for an approval the run that backs it, and the attached files that support your decision.
- Choose "Approve", "Request changes" or "Reject". A rejection or request for changes needs a reason; an approval confirms the stage's checklist item by item.
- To reject with a bug, choose "Raise a bug" on a board connected to the project, or "Link a card" to an existing one.
Result: the stage records your decision; a bug raised from it shows the verification's stages and history and turns green once the API is fully verified again.
Good to know
- While a verification runs, its reviewers, whoever asked for it and the people who manage verification can attach files under "Evidence", such as a screenshot, log or signed checklist. Everyone who can see the verification can open them.
- People who manage API verification can pass a review to someone else, restart or cancel a verification and waive an optional stage. Verifying by override, or waiving a required stage, needs the override permission. Each asks for a reason that stays in the history.
- "Export" downloads the audit record as a workbook or JSON with every stage, decision, check, history entry and file.
If something goes wrong
Related
- /help/api-testing/verify-an-api
- /help/api-testing/verification-workflows
- /help/boards/bug-triage