WalkDescriptor
Interface: WalkDescriptor
Defined in: src/core/runbook/types.ts:226
The recorded-walk descriptor — ALWAYS on the spine. The walk itself ships
as an artifact ticket (ref), never as bytes in the envelope; with no
store attached (or a failed mint) the descriptor still states its
counters and the note names why there is no ticket — a missing walk must
never be mistaken for a short run.
Properties
complete
readonlycomplete:boolean
Defined in: src/core/runbook/types.ts:243
kind?
readonlyoptionalkind?:string
Defined in: src/core/runbook/types.ts:231
The artifact kind ('recording/chart-walk'). Present with ref.
note
readonlynote:string
Defined in: src/core/runbook/types.ts:254
The human sentence: what the walk is, and (when projected) what the control-flow projection kept and dropped, or why there is no ticket.
projection
readonlyprojection:"full"|"control-flow"
Defined in: src/core/runbook/types.ts:240
'full' — every narrative entry fit under the cap; 'control-flow' —
it did not, and the stages/forks/subflows/decisions survived while the
per-key reads and writes were dropped.
recording_bytes?
readonlyoptionalrecording_bytes?:number
Defined in: src/core/runbook/types.ts:276
The recording's size in bytes. Present on the SUCCESS path (the store's own measurement) AND on the over-size refusal (what it measured, beside the ceiling it broke) — the one number that makes a size decision checkable instead of mysterious.
recording_kind?
readonlyoptionalrecording_kind?:string
Defined in: src/core/runbook/types.ts:269
The recording's artifact kind ('recording/run'). Present with
recording_ref.
recording_note?
readonlyoptionalrecording_note?:string
Defined in: src/core/runbook/types.ts:283
The human sentence about the recording: what a filed one CONTAINS beyond
the walk's row projection, or the named reason there is no
recording_ref. Present whenever a recording was asked for — silence is
not an allowed answer to "why is the ref missing".
recording_ref?
readonlyoptionalrecording_ref?:string
Defined in: src/core/runbook/types.ts:266
The claim-ticket ref of the inner chart's own { snapshot, events, structure } recording — what the lens/explainable-UI flow components
mount to draw this walk as the flowchart it ran. Absent when the mint was
refused or failed; recording_note says which, and never stays silent.
ref?
readonlyoptionalref?:string
Defined in: src/core/runbook/types.ts:229
The claim-ticket ref of the minted walk artifact. Absent when no store
is attached or the mint failed — note says which.
rows
readonlyrows:number
Defined in: src/core/runbook/types.ts:233
Rows in the minted artifact.
shown
readonlyshown:number
Defined in: src/core/runbook/types.ts:241
steps_executed
readonlysteps_executed:number
Defined in: src/core/runbook/types.ts:236
Total execution steps the narrative recorder counted — spans isolated subflow logs, which the root commit log cannot.
total
readonlytotal:number
Defined in: src/core/runbook/types.ts:242
walk_segment
readonlywalk_segment:"full"|"pre-pause"|"post-resume"
Defined in: src/core/runbook/types.ts:251
WHICH SEGMENT of the run this walk covers. 'full' for an un-gated run
(all of phase 1). When approval gates land, a resumed run's recorders
start empty on the fresh executor — its walk will say 'post-resume'
and its counters will count only that segment; the discriminant ships
NOW so the wire does not break then.