gatelineAPI reference

Interface RunDescriptionInput

interface RunDescriptionInput {
    brief: null | string;
    closure?: null | { as: string; by: null | string; reason: null | string };
    gates: { approved: boolean; id: string }[];
    phase: null | string;
    profile: null | "patch" | "standard" | "full";
    runDir: string;
    slug: string;
    spec: null | string;
}

Properties

brief closure? gates phase profile runDir slug spec

Properties

brief

brief: null | string

runs/<slug>/intent-brief.md, or null when unreadable.

Optionalclosure

closure?: null | { as: string; by: null | string; reason: null | string }

The closure record when the run was closed short of done (#200).

gates

gates: { approved: boolean; id: string }[]

Gate ledger in profile order, for the banner's progress line.

phase

phase: null | string

The run's phase, for the in-flight banner; null when state is unreadable.

profile

profile: null | "patch" | "standard" | "full"

runDir

runDir: string

runs/<slug> as it sits in this repo's layout (prefixed hosts differ).

slug

slug: string

spec

spec: null | string

runs/<slug>/spec.md once the analyst has produced it, else null.

Settings

Member Visibility

On This Page

Properties