Interface ApiErrorBody

Backward-compatible API error response. Only error is required.

interface ApiErrorBody {
    code?: ApiErrorCode;
    error: string;
    issues?: ApiFieldIssue[];
    requestId?: string;
}

Index

Properties

code? error issues? requestId?

Properties

`Optional`code

code?: ApiErrorCode

Stable error category, when one applies.

error

error: string

Short human-readable description; never contains internal details.

`Optional`issues

issues?: ApiFieldIssue[]

Safe validation issues for public, route-allowlisted fields.

`Optional`requestId

requestId?: string

Server correlation identifier matching the X-Request-ID header.