Interface ApiErrorContext

Context passed to the global onError policy callback. Identifies which operation failed so the policy can log, display, or filter by operation.

interface ApiErrorContext {
    operationId: string;
    path: string;
    method: HttpMethod;
    kind: "query" | "mutation";
}

Properties

operationId: string

The OpenAPI operationId, or "METHOD /path/template" when not set.

path: string

The OpenAPI path template, e.g. '/pets/{petId}'.

HTTP method of the operation.

kind: "query" | "mutation"

Whether the failure came from a query or a mutation.