我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 已停止服务 2021-03-02. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

突变

本文内容

关于突变

每个 GraphQL 架构的查询和突变都有根类型。 突变类型可定义用于更改服务器上数据的 GraphQL 操作。 此操作类似于执行 HTTP 请求方法,如 POSTPATCHDELETE

更多信息请参阅“关于突变。”

addAssigneesToAssignable

Adds assignees to an assignable object.

输入字段

返回字段

名称 描述

assignable (Assignable)

The item that was assigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.


addComment

Adds a comment to an Issue or Pull Request.

输入字段

返回字段

名称 描述

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.


addEnterpriseAdmin

Adds an administrator to the global enterprise account.

输入字段

返回字段

名称 描述

admin (User)

The user who was added as an administrator.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

role (EnterpriseAdministratorRole)

The role of the administrator.

viewer (User)

The viewer performing the mutation.


addLabelsToLabelable

Adds labels to a labelable object.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.


addPullRequestReviewThread

Adds a new thread to a pending Pull Request Review.

预览通知

addPullRequestReviewThread is available under the Multi line comments preview. During the preview period, the API may change without notice.

输入字段

预览通知

addPullRequestReviewThread is available under the Multi line comments preview. During the preview period, the API may change without notice.

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

addPullRequestReviewThread is available under the Multi line comments preview. During the preview period, the API may change without notice.

thread (PullRequestReviewThread)

The newly created thread.

预览通知

addPullRequestReviewThread is available under the Multi line comments preview. During the preview period, the API may change without notice.


addReaction

Adds a reaction to a subject.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


archiveRepository

Marks a repository as archived.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was marked as archived.


changeUserStatus

Update your status on GitHub.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.


clearLabelsFromLabelable

Clears all labels from a labelable object.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


closeIssue

Close an issue.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.


closePullRequest

Close a pull request.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


createBranchProtectionRule

Create a new branch protection rule.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

checkRun (CheckRun)

The newly created check run.

预览通知

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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


createCheckSuite

Create a check suite.

预览通知

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

输入字段

预览通知

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

返回字段

名称 描述

checkSuite (CheckSuite)

The newly created check suite.

预览通知

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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


createContentAttachment

Create a content attachment.

预览通知

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

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

contentAttachment (ContentAttachment)

The newly created content attachment.

预览通知

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


createDeployment

Creates a new deployment event.

预览通知

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

输入字段

预览通知

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

返回字段

名称 描述

autoMerged (Boolean)

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

预览通知

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

deployment (Deployment)

The new deployment.

预览通知

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


createDeploymentStatus

Create a deployment status.

预览通知

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

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

deploymentStatus (DeploymentStatus)

The new deployment status.

预览通知

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


createIssue

Creates a new issue.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

label (Label)

The new label.

预览通知

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


createProject

Creates a new project.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.


createPullRequest

Create a new pull request.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.


createRef

Create a new Git Ref.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.


createRepository

Create a new repository.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


createTeamDiscussion

Creates a new team discussion.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.


createTeamDiscussionComment

Creates a new team discussion comment.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.


deleteBranchProtectionRule

Delete a branch protection rule.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteIssue

Deletes an Issue object.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.


deleteIssueComment

Deletes an IssueComment object.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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


deleteProject

Deletes a project.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussion

Deletes a team discussion.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussionComment

Deletes a team discussion comment.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.


dismissPullRequestReview

Dismisses an approved or rejected pull request review.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.


followUser

Follow a user.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.


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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

project (Project)

The new Project!.

预览通知

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


linkRepositoryToProject

Creates a repository link for a project.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.


lockLockable

Lock a lockable object.

输入字段

返回字段

名称 描述

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.


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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

pullRequest (PullRequest)

The pull request that is ready for review.

预览通知

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


mergeBranch

Merge a head into a branch.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.


mergePullRequest

Merge a pull request.

输入字段

返回字段

名称 描述

actor (Actor)

Identifies the actor who performed the event.

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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

minimizedComment (Minimizable)

The comment that was minimized.

预览通知

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


moveProjectCard

Moves a project card to another place.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

issue (Issue)

The issue that was pinned.

预览通知

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


removeAssigneesFromAssignable

Removes assignees from an assignable object.

输入字段

返回字段

名称 描述

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.


removeEnterpriseAdmin

Removes an administrator from the enterprise.

输入字段

返回字段

名称 描述

admin (User)

The user who was removed as an administrator.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

message (String)

A message confirming the result of removing an administrator.

viewer (User)

The viewer performing the mutation.


removeLabelsFromLabelable

Removes labels from a Labelable object.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


reopenIssue

Reopen a issue.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.


reopenPullRequest

Reopen a pull request.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

checkSuite (CheckSuite)

The requested check suite.

预览通知

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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


resolveReviewThread

Marks a review thread as resolved.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


submitPullRequestReview

Submits a pending pull request review.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.


transferIssue

Transfer an issue to a different repository.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was transferred.


unarchiveRepository

Unarchives a repository.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was unarchived.


unfollowUser

Unfollow a user.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was unfollowed.


unlinkRepositoryFromProject

Deletes a repository link from a project.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.


unlockLockable

Unlock a lockable object.

输入字段

返回字段

名称 描述

actor (Actor)

Identifies the actor who performed the event.

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.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

unminimizedComment (Minimizable)

The comment that was unminimized.

预览通知

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


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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

issue (Issue)

The issue that was unpinned.

预览通知

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


unresolveReviewThread

Marks a review thread as unresolved.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


updateBranchProtectionRule

Create a new branch protection rule.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

checkRun (CheckRun)

The updated check run.

预览通知

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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


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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

repository (Repository)

The updated repository.

预览通知

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


updateEnterpriseActionExecutionCapabilitySetting

Sets the action execution capability setting for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated action execution capability setting.

message (String)

A message confirming the result of updating the action execution capability setting.


updateEnterpriseAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated allow private repository forking setting.

message (String)

A message confirming the result of updating the allow private repository forking setting.


updateEnterpriseDefaultRepositoryPermissionSetting

Sets the default repository permission for organizations in an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated default repository permission setting.

message (String)

A message confirming the result of updating the default repository permission setting.


updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Sets whether organization members with admin permissions on a repository can change repository visibility.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can change repository visibility setting.

message (String)

A message confirming the result of updating the members can change repository visibility setting.


updateEnterpriseMembersCanCreateRepositoriesSetting

Sets the members can create repositories setting for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can create repositories setting.

message (String)

A message confirming the result of updating the members can create repositories setting.


updateEnterpriseMembersCanDeleteIssuesSetting

Sets the members can delete issues setting for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete issues setting.

message (String)

A message confirming the result of updating the members can delete issues setting.


updateEnterpriseMembersCanDeleteRepositoriesSetting

Sets the members can delete repositories setting for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete repositories setting.

message (String)

A message confirming the result of updating the members can delete repositories setting.


updateEnterpriseMembersCanInviteCollaboratorsSetting

Sets whether members can invite collaborators are enabled for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can invite collaborators setting.

message (String)

A message confirming the result of updating the members can invite collaborators setting.


updateEnterpriseMembersCanMakePurchasesSetting

Sets whether or not an organization admin can make purchases.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can make purchases setting.

message (String)

A message confirming the result of updating the members can make purchases setting.


updateEnterpriseMembersCanUpdateProtectedBranchesSetting

Sets the members can update protected branches setting for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can update protected branches setting.

message (String)

A message confirming the result of updating the members can update protected branches setting.


updateEnterpriseMembersCanViewDependencyInsightsSetting

Sets the members can view dependency insights for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can view dependency insights setting.

message (String)

A message confirming the result of updating the members can view dependency insights setting.


updateEnterpriseOrganizationProjectsSetting

Sets whether organization projects are enabled for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated organization projects setting.

message (String)

A message confirming the result of updating the organization projects setting.


updateEnterpriseProfile

Updates an enterprise's profile.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.


updateEnterpriseRepositoryProjectsSetting

Sets whether repository projects are enabled for a enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated repository projects setting.

message (String)

A message confirming the result of updating the repository projects setting.


updateEnterpriseTeamDiscussionsSetting

Sets whether team discussions are enabled for an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated team discussions setting.

message (String)

A message confirming the result of updating the team discussions setting.


updateEnterpriseTwoFactorAuthenticationRequiredSetting

Sets whether two factor authentication is required for all users in an enterprise.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated two factor authentication required setting.

message (String)

A message confirming the result of updating the two factor authentication required setting.


updateIssue

Updates an Issue.

输入字段

返回字段

名称 描述

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue.


updateIssueComment

Updates an IssueComment object.

输入字段

返回字段

名称 描述

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.

输入字段

预览通知

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

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

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

label (Label)

The updated label.

预览通知

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


updateProject

Updates an existing project.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.


updateProjectCard

Updates an existing project card.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


updateProjectColumn

Updates an existing project column.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.


updatePullRequest

Update a pull request.

输入字段

返回字段

名称 描述

actor (Actor)

Identifies the actor who performed the event.

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.

输入字段

返回字段

名称 描述

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.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.


updateRef

Update a Git Ref.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The updated Ref.


updateRefs

Creates, updates and/or deletes multiple refs in a repository.

This mutation takes a list of RefUpdates and performs these updates on the repository. All updates are performed atomically, meaning that if one of them is rejected, no other ref will be modified.

RefUpdate.beforeOid specifies that the given reference needs to point to the given value before performing any updates. A value of 0000000000000000000000000000000000000000 can be used to verify that the references should not exist.

RefUpdate.afterOid specifies the value that the given reference will point to after performing all updates. A value of 0000000000000000000000000000000000000000 can be used to delete a reference.

If RefUpdate.force is set to true, a non-fast-forward updates for the given reference will be allowed.

预览通知

updateRefs is available under the Update refs preview. During the preview period, the API may change without notice.

输入字段

预览通知

updateRefs is available under the Update refs preview. During the preview period, the API may change without notice.

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

updateRefs is available under the Update refs preview. During the preview period, the API may change without notice.


updateRepository

Update information about a repository.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateSubscription

Updates the state for subscribable subjects.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.


updateTeamDiscussion

Updates a team discussion.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.


updateTeamDiscussionComment

Updates a discussion comment.

输入字段

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.


updateTeamReviewAssignment

Updates team review assignment.

预览通知

updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.

输入字段

预览通知

updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.

返回字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.

team (Team)

The team that was modified.

预览通知

updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.


updateTopics

Replaces the repository's topics with the given topics.

输入字段

返回字段

名称 描述

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.