突变

名称	描述
`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

Adds labels to a labelable object.

输入字段

input (AddLabelsToLabelableInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was labeled.

addProjectCard

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

输入字段

input (AddProjectCardInput!)

返回字段

名称描述

cardEdge (ProjectCardEdge)

The edge from the ProjectColumn's card connection.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The ProjectColumn.

addProjectColumn

Adds a column to a Project.

输入字段

input (AddProjectColumnInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.

addPullRequestReview

Adds a review to a Pull Request.

输入字段

input (AddPullRequestReviewInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The newly created pull request review.

reviewEdge (PullRequestReviewEdge)

The edge from the pull request's review connection.

addPullRequestReviewComment

Adds a comment to a review.

输入字段

input (AddPullRequestReviewCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created comment.

commentEdge (PullRequestReviewCommentEdge)

The edge from the review's comment connection.

addReaction

Adds a reaction to a subject.

输入字段

input (AddReactionInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.

addStar

Adds a star to a Starrable.

输入字段

input (AddStarInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

changeUserStatus

Update your status on GitHub.

输入字段

input (ChangeUserStatusInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.

clearLabelsFromLabelable

Clears all labels from a labelable object.

输入字段

input (ClearLabelsFromLabelableInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.

cloneProject

Creates a new project by cloning configuration from an existing project.

输入字段

input (CloneProjectInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

jobStatusId (String)

The id of the JobStatus for populating cloned fields.

project (Project)

The new cloned project.

cloneTemplateRepository

Create a new repository with the same files and directory structure as a template repository.

输入字段

input (CloneTemplateRepositoryInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

closeIssue

Close an issue.

输入字段

input (CloseIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.

closePullRequest

Close a pull request.

输入字段

input (ClosePullRequestInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was closed.

convertProjectCardNoteToIssue

Convert a project note card to one associated with a newly created issue.

输入字段

input (ConvertProjectCardNoteToIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

createBranchProtectionRule

Create a new branch protection rule.

输入字段

input (CreateBranchProtectionRuleInput!)

返回字段

名称描述

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckRun

Create a check run.

预览通知

createCheckRun is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

input (CreateCheckRunInput!)

返回字段

名称描述

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Create a check suite.

预览通知

createCheckSuite is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

input (CreateCheckSuiteInput!)

返回字段

名称描述

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createContentAttachment

Create a content attachment.

预览通知

createContentAttachment is available under the Create content attachments preview. During the preview period, the API may change without notice.

输入字段

input (CreateContentAttachmentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentAttachment (ContentAttachment)

The newly created content attachment.

createDeployment

Creates a new deployment event.

预览通知

createDeployment is available under the Deployments preview. During the preview period, the API may change without notice.

输入字段

input (CreateDeploymentInput!)

返回字段

名称描述

autoMerged (Boolean)

True if the default branch has been auto-merged into the deployment ref.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployment (Deployment)

The new deployment.

createDeploymentStatus

Create a deployment status.

预览通知

createDeploymentStatus is available under the Deployments preview. During the preview period, the API may change without notice.

输入字段

input (CreateDeploymentStatusInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.

createIssue

Creates a new issue.

输入字段

input (CreateIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.

createLabel

Creates a new label.

预览通知

createLabel is available under the Labels preview. During the preview period, the API may change without notice.

输入字段

input (CreateLabelInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.

createProject

Creates a new project.

输入字段

input (CreateProjectInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

createPullRequest

Create a new pull request.

输入字段

input (CreatePullRequestInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.

createRef

Create a new Git Ref.

输入字段

input (CreateRefInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.

createRepository

Create a new repository.

输入字段

input (CreateRepositoryInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

createTeamDiscussion

Creates a new team discussion.

预览通知

createTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

输入字段

input (CreateTeamDiscussionInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.

createTeamDiscussionComment

Creates a new team discussion comment.

预览通知

createTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

输入字段

input (CreateTeamDiscussionCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.

deleteBranchProtectionRule

Delete a branch protection rule.

输入字段

input (DeleteBranchProtectionRuleInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIssue

Deletes an Issue object.

输入字段

input (DeleteIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.

deleteIssueComment

Deletes an IssueComment object.

输入字段

input (DeleteIssueCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLabel

Deletes a label.

预览通知

deleteLabel is available under the Labels preview. During the preview period, the API may change without notice.

输入字段

input (DeleteLabelInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteProject

Deletes a project.

输入字段

input (DeleteProjectInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.

deleteProjectCard

Deletes a project card.

输入字段

input (DeleteProjectCardInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

column (ProjectColumn)

The column the deleted card was in.

deletedCardId (ID)

The deleted card ID.

deleteProjectColumn

Deletes a project column.

输入字段

input (DeleteProjectColumnInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.

deletePullRequestReview

Deletes a pull request review.

输入字段

input (DeletePullRequestReviewInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The deleted pull request review.

deletePullRequestReviewComment

Deletes a pull request review comment.

输入字段

input (DeletePullRequestReviewCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.

deleteRef

Delete a Git Ref.

输入字段

input (DeleteRefInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussion

Deletes a team discussion.

预览通知

deleteTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

输入字段

input (DeleteTeamDiscussionInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussionComment

Deletes a team discussion comment.

预览通知

deleteTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

输入字段

input (DeleteTeamDiscussionCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

dismissPullRequestReview

Dismisses an approved or rejected pull request review.

输入字段

input (DismissPullRequestReviewInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

importProject

Creates a new project by importing columns and a list of issues/PRs.

预览通知

importProject is available under the Import project preview. During the preview period, the API may change without notice.

输入字段

input (ImportProjectInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.

lockLockable

Lock a lockable object.

输入字段

input (LockLockableInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockedRecord (Lockable)

The item that was locked.

markPullRequestReadyForReview

Marks a pull request ready for review.

预览通知

markPullRequestReadyForReview is available under the Draft pull requests preview. During the preview period, the API may change without notice.

输入字段

input (MarkPullRequestReadyForReviewInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is ready for review.

mergeBranch

Merge a head into a branch.

输入字段

input (MergeBranchInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.

mergePullRequest

Merge a pull request.

输入字段

input (MergePullRequestInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was merged.

minimizeComment

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

预览通知

minimizeComment is available under the Minimize comments preview. During the preview period, the API may change without notice.

输入字段

input (MinimizeCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

minimizedComment (Minimizable)

The comment that was minimized.

moveProjectCard

Moves a project card to another place.

输入字段

input (MoveProjectCardInput!)

返回字段

名称描述

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.

moveProjectColumn

Moves a project column to another place.

输入字段

input (MoveProjectColumnInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.

pinIssue

Pin an issue to a repository.

预览通知

pinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

输入字段

input (PinIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.

removeAssigneesFromAssignable

Removes assignees from an assignable object.

输入字段

input (RemoveAssigneesFromAssignableInput!)

返回字段

名称描述

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

removeLabelsFromLabelable

Removes labels from a Labelable object.

输入字段

input (RemoveLabelsFromLabelableInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The Labelable the labels were removed from.

removeOutsideCollaborator

Removes outside collaborator from all repositories in an organization.

输入字段

input (RemoveOutsideCollaboratorInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

removedUser (User)

The user that was removed as an outside collaborator.

removeReaction

Removes a reaction from a subject.

输入字段

input (RemoveReactionInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.

removeStar

Removes a star from a Starrable.

输入字段

input (RemoveStarInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

reopenIssue

Reopen a issue.

输入字段

input (ReopenIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.

reopenPullRequest

Reopen a pull request.

输入字段

input (ReopenPullRequestInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reopened.

requestReviews

Set review requests on a pull request.

输入字段

input (RequestReviewsInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is getting requests.

requestedReviewersEdge (UserEdge)

The edge from the pull request to the requested reviewers.

rerequestCheckSuite

Rerequests an existing check suite.

预览通知

rerequestCheckSuite is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

input (RerequestCheckSuiteInput!)

返回字段

名称描述

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

resolveReviewThread

Marks a review thread as resolved.

输入字段

input (ResolveReviewThreadInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

submitPullRequestReview

Submits a pending pull request review.

输入字段

input (SubmitPullRequestReviewInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.

unlockLockable

Unlock a lockable object.

输入字段

input (UnlockLockableInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

unlockedRecord (Lockable)

The item that was unlocked.

unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

输入字段

input (UnmarkIssueAsDuplicateInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

The issue or pull request that was marked as a duplicate.

unminimizeComment

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

预览通知

unminimizeComment is available under the Minimize comments preview. During the preview period, the API may change without notice.

输入字段

input (UnminimizeCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

unminimizedComment (Minimizable)

The comment that was unminimized.

unpinIssue

Unpin a pinned issue from a repository.

预览通知

unpinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

输入字段

input (UnpinIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was unpinned.

unresolveReviewThread

Marks a review thread as unresolved.

输入字段

input (UnresolveReviewThreadInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

updateBranchProtectionRule

Create a new branch protection rule.

输入字段

input (UpdateBranchProtectionRuleInput!)

返回字段

名称描述

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckRun

Update a check run.

预览通知

updateCheckRun is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

input (UpdateCheckRunInput!)

返回字段

名称描述

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckSuitePreferences

Modifies the settings of an existing check suite.

预览通知

updateCheckSuitePreferences is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

input (UpdateCheckSuitePreferencesInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateIssue

Updates an Issue.

输入字段

input (UpdateIssueInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue.

updateIssueComment

Updates an IssueComment object.

输入字段

input (UpdateIssueCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.

updateLabel

Updates an existing label.

预览通知

updateLabel is available under the Labels preview. During the preview period, the API may change without notice.

输入字段

input (UpdateLabelInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The updated label.

updateProject

Updates an existing project.

输入字段

input (UpdateProjectInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.

updateProjectCard

Updates an existing project card.

输入字段

input (UpdateProjectCardInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

updateProjectColumn

Updates an existing project column.

输入字段

input (UpdateProjectColumnInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.

updatePullRequest

Update a pull request.

输入字段

input (UpdatePullRequestInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

updatePullRequestReview

Updates the body of a pull request review.

输入字段

input (UpdatePullRequestReviewInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The updated pull request review.

updatePullRequestReviewComment

Updates a pull request review comment.

输入字段

input (UpdatePullRequestReviewCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.

updateRef

Update a Git Ref.

输入字段

input (UpdateRefInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The updated Ref.

updateRepository

Update information about a repository.

输入字段

input (UpdateRepositoryInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateSubscription

Updates the state for subscribable subjects.

输入字段

input (UpdateSubscriptionInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.

updateTeamDiscussion

Updates a team discussion.

预览通知

updateTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

输入字段

input (UpdateTeamDiscussionInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.

updateTeamDiscussionComment

Updates a discussion comment.

预览通知

updateTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

输入字段

input (UpdateTeamDiscussionCommentInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.

updateTopics

Replaces the repository's topics with the given topics.

输入字段

input (UpdateTopicsInput!)

返回字段

名称描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

invalidTopicNames ([String!])

Names of the provided topics that are not valid.

repository (Repository)

The updated repository.