Class SetIssueStateRequest
Moves an issue to another state. Requires an API key carrying the issue:write scope.
public record SetIssueStateRequest : IEquatable<SetIssueStateRequest>
- Inheritance
-
SetIssueStateRequest
- Implements
- Inherited Members
Remarks
The move is checked against the team's workflow. A transition the workflow does not permit is rejected, and the rejection names the states the issue can reach from where it is.
Properties
Resolution
Why the issue is ending, naming one of the workflow's resolutions. Required when State is terminal; rejected when it is not.
public string Resolution { get; init; }
Property Value
Remarks
Required on the way in and cleared on the way out, deliberately. A closed issue with no
reason is the ambiguity resolutions exist to remove, so the move is refused rather than
defaulted — guessing Done would quietly record a delivery that may not have happened.
Reopening clears it, so an issue that is closed, reopened and closed again cannot carry the
first decision's reason.
State
The state to move to. Must name a state defined by the team's workflow.
public required string State { get; init; }