inderunErrorSchema

const inderunErrorSchema: object

The JSON Schemas those models were generated from, for runtime use.

Type Declaration

$id

readonly $id: "https://schemas.inderun.dev/1.0/inderun-error.schema.json"

$schema

readonly $schema: "https://json-schema.org/draft/2020-12/schema"

additionalProperties

readonly additionalProperties: true

description

readonly description: "The error shape thrown by run() (wrapped in an IndeRunException) when execution fails — via validation, routing (no eligible provider), or every attempted provider failing. Never returned as part of a successful TaskResult."

properties

readonly properties: object

properties.details

readonly details: object

properties.details.additionalProperties

readonly additionalProperties: true

properties.details.description

readonly description: "Optional structured diagnostic details. It must not contain raw secrets."

properties.details.type

readonly type: "object"

properties.errorClass

readonly errorClass: object

properties.errorClass.description

readonly description: "Normalized error taxonomy, shared with TaskResult.telemetry.errorClass: CapabilityMismatch (request needs something no eligible provider supports), Offline/Unavailable (provider unreachable or not ready), AuthError (credential/auth failure), RateLimited (provider throttled the request), Timeout (provider exceeded its execution budget), Internal (unexpected engine-side failure)."

properties.errorClass.enum

readonly enum: readonly ["CapabilityMismatch", "Offline", "AuthError", "RateLimited", "Timeout", "Unavailable", "Internal"]

properties.message

readonly message: object

properties.message.description

readonly description: "Human-readable error message suitable for logs and developer diagnostics."

properties.message.minLength

readonly minLength: 1

properties.message.type

readonly type: "string"

properties.provenance

readonly provenance: object

properties.provenance.$ref

readonly $ref: "execution-provenance.schema.json"

properties.provenance.description

readonly description: "Normalized execution provenance: which target ran, its declared locality, the configured and reported model, and how fallback and routing played out. See execution-provenance.schema.json."

properties.providerId

readonly providerId: object

properties.providerId.description

readonly description: "Identifier of the provider associated with the failure, if execution reached a provider."

properties.providerId.minLength

readonly minLength: 1

properties.providerId.type

readonly type: "string"

properties.retryable

readonly retryable: object

properties.retryable.description

readonly description: "Whether retrying the same request may succeed."

properties.retryable.type

readonly type: "boolean"

properties.retryAfterMs

readonly retryAfterMs: object

properties.retryAfterMs.description

readonly description: "Optional suggested delay before retrying, in milliseconds."

properties.retryAfterMs.minimum

readonly minimum: 0

properties.retryAfterMs.type

readonly type: "integer"

properties.runId

readonly runId: object

properties.runId.description

readonly description: "Opaque run identifier associated with the failed execution, if available."

properties.runId.minLength

readonly minLength: 1

properties.runId.type

readonly type: "string"

properties.schemaVersion

readonly schemaVersion: object

properties.schemaVersion.const

readonly const: "1.0"

properties.schemaVersion.description

readonly description: "Contract schema version used to interpret the error payload."

required

readonly required: readonly ["schemaVersion", "errorClass", "message"]

title

readonly title: "IndeRunError"

type

readonly type: "object"