professional plan

API Change Detection

Detect breaking API changes before they reach production.

Spec v1 and v2 of the Orders API are diffed field by field: total was removed and currency became required, flagged as breaking; an optional note field and a new invoice endpoint are non-breaking; the change set waits for Approve or Reject, approval creates new endpoint versions, and existing tests are never rewritten

What It Does

API Change Detection shows you exactly how a new version of your specification differs from what the project tests today. When a breaking change is detected (a removed field, a changed type, a new required parameter, a removed success response), it is flagged with a before/after comparison, so your team can review it before anything breaks in production. Approving imports the change as new endpoint versions, with an audit entry and an approval webhook, and removing an endpoint warns that its tests will be deleted; rejecting leaves the project as it was. Existing tests are never edited behind your back: when one fails after a change, Fix with AI proposes the update for you to review. With the security add-on, a spec change can also trigger a rescan for security drift.

Overview

Detects breaking changes by diffing your API specification when you re-import it. When a field is removed, a required parameter is added, a response type changes or an enum narrows, the platform lists every changed endpoint and field with before and after values and classifies each change as breaking or non-breaking. The change set then waits for your team to approve or reject it, unless the project opts in to auto-approving non-breaking changes. Approval creates new endpoint versions, so the old definition stays in version history; no test is rewritten automatically. Monitored spec URLs can be checked on demand or from CI through the API.

Key Capabilities

Breaking vs. non-breaking classification on every spec re-import

Every changed endpoint and field, with before and after values

Approve or reject the change set; optional auto-approval for non-breaking changes

Approval creates new endpoint versions, keeping the old ones in history

Approvals are audited and can fire a webhook

Check monitored spec URLs on demand, or from CI through the API

How It Works

1
Re-import your API specification (upload, URL fetch, or from CI through the API)
2
The platform diffs the new spec against the current endpoints field by field
3
Breaking changes are flagged with before and after values
4
Approve & Import or Reject the change set
5
Approved changes become new endpoint versions; tests are not rewritten

Available on

professional Plan & Above

Upgrade to the professional plan to unlock this feature.

Start Free Trial View Pricing

Available on Professional plan and above

See pricing →