Skip to main content

变更类型定义更改服务器数据的 GraphQL 操作。

本文内容

关于突变

每个 GraphQL 架构的查询和突变都有根类型。 变更类型定义更改服务器数据的 GraphQL 操作。 类似于执行 Http 谓词,例如 POSTPATCHDELETE

有关详细信息,请参阅“使用 GraphQL 建立调用”。

abortQueuedMigrations

Clear all of a customer's queued migrations.

输入 abortQueuedMigrations 字段

返回 abortQueuedMigrations 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

addAssigneesToAssignable

Adds assignees to an assignable object.

输入 addAssigneesToAssignable 字段

返回 addAssigneesToAssignable 字段

名称说明

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.

输入 addComment 字段

返回 addComment 字段

名称说明

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.

addDiscussionComment

Adds a comment to a Discussion, possibly as a reply to another comment.

输入 addDiscussionComment 字段

返回 addDiscussionComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The newly created discussion comment.

addDiscussionPollVote

Vote for an option in a discussion poll.

输入 addDiscussionPollVote 字段

返回 addDiscussionPollVote 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOption (DiscussionPollOption)

The poll option that a vote was added to.

addEnterpriseAdmin

Adds an administrator to the global enterprise account.

输入 addEnterpriseAdmin 字段

返回 addEnterpriseAdmin 字段

名称说明

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.

addEnterpriseOrganizationMember

Adds enterprise members to an organization within the enterprise.

输入 addEnterpriseOrganizationMember 字段

返回 addEnterpriseOrganizationMember 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

users ([User!])

The users who were added to the organization.

addLabelsToLabelable

Adds labels to a labelable object.

输入 addLabelsToLabelable 字段

返回 addLabelsToLabelable 字段

名称说明

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.

输入 addProjectCard 字段

返回 addProjectCard 字段

名称说明

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.

输入 addProjectColumn 字段

返回 addProjectColumn 字段

名称说明

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.

addProjectV2DraftIssue

Creates a new draft issue and add it to a Project.

输入 addProjectV2DraftIssue 字段

返回 addProjectV2DraftIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectItem (ProjectV2Item)

The draft issue added to the project.

addProjectV2ItemById

Links an existing content instance to a Project.

输入 addProjectV2ItemById 字段

返回 addProjectV2ItemById 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item added to the project.

addPullRequestReview

Adds a review to a Pull Request.

输入 addPullRequestReview 字段

返回 addPullRequestReview 字段

名称说明

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.

输入 addPullRequestReviewComment 字段

返回 addPullRequestReviewComment 字段

名称说明

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 字段

返回 addPullRequestReviewThread 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.

addReaction

Adds a reaction to a subject.

输入 addReaction 字段

返回 addReaction 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

reactionGroups ([ReactionGroup!])

The reaction groups for the subject.

subject (Reactable)

The reactable subject.

addStar

Adds a star to a Starrable.

输入 addStar 字段

返回 addStar 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

addUpvote

Add an upvote to a discussion or discussion comment.

输入 addUpvote 字段

返回 addUpvote 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

addVerifiableDomain

Adds a verifiable domain to an owning account.

输入 addVerifiableDomain 字段

返回 addVerifiableDomain 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was added.

approveDeployments

Approve all pending deployments under one or more environments.

输入 approveDeployments 字段

返回 approveDeployments 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

approveVerifiableDomain

Approve a verifiable domain for notification delivery.

输入 approveVerifiableDomain 字段

返回 approveVerifiableDomain 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was approved.

archiveProjectV2Item

Archives a ProjectV2Item.

输入 archiveProjectV2Item 字段

返回 archiveProjectV2Item 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item archived from the project.

archiveRepository

Marks a repository as archived.

输入 archiveRepository 字段

返回 archiveRepository 字段

名称说明

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.

输入 changeUserStatus 字段

返回 changeUserStatus 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.

clearLabelsFromLabelable

Clears all labels from a labelable object.

输入 clearLabelsFromLabelable 字段

返回 clearLabelsFromLabelable 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.

clearProjectV2ItemFieldValue

This mutation clears the value of a field for an item in a Project. Currently only text, number, date, assignees, labels, single-select, iteration and milestone fields are supported.

输入 clearProjectV2ItemFieldValue 字段

返回 clearProjectV2ItemFieldValue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

cloneProject

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

输入 cloneProject 字段

返回 cloneProject 字段

名称说明

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.

输入 cloneTemplateRepository 字段

返回 cloneTemplateRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

closeDiscussion

Close a discussion.

输入 closeDiscussion 字段

返回 closeDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was closed.

closeIssue

Close an issue.

输入 closeIssue 字段

返回 closeIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.

closePullRequest

Close a pull request.

输入 closePullRequest 字段

返回 closePullRequest 字段

名称说明

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.

输入 convertProjectCardNoteToIssue 字段

返回 convertProjectCardNoteToIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

convertPullRequestToDraft

Converts a pull request to draft.

输入 convertPullRequestToDraft 字段

返回 convertPullRequestToDraft 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is now a draft.

copyProjectV2

Copy a project.

输入 copyProjectV2 字段

返回 copyProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The copied project.

createAttributionInvitation

Invites a user to claim reattributable data.

输入 createAttributionInvitation 字段

返回 createAttributionInvitation 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (Organization)

The owner scoping the reattributable data.

source (Claimable)

The account owning the data to reattribute.

target (Claimable)

The account which may claim the data.

createBranchProtectionRule

Create a new branch protection rule.

输入 createBranchProtectionRule 字段

返回 createBranchProtectionRule 字段

名称说明

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckRun

Create a check run.

输入 createCheckRun 字段

返回 createCheckRun 字段

名称说明

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Create a check suite.

输入 createCheckSuite 字段

返回 createCheckSuite 字段

名称说明

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCommitOnBranch

Appends a commit to the given branch as the authenticated user.

This mutation creates a commit whose parent is the HEAD of the provided branch and also updates that branch to point to the new commit. It can be thought of as similar to git commit.

Locating a Branch

Commits are appended to a branch of type Ref. This must refer to a git branch (i.e. the fully qualified path must begin with refs/heads/, although including this prefix is optional.

Callers may specify the branch to commit to either by its global node ID or by passing both of repositoryNameWithOwner and refName. For more details see the documentation for CommittableBranch.

Describing Changes

fileChanges are specified as a FilesChanges object describing FileAdditions and FileDeletions.

Please see the documentation for FileChanges for more information on how to use this argument to describe any set of file changes.

Authorship

Similar to the web commit interface, this mutation does not support specifying the author or committer of the commit and will not add support for this in the future.

A commit created by a successful execution of this mutation will be authored by the owner of the credential which authenticates the API request. The committer will be identical to that of commits authored using the web interface.

If you need full control over author and committer information, please use the Git Database REST API instead.

Commit Signing

Commits made using this mutation are automatically signed by GitHub if supported and will be marked as verified in the user interface.

输入 createCommitOnBranch 字段

返回 createCommitOnBranch 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

commit (Commit)

The new commit.

ref (Ref)

The ref which has been updated to point to the new commit.

createDeployment

Creates a new deployment event.

注意

createDeployment is available under the Deployments preview. 在预览期间,API 可能会更改,恕不通知。

输入 createDeployment 字段

返回 createDeployment 字段

名称说明

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. 在预览期间,API 可能会更改,恕不通知。

输入 createDeploymentStatus 字段

返回 createDeploymentStatus 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.

createDiscussion

Create a discussion.

输入 createDiscussion 字段

返回 createDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just created.

createEnterpriseOrganization

Creates an organization as part of an enterprise account.

输入 createEnterpriseOrganization 字段

返回 createEnterpriseOrganization 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise that owns the created organization.

organization (Organization)

The organization that was created.

createEnvironment

Creates an environment or simply returns it if already exists.

输入 createEnvironment 字段

返回 createEnvironment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The new or existing environment.

createIpAllowListEntry

Creates a new IP allow list entry.

输入 createIpAllowListEntry 字段

返回 createIpAllowListEntry 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was created.

createIssue

Creates a new issue.

输入 createIssue 字段

返回 createIssue 字段

名称说明

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. 在预览期间,API 可能会更改,恕不通知。

输入 createLabel 字段

返回 createLabel 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.

createLinkedBranch

Create a branch linked to an issue.

输入 createLinkedBranch 字段

返回 createLinkedBranch 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

linkedBranch (LinkedBranch)

The new branch issue reference.

createMigrationSource

Creates a GitHub Enterprise Importer (GEI) migration source.

输入 createMigrationSource 字段

返回 createMigrationSource 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationSource (MigrationSource)

The created migration source.

createProject

Creates a new project.

输入 createProject 字段

返回 createProject 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

createProjectV2

Creates a new project.

输入 createProjectV2 字段

返回 createProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The new project.

createProjectV2Field

Create a new project field.

输入 createProjectV2Field 字段

返回 createProjectV2Field 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createPullRequest

Create a new pull request.

输入 createPullRequest 字段

返回 createPullRequest 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.

createRef

Create a new Git Ref.

输入 createRef 字段

返回 createRef 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.

createRepository

Create a new repository.

输入 createRepository 字段

返回 createRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

createTeamDiscussion

Creates a new team discussion.

输入 createTeamDiscussion 字段

返回 createTeamDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.

createTeamDiscussionComment

Creates a new team discussion comment.

输入 createTeamDiscussionComment 字段

返回 createTeamDiscussionComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.

deleteBranchProtectionRule

Delete a branch protection rule.

输入 deleteBranchProtectionRule 字段

返回 deleteBranchProtectionRule 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDeployment

Deletes a deployment.

输入 deleteDeployment 字段

返回 deleteDeployment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDiscussion

Delete a discussion and all of its replies.

输入 deleteDiscussion 字段

返回 deleteDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just deleted.

deleteDiscussionComment

Delete a discussion comment. If it has replies, wipe it instead.

输入 deleteDiscussionComment 字段

返回 deleteDiscussionComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The discussion comment that was just deleted.

deleteEnvironment

Deletes an environment.

输入 deleteEnvironment 字段

返回 deleteEnvironment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIpAllowListEntry

Deletes an IP allow list entry.

输入 deleteIpAllowListEntry 字段

返回 deleteIpAllowListEntry 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was deleted.

deleteIssue

Deletes an Issue object.

输入 deleteIssue 字段

返回 deleteIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.

deleteIssueComment

Deletes an IssueComment object.

输入 deleteIssueComment 字段

返回 deleteIssueComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLabel

Deletes a label.

注意

deleteLabel is available under the Labels preview. 在预览期间,API 可能会更改,恕不通知。

输入 deleteLabel 字段

返回 deleteLabel 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLinkedBranch

Unlink a branch from an issue.

输入 deleteLinkedBranch 字段

返回 deleteLinkedBranch 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue the linked branch was unlinked from.

deletePackageVersion

Delete a package version.

注意

deletePackageVersion is available under the Access to package version deletion preview. 在预览期间,API 可能会更改,恕不通知。

输入 deletePackageVersion 字段

返回 deletePackageVersion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Whether or not the operation succeeded.

deleteProject

Deletes a project.

输入 deleteProject 字段

返回 deleteProject 字段

名称说明

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.

输入 deleteProjectCard 字段

返回 deleteProjectCard 字段

名称说明

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.

输入 deleteProjectColumn 字段

返回 deleteProjectColumn 字段

名称说明

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.

deleteProjectV2

Delete a project.

输入 deleteProjectV2 字段

返回 deleteProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The deleted Project.

deleteProjectV2Field

Delete a project field.

输入 deleteProjectV2Field 字段

返回 deleteProjectV2Field 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The deleted field.

deleteProjectV2Item

Deletes an item from a Project.

输入 deleteProjectV2Item 字段

返回 deleteProjectV2Item 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

deleteProjectV2Workflow

Deletes a project workflow.

输入 deleteProjectV2Workflow 字段

返回 deleteProjectV2Workflow 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedWorkflowId (ID)

The ID of the deleted workflow.

projectV2 (ProjectV2)

The project the deleted workflow was in.

deletePullRequestReview

Deletes a pull request review.

输入 deletePullRequestReview 字段

返回 deletePullRequestReview 字段

名称说明

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.

输入 deletePullRequestReviewComment 字段

返回 deletePullRequestReviewComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.

pullRequestReviewComment (PullRequestReviewComment)

The deleted pull request review comment.

deleteRef

Delete a Git Ref.

输入 deleteRef 字段

返回 deleteRef 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussion

Deletes a team discussion.

输入 deleteTeamDiscussion 字段

返回 deleteTeamDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussionComment

Deletes a team discussion comment.

输入 deleteTeamDiscussionComment 字段

返回 deleteTeamDiscussionComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteVerifiableDomain

Deletes a verifiable domain.

输入 deleteVerifiableDomain 字段

返回 deleteVerifiableDomain 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owning account from which the domain was deleted.

disablePullRequestAutoMerge

Disable auto merge on the given pull request.

输入 disablePullRequestAutoMerge 字段

返回 disablePullRequestAutoMerge 字段

名称说明

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 auto merge was disabled on.

dismissPullRequestReview

Dismisses an approved or rejected pull request review.

输入 dismissPullRequestReview 字段

返回 dismissPullRequestReview 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

dismissRepositoryVulnerabilityAlert

Dismisses the Dependabot alert.

输入 dismissRepositoryVulnerabilityAlert 字段

返回 dismissRepositoryVulnerabilityAlert 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryVulnerabilityAlert (RepositoryVulnerabilityAlert)

The Dependabot alert that was dismissed.

enablePullRequestAutoMerge

Enable the default auto-merge on a pull request.

输入 enablePullRequestAutoMerge 字段

返回 enablePullRequestAutoMerge 字段

名称说明

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 auto-merge was enabled on.

followOrganization

Follow an organization.

输入 followOrganization 字段

返回 followOrganization 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was followed.

followUser

Follow a user.

输入 followUser 字段

返回 followUser 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.

grantEnterpriseOrganizationsMigratorRole

Grant the migrator role to a user for all organizations under an enterprise account.

输入 grantEnterpriseOrganizationsMigratorRole 字段

返回 grantEnterpriseOrganizationsMigratorRole 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role applied to for the given user.

grantMigratorRole

Grant the migrator role to a user or a team.

输入 grantMigratorRole 字段

返回 grantMigratorRole 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

importProject

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

注意

importProject is available under the Import project preview. 在预览期间,API 可能会更改,恕不通知。

输入 importProject 字段

返回 importProject 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.

linkProjectV2ToRepository

Links a project to a repository.

输入 linkProjectV2ToRepository 字段

返回 linkProjectV2ToRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is linked to.

linkProjectV2ToTeam

Links a project to a team.

输入 linkProjectV2ToTeam 字段

返回 linkProjectV2ToTeam 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is linked to.

linkRepositoryToProject

Creates a repository link for a project.

输入 linkRepositoryToProject 字段

返回 linkRepositoryToProject 字段

名称说明

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.

输入 lockLockable 字段

返回 lockLockable 字段

名称说明

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.

markDiscussionCommentAsAnswer

Mark a discussion comment as the chosen answer for discussions in an answerable category.

输入 markDiscussionCommentAsAnswer 字段

返回 markDiscussionCommentAsAnswer 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the chosen comment.

markFileAsViewed

Mark a pull request file as viewed.

输入 markFileAsViewed 字段

返回 markFileAsViewed 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

markProjectV2AsTemplate

Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.

输入 markProjectV2AsTemplate 字段

返回 markProjectV2AsTemplate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

markPullRequestReadyForReview

Marks a pull request ready for review.

输入 markPullRequestReadyForReview 字段

返回 markPullRequestReadyForReview 字段

名称说明

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.

输入 mergeBranch 字段

返回 mergeBranch 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.

mergePullRequest

Merge a pull request.

输入 mergePullRequest 字段

返回 mergePullRequest 字段

名称说明

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 字段

返回 minimizeComment 字段

名称说明

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.

输入 moveProjectCard 字段

返回 moveProjectCard 字段

名称说明

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.

输入 moveProjectColumn 字段

返回 moveProjectColumn 字段

名称说明

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 字段

返回 pinIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.

regenerateVerifiableDomainToken

Regenerates a verifiable domain's verification token.

输入 regenerateVerifiableDomainToken 字段

返回 regenerateVerifiableDomainToken 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

verificationToken (String)

The verification token that was generated.

rejectDeployments

Reject all pending deployments under one or more environments.

输入 rejectDeployments 字段

返回 rejectDeployments 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

removeAssigneesFromAssignable

Removes assignees from an assignable object.

输入 removeAssigneesFromAssignable 字段

返回 removeAssigneesFromAssignable 字段

名称说明

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.

输入 removeEnterpriseAdmin 字段

返回 removeEnterpriseAdmin 字段

名称说明

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.

输入 removeLabelsFromLabelable 字段

返回 removeLabelsFromLabelable 字段

名称说明

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.

输入 removeOutsideCollaborator 字段

返回 removeOutsideCollaborator 字段

名称说明

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.

输入 removeReaction 字段

返回 removeReaction 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

reactionGroups ([ReactionGroup!])

The reaction groups for the subject.

subject (Reactable)

The reactable subject.

removeStar

Removes a star from a Starrable.

输入 removeStar 字段

返回 removeStar 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

removeUpvote

Remove an upvote to a discussion or discussion comment.

输入 removeUpvote 字段

返回 removeUpvote 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

reopenDiscussion

Reopen a discussion.

输入 reopenDiscussion 字段

返回 reopenDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was reopened.

reopenIssue

Reopen a issue.

输入 reopenIssue 字段

返回 reopenIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.

reopenPullRequest

Reopen a pull request.

输入 reopenPullRequest 字段

返回 reopenPullRequest 字段

名称说明

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.

输入 requestReviews 字段

返回 requestReviews 字段

名称说明

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 is getting requests.

requestedReviewersEdge (UserEdge)

The edge from the pull request to the requested reviewers.

rerequestCheckSuite

Rerequests an existing check suite.

输入 rerequestCheckSuite 字段

返回 rerequestCheckSuite 字段

名称说明

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

resolveReviewThread

Marks a review thread as resolved.

输入 resolveReviewThread 字段

返回 resolveReviewThread 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

revertPullRequest

Create a pull request that reverts the changes from a merged pull request.

输入 revertPullRequest 字段

返回 revertPullRequest 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reverted.

revertPullRequest (PullRequest)

The new pull request that reverts the input pull request.

revokeEnterpriseOrganizationsMigratorRole

Revoke the migrator role to a user for all organizations under an enterprise account.

输入 revokeEnterpriseOrganizationsMigratorRole 字段

返回 revokeEnterpriseOrganizationsMigratorRole 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role revoked for the given user.

revokeMigratorRole

Revoke the migrator role from a user or a team.

输入 revokeMigratorRole 字段

返回 revokeMigratorRole 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

startOrganizationMigration

Starts a GitHub Enterprise Importer organization migration.

输入 startOrganizationMigration 字段

返回 startOrganizationMigration 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

orgMigration (OrganizationMigration)

The new organization migration.

startRepositoryMigration

Starts a GitHub Enterprise Importer (GEI) repository migration.

输入 startRepositoryMigration 字段

返回 startRepositoryMigration 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryMigration (RepositoryMigration)

The new repository migration.

submitPullRequestReview

Submits a pending pull request review.

输入 submitPullRequestReview 字段

返回 submitPullRequestReview 字段

名称说明

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.

输入 transferIssue 字段

返回 transferIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was transferred.

unarchiveProjectV2Item

Unarchives a ProjectV2Item.

输入 unarchiveProjectV2Item 字段

返回 unarchiveProjectV2Item 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item unarchived from the project.

unarchiveRepository

Unarchives a repository.

输入 unarchiveRepository 字段

返回 unarchiveRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was unarchived.

unfollowOrganization

Unfollow an organization.

输入 unfollowOrganization 字段

返回 unfollowOrganization 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was unfollowed.

unfollowUser

Unfollow a user.

输入 unfollowUser 字段

返回 unfollowUser 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was unfollowed.

unlinkProjectV2FromRepository

Unlinks a project from a repository.

输入 unlinkProjectV2FromRepository 字段

返回 unlinkProjectV2FromRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is no longer linked to.

unlinkProjectV2FromTeam

Unlinks a project to a team.

输入 unlinkProjectV2FromTeam 字段

返回 unlinkProjectV2FromTeam 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is unlinked from.

unlinkRepositoryFromProject

Deletes a repository link from a project.

输入 unlinkRepositoryFromProject 字段

返回 unlinkRepositoryFromProject 字段

名称说明

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.

输入 unlockLockable 字段

返回 unlockLockable 字段

名称说明

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.

unmarkDiscussionCommentAsAnswer

Unmark a discussion comment as the chosen answer for discussions in an answerable category.

输入 unmarkDiscussionCommentAsAnswer 字段

返回 unmarkDiscussionCommentAsAnswer 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the comment.

unmarkFileAsViewed

Unmark a pull request file as viewed.

输入 unmarkFileAsViewed 字段

返回 unmarkFileAsViewed 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

输入 unmarkIssueAsDuplicate 字段

返回 unmarkIssueAsDuplicate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

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

unmarkProjectV2AsTemplate

Unmark a project as a template.

输入 unmarkProjectV2AsTemplate 字段

返回 unmarkProjectV2AsTemplate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

unminimizeComment

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

输入 unminimizeComment 字段

返回 unminimizeComment 字段

名称说明

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 字段

返回 unpinIssue 字段

名称说明

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.

输入 unresolveReviewThread 字段

返回 unresolveReviewThread 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

updateBranchProtectionRule

Update a branch protection rule.

输入 updateBranchProtectionRule 字段

返回 updateBranchProtectionRule 字段

名称说明

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckRun

Update a check run.

输入 updateCheckRun 字段

返回 updateCheckRun 字段

名称说明

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 字段

返回 updateCheckSuitePreferences 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateDiscussion

Update a discussion.

输入 updateDiscussion 字段

返回 updateDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The modified discussion.

updateDiscussionComment

Update the contents of a comment on a Discussion.

输入 updateDiscussionComment 字段

返回 updateDiscussionComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The modified discussion comment.

updateEnterpriseAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an enterprise.

输入 updateEnterpriseAllowPrivateRepositoryForkingSetting 字段

返回 updateEnterpriseAllowPrivateRepositoryForkingSetting 字段

名称说明

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 base repository permission for organizations in an enterprise.

输入 updateEnterpriseDefaultRepositoryPermissionSetting 字段

返回 updateEnterpriseDefaultRepositoryPermissionSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated base repository permission setting.

message (String)

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

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

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

输入 updateEnterpriseMembersCanChangeRepositoryVisibilitySetting 字段

返回 updateEnterpriseMembersCanChangeRepositoryVisibilitySetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanCreateRepositoriesSetting 字段

返回 updateEnterpriseMembersCanCreateRepositoriesSetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanDeleteIssuesSetting 字段

返回 updateEnterpriseMembersCanDeleteIssuesSetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanDeleteRepositoriesSetting 字段

返回 updateEnterpriseMembersCanDeleteRepositoriesSetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanInviteCollaboratorsSetting 字段

返回 updateEnterpriseMembersCanInviteCollaboratorsSetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanMakePurchasesSetting 字段

返回 updateEnterpriseMembersCanMakePurchasesSetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanUpdateProtectedBranchesSetting 字段

返回 updateEnterpriseMembersCanUpdateProtectedBranchesSetting 字段

名称说明

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.

输入 updateEnterpriseMembersCanViewDependencyInsightsSetting 字段

返回 updateEnterpriseMembersCanViewDependencyInsightsSetting 字段

名称说明

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.

输入 updateEnterpriseOrganizationProjectsSetting 字段

返回 updateEnterpriseOrganizationProjectsSetting 字段

名称说明

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.

updateEnterpriseOwnerOrganizationRole

Updates the role of an enterprise owner with an organization.

输入 updateEnterpriseOwnerOrganizationRole 字段

返回 updateEnterpriseOwnerOrganizationRole 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the owner's organization role.

updateEnterpriseProfile

Updates an enterprise's profile.

输入 updateEnterpriseProfile 字段

返回 updateEnterpriseProfile 字段

名称说明

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.

输入 updateEnterpriseRepositoryProjectsSetting 字段

返回 updateEnterpriseRepositoryProjectsSetting 字段

名称说明

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.

输入 updateEnterpriseTeamDiscussionsSetting 字段

返回 updateEnterpriseTeamDiscussionsSetting 字段

名称说明

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.

输入 updateEnterpriseTwoFactorAuthenticationRequiredSetting 字段

返回 updateEnterpriseTwoFactorAuthenticationRequiredSetting 字段

名称说明

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.

updateEnvironment

Updates an environment.

输入 updateEnvironment 字段

返回 updateEnvironment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The updated environment.

updateIpAllowListEnabledSetting

Sets whether an IP allow list is enabled on an owner.

输入 updateIpAllowListEnabledSetting 字段

返回 updateIpAllowListEnabledSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (IpAllowListOwner)

The IP allow list owner on which the setting was updated.

updateIpAllowListEntry

Updates an IP allow list entry.

输入 updateIpAllowListEntry 字段

返回 updateIpAllowListEntry 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was updated.

updateIpAllowListForInstalledAppsEnabledSetting

Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.

输入 updateIpAllowListForInstalledAppsEnabledSetting 字段

返回 updateIpAllowListForInstalledAppsEnabledSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (IpAllowListOwner)

The IP allow list owner on which the setting was updated.

updateIssue

Updates an Issue.

输入 updateIssue 字段

返回 updateIssue 字段

名称说明

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.

输入 updateIssueComment 字段

返回 updateIssueComment 字段

名称说明

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. 在预览期间,API 可能会更改,恕不通知。

输入 updateLabel 字段

返回 updateLabel 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The updated label.

updateNotificationRestrictionSetting

Update the setting to restrict notifications to only verified or approved domains available to an owner.

输入 updateNotificationRestrictionSetting 字段

返回 updateNotificationRestrictionSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owner on which the setting was updated.

updateOrganizationAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an organization.

输入 updateOrganizationAllowPrivateRepositoryForkingSetting 字段

返回 updateOrganizationAllowPrivateRepositoryForkingSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

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

organization (Organization)

The organization with the updated allow private repository forking setting.

updateOrganizationWebCommitSignoffSetting

Sets whether contributors are required to sign off on web-based commits for repositories in an organization.

输入 updateOrganizationWebCommitSignoffSetting 字段

返回 updateOrganizationWebCommitSignoffSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the web commit signoff setting.

organization (Organization)

The organization with the updated web commit signoff setting.

updateProject

Updates an existing project.

输入 updateProject 字段

返回 updateProject 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.

updateProjectCard

Updates an existing project card.

输入 updateProjectCard 字段

返回 updateProjectCard 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

updateProjectColumn

Updates an existing project column.

输入 updateProjectColumn 字段

返回 updateProjectColumn 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.

updateProjectV2

Updates an existing project (beta).

输入 updateProjectV2 字段

返回 updateProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The updated Project.

updateProjectV2Collaborators

Update the collaborators on a team or a project.

输入 updateProjectV2Collaborators 字段

返回 updateProjectV2Collaborators 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

collaborators (ProjectV2ActorConnection)

The collaborators granted a role.

updateProjectV2DraftIssue

Updates a draft issue within a Project.

输入 updateProjectV2DraftIssue 字段

返回 updateProjectV2DraftIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssue (DraftIssue)

The draft issue updated in the project.

updateProjectV2ItemFieldValue

This mutation updates the value of a field for an item in a Project. Currently only single-select, text, number, date, and iteration fields are supported.

输入 updateProjectV2ItemFieldValue 字段

返回 updateProjectV2ItemFieldValue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

updateProjectV2ItemPosition

This mutation updates the position of the item in the project, where the position represents the priority of an item.

输入 updateProjectV2ItemPosition 字段

返回 updateProjectV2ItemPosition 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

items (ProjectV2ItemConnection)

The items in the new order.

updatePullRequest

Update a pull request.

输入 updatePullRequest 字段

返回 updatePullRequest 字段

名称说明

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.

updatePullRequestBranch

Merge or Rebase HEAD from upstream branch into pull request branch.

输入 updatePullRequestBranch 字段

返回 updatePullRequestBranch 字段

名称说明

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.

输入 updatePullRequestReview 字段

返回 updatePullRequestReview 字段

名称说明

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.

输入 updatePullRequestReviewComment 字段

返回 updatePullRequestReviewComment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.

updateRef

Update a Git Ref.

输入 updateRef 字段

返回 updateRef 字段

名称说明

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 update multiple refs in a single operation preview. 在预览期间,API 可能会更改,恕不通知。

输入 updateRefs 字段

返回 updateRefs 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateRepository

Update information about a repository.

输入 updateRepository 字段

返回 updateRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateRepositoryWebCommitSignoffSetting

Sets whether contributors are required to sign off on web-based commits for a repository.

输入 updateRepositoryWebCommitSignoffSetting 字段

返回 updateRepositoryWebCommitSignoffSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the web commit signoff setting.

repository (Repository)

The updated repository.

updateSubscription

Updates the state for subscribable subjects.

输入 updateSubscription 字段

返回 updateSubscription 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.

updateTeamDiscussion

Updates a team discussion.

输入 updateTeamDiscussion 字段

返回 updateTeamDiscussion 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.

updateTeamDiscussionComment

Updates a discussion comment.

输入 updateTeamDiscussionComment 字段

返回 updateTeamDiscussionComment 字段

名称说明

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. 在预览期间,API 可能会更改,恕不通知。

输入 updateTeamReviewAssignment 字段

返回 updateTeamReviewAssignment 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team that was modified.

updateTeamsRepository

Update team repository.

输入 updateTeamsRepository 字段

返回 updateTeamsRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was updated.

teams ([Team!])

The teams granted permission on the repository.

updateTopics

Replaces the repository's topics with the given topics.

输入 updateTopics 字段

返回 updateTopics 字段

名称说明

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.

verifyVerifiableDomain

Verify that a verifiable domain has the expected DNS record.

输入 verifyVerifiableDomain 字段

返回 verifyVerifiableDomain 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was verified.