OpenAPI sync
OpenAPI sync turns an API specification into a working set of requests and metadata.
Why sync a spec
Section titled “Why sync a spec”The OpenAPI document is the source of truth for the API surface. Syncing it into Echopoint keeps workflow setup close to the contract that defines the API.
Sync helps with:
- Importing methods, paths, request bodies, and response shapes.
- Preserving authentication options from the spec.
- Reviewing changed operations before they affect workflows.
- Keeping manual workflow setup to a minimum.
What to review after sync
Section titled “What to review after sync”After each sync, review changed operations before using them in a flow:
- Added endpoints that should become requests.
- Changed schemas that affect request bodies or responses.
- Removed or deprecated endpoints that may still be used by flows.
- Authentication changes that affect execution.
Working with manual requests
Section titled “Working with manual requests”Not every endpoint is always represented in a specification. Manual requests can live alongside generated requests and can be used in the same flows.
Use manual requests for temporary endpoints, internal tools, or APIs that do not publish an OpenAPI document yet.