Build a verification workflow

Define the stages an API must pass before it counts as verified.

In short

A verification workflow is your organization's process for calling an API verified. It has stages in order, such as a manual review, a test run, test suites, or a contract or security check. Each stage says who approves. An API is verified only when one exact version of it passed every required stage.

Before you start

Steps

  1. Open API Tester, then "Ship" › "Verification", then "Workflows & policies".
  2. Choose "Start from the recommended workflow", or "New workflow" for a blank one.
  3. Add stages in order. Turn on "Runs together with the stage above" for stages different teams can do at once.
  4. For each stage choose what happens, who approves (people, teams, roles or holders of a permission) and how many must approve.
  5. Add automated checks where the stage needs evidence, and save.

Result: the workflow is ready for a policy to point it at APIs. See /help/api-testing/verification-policies.

Good to know

Testing is not approving Anyone who tests an organization's APIs can run and edit them, but only the reviewers a stage names can decide it. Changing workflows and policies needs the permission to manage API verification.

If something goes wrong

Related