Check the source
Run a source check to detect an updated definition.
// API Change Review
Review API changes before they disrupt your workflow.
Inspect source updates, compare local and incoming edits, resolve conflicts and browse retained API definition revisions.
Payments API / designer / example preview
POST/payments
Summary
Create a payment
Operation ID
createPayment
ParametersRequest bodyResponsesMocks
201 · Payment created
400 · Invalid request
401 · Unauthorized
Review a required field before applying an update
A repository update and a local edit can affect the same operation. Compare their values, choose the intended resolution and test callers separately. A visible schema change is not proof that all breaking changes have been detected.
POST /payments
Local edit: amount description updated
Incoming edit: currency becomes required
Review: compare fields and resolve conflicts
After apply: inspect available definition revisionsCapabilities
API Change Review capabilities
- Inspect added, modified and removed operations.
- Compare incoming source changes with locally edited definitions.
- Review conflicts before choosing how to resolve them.
- Browse available revision history within account retention limits.
Workflow
Your api change review workflow
Compare operations
Review changed paths, methods, parameters and schemas in the available diff.
Resolve conflicts
Review local and incoming values before choosing a supported resolution.
Inspect history
Apply reviewed changes and inspect available saved revisions.
Built for real handoffs.
Contract review
Notice a newly required payment field before adapting a client.
Parallel edits
Reconcile local operation work with an incoming repository update.
Change investigation
Compare retained revisions when a request no longer matches the contract.
Related features
// FAQ
Questions, answered.
// GET STARTED
Bring your API workflow into one workspace.
Start with an OpenAPI or Swagger JSON definition and keep the workflow together.