Paths
paths
A path is an entry of the version's API surface; each operation is a method on it, with parameters, a request body, responses, tags and security. Paths are edited in the workspace (Paths and Combined lenses) and on the classic Paths editor.
Create a path and an operation
- Workspace: ＋ New path… in the tree, then ＋ New operation… and a method.
- Classic: the API Designer sidebar's Paths tab — a Path Name and, optionally, Auto-create CRUD operations (GET, POST, PUT, DELETE). Drag an HTTP Operations chip onto a path to add one method.
- Import paths from OpenAPI — "Paste or upload an OpenAPI 3.x spec to add paths and security schemes to this version."
The operation
In the workspace inspector an operation has three working tabs and one placeholder:
| Tab | Fields |
|---|---|
| Overview | Summary, Operation ID (unique within the version), Consumes — the schemas it carries, with + link —, Security, Danger → Delete |
| Request | Add parameter (path, query, header, cookie); Request body + add |
| Responses | Add response: status code, description, and the schema it links |
| Tests | Disabled — "Contract testing lands with its own roadmap — this tab opens when it does." |
Quick actions: Try it (Try it and mock), View YAML, cURL, SDK snippet.
The classic canvas edits the same things in panels beside the canvas:
- Operation (tabs General, Docs, Tags): operationId, deprecated, summary, description with a Preview, tags, parameters and responses, each either Create new or Reuse library.
- Parameter: location, required, style, explode, allowReserved, a Form or JSON Schema view, and Apply from Designer property or Apply from primitive template.
- Response: a status code, range or
default; media types mapped to schemas; Examples; Headers with Pagination, Rate limiting and CORS templates; Links. - Request body: media types JSON, XML, Multipart, Form URL Encoded, Plain Text or Binary; a Class Reference or an Inline Schema, with Convert to Inline (copy properties).
On the classic canvas, drop a class onto a response to reference it and drop properties onto a path
parameter to bind them; operation nodes show their method, Private (x-private) and
Deprecated flags, and their Request, Parameters and Responses sections.
Security schemes and servers
Both belong to the document root — select it in the workspace tree ("servers and security schemes are edited there"), or open the classic sidebar's Security and Servers tabs.
Security schemes come in six types: API Key, HTTP (Basic, Bearer or a custom scheme), OAuth 2.0, OpenID Connect, Mutual TLS and Custom. On the classic canvas, drag a scheme onto a method node to apply it; in the workspace, set it in the operation's Security section.
Servers have a name, a URL (absolute or relative), an environment (Development, Staging, Production) and variables; the workspace lets you add, edit, reorder and remove them, and the first is the primary. Try-it offers absolute servers only.
Consumption
In the workspace's Combined lens, every operation is joined to the schemas it consumes by an edge — solid for a direct request or response schema, dashed for one nested through a parent. The palette action Find every path that consumes Class hydrates the set the other way round.
Journey view
The classic Paths editor's header toggle Canvas | Code | Journey adds two read-only views. Code shows the paths fragment or the merged OpenAPI document in YAML or JSON. Journey traces the consumer journey through the version's links: a Start point, a Direction (Downstream, Upstream, Both), a Trace (All responses, Happy path, Error path), a Depth, and Unresolved links only.
Documentation
Operation summaries and descriptions are what Scribe measures as coverage and fills in bulk — see Scribe. On the classic canvas, the operation's docs AI button drafts a description through Ollama ("No Ollama models available. Start Ollama or check OLLAMA_BASE_URL." when none is reachable).