Guides

Editing endpoints

Form-based editing for parameters, request bodies, responses, and security.

Updated

The Edit tab is where you author each operation in your spec. Open it by clicking an endpoint in the flow builder.

What you can edit

  • Summary & description — short label and the markdown-supporting body.
  • Tags — group operations for the docs view.
  • Parameters — query, header, path, cookie. Each gets a name, type, required flag, description, and example.
  • Request body — content types, schema (JSON Schema subset), examples.
  • Responses — status codes with their headers, content types, schemas.
  • Security — which security schemes apply (inherited from the spec by default).

Working with parameters

Click Add parameter to create one. For each parameter:

  1. Pick the location: query, header, path, cookie.
  2. Set the type (string, integer, boolean, array, object) and any constraints.
  3. Mark it required if the operation needs it.
  4. Add a description and an example — both feed the runner and the public docs.

Path parameters (those in {braces}) are linked to the path segment they appear in. Renaming the segment renames the parameter and vice versa.

Request bodies

For POST / PUT / PATCH, click Add request body:

  • Pick a content type (application/json is the default; you can add more).
  • Author the schema directly, or click Reference to point at a shared schema.
  • Provide one or more examples — the first is auto-loaded as the runner’s body.

When you reference a shared schema, a “used by N operations” badge appears so you know what else changes if you edit the schema. See Schemas.

Responses

Every response code can carry headers, content types, schemas, and examples. The most useful field is the schema — once defined, the runner validates real responses against it and surfaces violations.

Security

Security schemes are defined once on the spec and referenced per-operation. From the operation’s security section you can:

  • Inherit the spec-level requirement (default).
  • Override with a specific scheme.
  • Mark the operation as public (no auth).

Stored credentials live at the workspace level — see Workspaces.

WebSocket endpoints

WebSocket operations have a different editor — see WebSocket endpoints.

Auto-save

Changes save automatically two seconds after you stop typing. The header shows a “saving…” indicator briefly; a green check confirms the save. Undo / redo is Cmd/Ctrl Z / Cmd/Ctrl Shift Z.