Neste artigo

Mutações

Sobre as mutações

Cada esquema de GraphQL tem um tipo de raiz para consultas e mutações. O tipo de mutação define operações do GraphQL que alteram dados no servidor. É análogo a executar verbos HTTP como POST, PATCH e DELETE.

Para obter mais informações, consulte "Sobre mutações".

acceptEnterpriseAdministratorInvitation

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

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The accepted topic.


addAssigneesToAssignable

Adds assignees to an assignable object.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The newly created discussion comment.


addEnterpriseSupportEntitlement

Adds a support entitlement to an enterprise member.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.


addPullRequestReview

Adds a review to a Pull Request.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.


addReaction

Adds a reaction to a subject.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.


approveVerifiableDomain

Approve a verifiable domain for notification delivery.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.


clearLabelsFromLabelable

Clears all labels from a labelable object.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.


cloneProject

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

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


closeIssue

Close an issue.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.


closePullRequest

Close a pull request.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


convertPullRequestToDraft

Converts a pull request to draft.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckRun

Create a check run.

Campos de entrada

Campos de retorno

Nome Descrição

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckSuite

Create a check suite.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.


createContentAttachment

Create a content attachment.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

contentAttachment (ContentAttachment)

The newly created content attachment.

Aviso de pré-visualização

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


createDeployment

Creates a new deployment event.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

autoMerged (Boolean)

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

Aviso de pré-visualização

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

deployment (Deployment)

The new deployment.

Aviso de pré-visualização

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


createDeploymentStatus

Create a deployment status.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

deploymentStatus (DeploymentStatus)

The new deployment status.

Aviso de pré-visualização

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


createDiscussion

Create a discussion.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.


createLabel

Creates a new label.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

label (Label)

The new label.

Aviso de pré-visualização

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


createProject

Creates a new project.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.


createPullRequest

Create a new pull request.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.


createRef

Create a new Git Ref.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.


createRepository

Create a new repository.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


createSponsorship

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

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was started.


createTeamDiscussion

Creates a new team discussion.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.


createTeamDiscussionComment

Creates a new team discussion comment.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.


declineTopicSuggestion

Rejects a suggested topic for the repository.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The declined topic.


deleteBranchProtectionRule

Delete a branch protection rule.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteDeployment

Deletes a deployment.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteDiscussion

Delete a discussion and all of its replies.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The discussion comment that was just deleted.


deleteEnvironment

Deletes an environment.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteIpAllowListEntry

Deletes an IP allow list entry.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.


deleteIssueComment

Deletes an IssueComment object.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteLabel

Deletes a label.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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


deletePackageVersion

Delete a package version.

Aviso de pré-visualização

deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.

Campos de entrada

Aviso de pré-visualização

deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.

success (Boolean)

Whether or not the operation succeeded.

Aviso de pré-visualização

deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.


deleteProject

Deletes a project.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.


deletePullRequestReview

Deletes a pull request review.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.


deleteRef

Delete a Git Ref.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussion

Deletes a team discussion.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussionComment

Deletes a team discussion comment.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteVerifiableDomain

Deletes a verifiable domain.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.


enablePullRequestAutoMerge

Enable the default auto-merge on a pull request.

Campos de entrada

Campos de retorno

Nome Descrição

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.


followUser

Follow a user.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.


importProject

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

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

project (Project)

The new Project!.

Aviso de pré-visualização

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


inviteEnterpriseAdmin

Invite someone to become an administrator of the enterprise.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.


mergePullRequest

Merge a pull request.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.


removeAssigneesFromAssignable

Removes assignees from an assignable object.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.


reopenIssue

Reopen a issue.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.


reopenPullRequest

Reopen a pull request.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.


resolveReviewThread

Marks a review thread as resolved.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


setEnterpriseIdentityProvider

Creates or updates the identity provider for an enterprise.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that the interaction limit was set for.


submitPullRequestReview

Submits a pending pull request review.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was transferred.


unarchiveRepository

Unarchives a repository.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was unarchived.


unfollowUser

Unfollow a user.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


updateBranchProtectionRule

Create a new branch protection rule.

Campos de entrada

Campos de retorno

Nome Descrição

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateCheckRun

Update a check run.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateDiscussion

Update a discussion.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated organization projects setting.

message (String)

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


updateEnterpriseProfile

Updates an enterprise's profile.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.


updateLabel

Updates an existing label.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

label (Label)

The updated label.

Aviso de pré-visualização

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


updateNotificationRestrictionSetting

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

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owner on which the setting was updated.


updateProject

Updates an existing project.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.


updateProjectCard

Updates an existing project card.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


updateProjectColumn

Updates an existing project column.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.


updatePullRequest

Update a pull request.

Campos de entrada

Campos de retorno

Nome Descrição

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.


updatePullRequestReview

Updates the body of a pull request review.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.


updateRef

Update a Git Ref.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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


updateRepository

Update information about a repository.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateSponsorshipPreferences

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

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.


updateTeamDiscussion

Updates a team discussion.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.


updateTeamDiscussionComment

Updates a discussion comment.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.


updateTeamReviewAssignment

Updates team review assignment.

Aviso de pré-visualização

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

Campos de entrada

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

team (Team)

The team that was modified.

Aviso de pré-visualização

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


updateTopics

Replaces the repository's topics with the given topics.

Campos de entrada

Campos de retorno

Nome Descrição

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.

Campos de entrada

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was verified.


Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.