Skip to main content

Issues

Reference documentation for GraphQL schema types in the Issues category.

In this article

Mutations

addAssigneesToAssignable

Mutation

Adds assignees to an assignable object.

Input fields for addAssigneesToAssignable

Return fields for addAssigneesToAssignable

NameDescription

assignable (Assignable)

The item that was assigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

addBlockedBy

Mutation

Adds a 'blocked by' relationship to an issue.

Input fields for addBlockedBy

Return fields for addBlockedBy

NameDescription

blockingIssue (Issue)

The issue that is blocking the given issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that is blocked.

addComment

Mutation

Adds a comment to an Issue or Pull Request.

Input fields for addComment

Return fields for addComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentEdge (IssueCommentEdge)

The edge from the subject's comment connection.

subject (Node)

The subject.

timelineEdge (IssueTimelineItemEdge)

The edge from the subject's timeline connection.

addLabelsToLabelable

Mutation

Adds labels to a labelable object.

Input fields for addLabelsToLabelable

Return fields for addLabelsToLabelable

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was labeled.

addSubIssue

Mutation

Adds a sub-issue to a given issue.

Input fields for addSubIssue

Return fields for addSubIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The parent issue that the sub-issue was added to.

subIssue (Issue)

The sub-issue of the parent.

clearLabelsFromLabelable

Mutation

Clears all labels from a labelable object.

Input fields for clearLabelsFromLabelable

Return fields for clearLabelsFromLabelable

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.

closeIssue

Mutation

Close an issue.

Input fields for closeIssue

Return fields for closeIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.

createIssue

Mutation

Creates a new issue.

Input fields for createIssue

Return fields for createIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.

createIssueType

Mutation

Creates a new issue type.

Input fields for createIssueType

Return fields for createIssueType

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueType (IssueType)

The newly created issue type.

createLabel

Mutation

Creates a new label.

Input fields for createLabel

Return fields for createLabel

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.

createLinkedBranch

Mutation

Create a branch linked to an issue.

Input fields for createLinkedBranch

Return fields for createLinkedBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was linked to.

linkedBranch (LinkedBranch)

The new branch issue reference.

deleteIssue

Mutation

Deletes an Issue object.

Input fields for deleteIssue

Return fields for deleteIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.

deleteIssueComment

Mutation

Deletes an IssueComment object.

Input fields for deleteIssueComment

Return fields for deleteIssueComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIssueType

Mutation

Delete an issue type.

Input fields for deleteIssueType

Return fields for deleteIssueType

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedIssueTypeId (ID)

The ID of the deleted issue type.

deleteLabel

Mutation

Deletes a label.

Input fields for deleteLabel

Return fields for deleteLabel

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLinkedBranch

Mutation

Unlink a branch from an issue.

Input fields for deleteLinkedBranch

Return fields for deleteLinkedBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue the linked branch was unlinked from.

lockLockable

Mutation

Lock a lockable object.

Input fields for lockLockable

Return fields for lockLockable

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockedRecord (Lockable)

The item that was locked.

minimizeComment

Mutation

Minimizes a comment on an Issue, Commit, Pull Request, or Gist.

Input fields for minimizeComment

Return fields for minimizeComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

minimizedComment (Minimizable)

The comment that was minimized.

pinIssue

Mutation

Pin an issue to a repository.

Input fields for pinIssue

Return fields for pinIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.

removeAssigneesFromAssignable

Mutation

Removes assignees from an assignable object.

Input fields for removeAssigneesFromAssignable

Return fields for removeAssigneesFromAssignable

NameDescription

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

removeBlockedBy

Mutation

Removes a 'blocked by' relationship from an issue.

Input fields for removeBlockedBy

Return fields for removeBlockedBy

NameDescription

blockingIssue (Issue)

The previously blocking issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The previously blocked issue.

removeLabelsFromLabelable

Mutation

Removes labels from a Labelable object.

Input fields for removeLabelsFromLabelable

Return fields for removeLabelsFromLabelable