Class IssueReferenceRequest

Namespace

Quilt4Net.Toolkit.Features.Issue

Assembly

Quilt4Net.Toolkit.dll

One reference to write onto an issue. See IssueReferenceResponse for what the fields mean.

public record IssueReferenceRequest : IEquatable<IssueReferenceRequest>

Inheritance

object

IssueReferenceRequest

Implements

IEquatable<IssueReferenceRequest>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

References travel on CreateIssueRequest and UpdateIssueRequest rather than through add/remove endpoints of their own, which is where AddIssueLinkRequest goes. A link is an edge between two issues and needs the server to check it — a reason, a missing target, a cycle. A reference is a property of one issue with nothing to check against, so the endpoints that already replace an issue's fields are enough.

Properties

Kind

The source system. Lower-cased and whitespace-collapsed by the server, so GitHub and github are the same kind. Required.

public required string Kind { get; init; }

Property Value

string

Label

Display text. Optional — Value is shown when this is empty.

public string Label { get; init; }

Property Value

string

Role

Whether this is a hint or a key. Defaults to Provenance, which is the safe default: it claims nothing, whereas a wrongly-asserted Identity would block a later issue from claiming the ticket it really is.

public IssueReferenceRole Role { get; init; }

Property Value

IssueReferenceRole

Url

A link to the reference. Optional.

public string Url { get; init; }

Property Value

string

Value

What the reference points at within that system. Required.

public required string Value { get; init; }

Property Value

string