Skip to main content
Transport request.

Properties

path

readonly path: string
Relative API path. Example: /execute

method

readonly method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
HTTP method.

body?

readonly optional body?: unknown
Optional request body.

headers?

readonly optional headers?: Readonly<Record<string, string>>
Optional request headers.

nonThrowingStatuses?

readonly optional nonThrowingStatuses?: readonly number[]
HTTP status codes that must be returned as an ordinary TransportResponse instead of being mapped to a thrown ParmanaError subclass, because this specific route’s response body at that specific status is not the shared {error, code?} envelope. Default: none (every status >= 400 throws). Today exactly one route needs this: POST /policies/validate returns {valid, errors} — not {error, code?} — at 400 and 404 (but the shared envelope still applies to 401, generated by caller-auth middleware before this route’s own handler ever runs). See PolicyApi.validate and /api-reference/error-handling.