Find where the built API differs from the workflow

Compare a workflow's API calls with the built API, then update the design, mark a difference as intended, or file a bug.

In short

Once a plan has made requests in an API project, the Designer compares each step's API call with the built API. That is the project's contract, or what runs saw the API answer in the last 30 days. A step that differs is marked, for example "Running POST /orders answers 202, the design says 201."

Before you start

• Who: anyone who can open the workflow reads the comparison. "Update the design" changes the design, so it needs Edit. "File a bug" makes a card, so you need the right to add cards on the board you choose.
• Plan: Designer is part of every plan, Free included. The Free plan limits how many designs a workspace keeps; Plan & usage shows the limit and what you hold.
• First: make the plan with an API project first (see /help/designer/create-the-plan); the comparison reads that project.

Steps

1. Open the workflow, choose "Show" and then "Coverage". The legend says "N steps differ from the built API" when some do.
2. Press that line, or "Compare with the built API", to open the panel "Against the built API".
3. Press "Show" on a step, then choose what to do: "Update the design", "Mark as intended" or "File a bug".

Result: "Update the design" shows the step brought in line with the built API as a preview you keep or discard. "File a bug" makes a card on the board you choose.

What the words mean

Good to know

• "Running but not designed" lists calls the API answers that no design plans.
• A mark is decided again when the API changes after it.
• "Update the design" changes only a step's status or inputs. An error branch's status is filed as a bug instead.
• Organizations can switch on the recipe "Designs tell when the code moves away" under the Designer's Code view, so managers hear of new drift in their inbox.

If something goes wrong

• "Create the plan with an API project first; the comparison reads that project."
• "Nothing is built to compare with yet: the project has no contract and no run saw these calls."
• "Someone else is editing this design. Try again when they are done."

Related

• /help/designer/build-and-proof-on-the-canvas
• /help/designer/create-the-plan
• /help/api-testing/api-changes