Class SetIssueWorkflowRequest

Namespace

Quilt4Net.Toolkit.Features.Issue

Assembly

Quilt4Net.Toolkit.dll

Replaces a team's issue workflow. Requires an API key carrying the issue:write scope.

public record SetIssueWorkflowRequest : IEquatable<SetIssueWorkflowRequest>

Inheritance

object

SetIssueWorkflowRequest

Implements

IEquatable<SetIssueWorkflowRequest>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The replacement is validated before anything is written: exactly one state must be initial, every transition must name states that exist, and every state currently in use by an issue must still be defined. A workflow that would orphan live issues is rejected and the error names them, rather than leaving issues in a state the workflow no longer knows about.

Properties

Resolutions

The ways an issue may end. Validated like the states: names must be unique, and a resolution currently held by an issue must still be defined.

public IssueWorkflowResolutionResponse[] Resolutions { get; init; }

Property Value

IssueWorkflowResolutionResponse[]

Remarks

Optional so a caller that does not care about resolutions can keep sending the old two-field payload. Note what that means, because it is a replace rather than a merge: omitting this on a team that has resolutions asks to remove them, and will be refused while any issue still holds one — the same protection the states already get.

States

The states to define, in display order.

public required IssueWorkflowStateResponse[] States { get; init; }

Property Value

IssueWorkflowStateResponse[]

Transitions

The moves to permit.

public required IssueWorkflowTransitionResponse[] Transitions { get; init; }

Property Value

IssueWorkflowTransitionResponse[]