Skip to main content

突变

本文内容

关于突变

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

有关详细信息,请参阅“关于变更”。

abortQueuedMigrations

Clear all of a customer's queued migrations.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

acceptEnterpriseAdministratorInvitation

Accepts a pending invitation for a user to become an administrator of an enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The invitation that was accepted.

message (String)

A message confirming the result of accepting an administrator invitation.

acceptTopicSuggestion

Applies a suggested topic to the repository.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The accepted topic.

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.

addDiscussionComment

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

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOption (DiscussionPollOption)

The poll option that a vote was added to.

addEnterpriseSupportEntitlement

Adds a support entitlement to an enterprise member.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of adding the support entitlement.

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.

addProjectDraftIssue

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

启用通知

addProjectDraftIssue is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectNextItem (ProjectNextItem)

The draft issue added to the project.

启用通知

projectNextItem is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

addProjectNextItem

Adds an existing item (Issue or PullRequest) to a Project.

启用通知

addProjectNextItem is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectNextItem (ProjectNextItem)

The item added to the project.

启用通知

projectNextItem is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

addProjectV2DraftIssue

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

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.

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.

addUpvote

Add an upvote to a discussion or discussion comment.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

approveVerifiableDomain

Approve a verifiable domain for notification delivery.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was approved.

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.

cancelEnterpriseAdminInvitation

Cancels a pending invitation for an administrator to join an enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The invitation that was canceled.

message (String)

A message confirming the result of canceling an administrator invitation.

cancelSponsorship

Cancel an active sponsorship.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was being used at the time of cancellation.

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.

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

convertPullRequestToDraft

Converts a pull request to draft.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is now a draft.

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.

输入字段

返回字段

名称说明

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Create a check suite.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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 可能会更改,恕不通知。

输入字段

返回字段

名称说明

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 可能会更改,恕不通知。

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.

createDiscussion

Create a discussion.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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 可能会更改,恕不通知。

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.

createMigrationSource

Creates an Octoshift migration source.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationSource (MigrationSource)

The created Octoshift migration source.

createProject

Creates a new project.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

createProjectV2

Creates a new project.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

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.

createSponsorsTier

Create a new payment tier for your GitHub Sponsors profile.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The new tier.

createSponsorship

Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was started.

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.

declineTopicSuggestion

Rejects a suggested topic for the repository.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The declined topic.

deleteBranchProtectionRule

Delete a branch protection rule.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDeployment

Deletes a deployment.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDiscussion

Delete a discussion and all of its replies.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The discussion comment that was just deleted.

deleteEnvironment

Deletes an environment.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIpAllowListEntry

Deletes an IP allow list entry.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletePackageVersion

Delete a package version.

预览通知

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

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Whether or not the operation succeeded.

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.

deleteProjectNextItem

Deletes an item from a Project.

启用通知

deleteProjectNextItem is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

启用通知

deletedItemId is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

deleteProjectV2Item

Deletes an item from a Project.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

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.

pullRequestReviewComment (PullRequestReviewComment)

The deleted pull request review comment.

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.

deleteVerifiableDomain

Deletes a verifiable domain.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

dismissRepositoryVulnerabilityAlert

Dismisses the Dependabot alert.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was followed.

followUser

Follow a user.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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 可能会更改,恕不通知。

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.

inviteEnterpriseAdmin

Invite someone to become an administrator of the enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The created enterprise administrator invitation.

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.

markDiscussionCommentAsAnswer

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

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

markPullRequestReadyForReview

Marks a pull request ready for review.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.

regenerateEnterpriseIdentityProviderRecoveryCodes

Regenerates the identity provider recovery codes for an enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.

regenerateVerifiableDomainToken

Regenerates a verifiable domain's verification token.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

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.

removeEnterpriseIdentityProvider

Removes the identity provider from an enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider that was removed from the enterprise.

removeEnterpriseOrganization

Removes an organization from the enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

organization (Organization)

The organization that was removed from the enterprise.

viewer (User)

The viewer performing the mutation.

removeEnterpriseSupportEntitlement

Removes a support entitlement from an enterprise member.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of removing the support entitlement.

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.

removeUpvote

Remove an upvote to a discussion or discussion comment.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

resolveReviewThread

Marks a review thread as resolved.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

revokeEnterpriseOrganizationsMigratorRole

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

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

setEnterpriseIdentityProvider

Creates or updates the identity provider for an enterprise.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.

setOrganizationInteractionLimit

Set an organization level interaction limit for an organization's public repositories.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that the interaction limit was set for.

setRepositoryInteractionLimit

Sets an interaction limit setting for a repository.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that the interaction limit was set for.

setUserInteractionLimit

Set a user level interaction limit for an user's public repositories.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that the interaction limit was set for.

startRepositoryMigration

Start a repository migration.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryMigration (RepositoryMigration)

The new Octoshift repository migration.

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.

unfollowOrganization

Unfollow an organization.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was unfollowed.

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.

unmarkDiscussionCommentAsAnswer

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

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

updateBranchProtectionRule

Update a 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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateDiscussion

Update a discussion.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The modified discussion comment.

updateEnterpriseAdministratorRole

Updates the role of an enterprise administrator.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the administrator's role.

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 base 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 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.

输入字段

返回字段

名称说明

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.

updateEnterpriseOwnerOrganizationRole

Updates the role of an enterprise owner with an organization.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

updateEnvironment

Updates an environment.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

updateProjectDraftIssue

Updates a draft issue within a Project.

启用通知

updateProjectDraftIssue is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssue (DraftIssue)

The draft issue updated in the project.

updateProjectNext

Updates an existing project (beta).

启用通知

updateProjectNext is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectNext (ProjectNext)

The updated Project.

启用通知

projectNext is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

updateProjectNextItemField

Updates a field of an item from a Project.

启用通知

updateProjectNextItemField is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectNextItem (ProjectNextItem)

The updated item.

启用通知

projectNextItem is deprecated.

The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.

updateProjectV2

Updates an existing project (beta).

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The updated Project.

updateProjectV2DraftIssue

Updates a draft issue within a Project.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

items (ProjectV2ItemConnection)

The items in the new order.

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.

updatePullRequestBranch

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

输入字段

返回字段

名称说明

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

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateRepository

Update information about a repository.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

updateSponsorshipPreferences

Change visibility of your sponsorship and opt in or out of email updates from the maintainer.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was updated.

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

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team that was modified.

updateTeamsRepository

Update team repository.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

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.

输入字段

返回字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was verified.