Class IssueResponse
One issue on a team's tracker.
public record IssueResponse : IEquatable<IssueResponse>
- Inheritance
-
IssueResponse
- Implements
- Inherited Members
Properties
AssignedUserKey
Key of the assigned team member, or empty when unassigned.
public required string AssignedUserKey { get; init; }
Property Value
Band
Where the issue sits on the roadmap's order axis.
public required RoadmapBand Band { get; init; }
Property Value
Claim
Who says they are working on this, and from which machine; null when nobody holds it.
public IssueClaimResponse Claim { get; init; }
Property Value
Remarks
Not required, for the reason given on References. null against an
older server means it cannot say, which reads the same as unclaimed — the safe interpretation,
since claiming an issue somebody else holds only ever warns.
Content
Body text. May be empty.
public required string Content { get; init; }
Property Value
CreatedUtc
When the issue was created (UTC).
public required DateTime CreatedUtc { get; init; }
Property Value
Effort
Rough size, or null when unsized.
public required IssueEffort? Effort { get; init; }
Property Value
Importance
How much this matters, or null when nobody has graded it yet. Paired with
Effort for the importance-then-effort ordering.
public required IssueImportance? Importance { get; init; }
Property Value
Links
Dependencies declared from this issue. An issue does not carry its inbound links; read the whole set, or the roadmap projection, to see those.
public required IssueLinkResponse[] Links { get; init; }
Property Value
Number
Per-team sequential number, and the issue's stable human reference (#12). Assigned by
the server on creation and never reused, including after a delete.
public required int Number { get; init; }
Property Value
Plan
How the issue will be delivered, as markdown. Empty when no plan has been written.
public string Plan { get; init; }
Property Value
Remarks
Not required, for the reason spelled out on References: this ships in the
Toolkit before the Server populates it, and empty reads as "no plan", which is true of every
issue an older server returns.
References
Where this issue came from, and the tickets it is. Empty when nothing was recorded.
public IssueReferenceResponse[] References { get; init; }
Property Value
Remarks
Deliberately not required, unlike every other property here. The Toolkit
publishes before the Server that populates it — the csproj comment in Quilt4Net.Server
spells out why that order cannot be reversed — so for the length of that window a client on
this version talks to a server that sends no references at all. A required member would
turn that window into a deserialization failure on every read; defaulting to empty makes it a
non-event.
Resolution
Why the issue ended, naming one of the workflow's resolutions. Empty unless State is terminal.
public string Resolution { get; init; }
Property Value
Remarks
Not required, for the reason spelled out on References: this ships in the
Toolkit before the Server populates it. Empty against a newer server means the issue is open;
empty against an older one means the server cannot say. Both read as "no decision recorded",
which is the safe interpretation of each.
Route
The named route this issue belongs to — the roadmap's lane. Empty when the issue belongs to no route, in which case it stays off the map.
public required string Route { get; init; }
Property Value
State
Current state, naming one of the states in the team's workflow. Changed through the state endpoint rather than a general update, so the transition can be validated.
public required string State { get; init; }
Property Value
SubState
Which phase the issue is in within State, naming one of that state's SubStates, or empty when none is set.
public string SubState { get; init; }
Property Value
Remarks
Not required, for the reason spelled out on References. Always empty on a
terminal state, where Resolution says how the issue ended.
SubStateSinceUtc
When the issue entered SubState (UTC), or null when it holds none — so a
card can say "Testing for 3 days".
public DateTime? SubStateSinceUtc { get; init; }
Property Value
Title
Short one-line summary.
public required string Title { get; init; }
Property Value
UpdatedUtc
When the issue was last changed (UTC).
public required DateTime UpdatedUtc { get; init; }
Property Value
Waiting
Set when the issue is flagged as waiting (#131), with what it waits for; null when it is
not. Not required, for the reason given on References.
public IssueWaitingResponse Waiting { get; init; }