DeliveryGate
A gate of a stage of a run, in one round.
Properties
idstring requiredThe ID of the gate.stageNamestring optionalThe name of the stage of the gate.roundinteger requiredThe round of the gate. A retry opens a new round.statusenum requiredThe status of the gate.Values:open,passed,closed- The conditions of the gate.
- ↳
idstring requiredThe ID of the condition. - ↳
namestring requiredThe name of the condition. - ↳
kindenum requiredThe kind of the condition:approval,decision, ormanual.Values:approval,decision,manual - ↳
stateenum requiredThe state of the condition:pending,satisfiedorrejected.Values:pending,satisfied,rejected - ↳
actorKindenum optionalWho satisfied or rejected the condition.Values:user,webhook,system,trigger - ↳
actorstring optionalThe login of the user who satisfied or rejected the condition. - ↳
descriptionstring optionalWhat the condition is for, as the pipeline program describes it. - Whether the caller can continue a manual condition.
- Whether the caller can approve or reject an approval condition. Only an eligible approver of its change request can.
- ↳
commentstring optionalThe comment of the person who continued a manual condition. - ↳
changeRequestIdstring optionalThe ID of the change request of an approval. - ↳
changeRequestStatusstring optionalThe status of the change request of an approval:draft,pending,ready,appliedorclosed. - ↳
requiredApprovalsinteger optionalThe number of approvals that an approval condition needs. - ↳
approvalsinteger optionalThe number of approvals that count now. - ↳
eligibleApproversarray[string] optionalThe names of the users and teams that can approve. Empty means anyone with the pipeline:approve permission on the pipeline stack. - ↳
detailsmap[string]object optionalFacts about the condition. For an approval, the message that says why it cannot get its change request. For a decision, the outcome and answers of its last evaluation, or the message of its last failure and the time of the next attempt. - The rule of the gate with its satisfaction.
- ↳
kindenum requiredThe kind of the node.Values:all,any,approval,decision,manual - ↳
namestring optionalThe name of the condition. Set for a condition, not forallandany. - ↳
satisfiedboolean requiredWhether the node is satisfied. - The children of an
alloranynode. createdAtstring requiredWhen the gate opened.passedAtstring optionalWhen the gate passed.closedAtstring optionalWhen the gate closed.closeReasonenum optionalWhy a closed gate closed.Values:canceled— Canceled- The run was canceled.
failed— Failed- The run failed.
superseded— Superseded- A newer release superseded the run.
ended— Ended- The run ended.
stage_converged— StageConverged- The stage converged.
closedByKindenum optionalWho closed the gate: a user, or the system for a supersede, a failure or the end of the run.Values:user,webhook,system,triggerclosedBystring optionalThe login of the user who closed the gate, for example by canceling the run.