Mutações

Neste artigo

Sobre as mutações
addAssigneesToAssignable
addComment
addEnterpriseAdmin
addLabelsToLabelable
addProjectCard
addProjectColumn
addPullRequestReview
addPullRequestReviewComment
addPullRequestReviewThread
addReaction
addStar
archiveRepository
changeUserStatus
clearLabelsFromLabelable
cloneProject
cloneTemplateRepository
closeIssue
closePullRequest
convertProjectCardNoteToIssue
createBranchProtectionRule
createCheckRun
createCheckSuite
createContentAttachment
createDeployment
createDeploymentStatus
createIssue
createLabel
createProject
createPullRequest
createRef
createRepository
createTeamDiscussion
createTeamDiscussionComment
deleteBranchProtectionRule
deleteIssue
deleteIssueComment
deleteLabel
deleteProject
deleteProjectCard
deleteProjectColumn
deletePullRequestReview
deletePullRequestReviewComment
deleteRef
deleteTeamDiscussion
deleteTeamDiscussionComment
dismissPullRequestReview
followUser
importProject
linkRepositoryToProject
lockLockable
markPullRequestReadyForReview
mergeBranch
mergePullRequest
minimizeComment
moveProjectCard
moveProjectColumn
pinIssue
removeAssigneesFromAssignable
removeEnterpriseAdmin
removeLabelsFromLabelable
removeOutsideCollaborator
removeReaction
removeStar
reopenIssue
reopenPullRequest
requestReviews
rerequestCheckSuite
resolveReviewThread
submitPullRequestReview
transferIssue
unarchiveRepository
unfollowUser
unlinkRepositoryFromProject
unlockLockable
unmarkIssueAsDuplicate
unminimizeComment
unpinIssue
unresolveReviewThread
updateBranchProtectionRule
updateCheckRun
updateCheckSuitePreferences
updateEnterpriseActionExecutionCapabilitySetting
updateEnterpriseAllowPrivateRepositoryForkingSetting
updateEnterpriseDefaultRepositoryPermissionSetting
updateEnterpriseMembersCanChangeRepositoryVisibilitySetting
updateEnterpriseMembersCanCreateRepositoriesSetting
updateEnterpriseMembersCanDeleteIssuesSetting
updateEnterpriseMembersCanDeleteRepositoriesSetting
updateEnterpriseMembersCanInviteCollaboratorsSetting
updateEnterpriseMembersCanMakePurchasesSetting
updateEnterpriseMembersCanUpdateProtectedBranchesSetting
updateEnterpriseMembersCanViewDependencyInsightsSetting
updateEnterpriseOrganizationProjectsSetting
updateEnterpriseProfile
updateEnterpriseRepositoryProjectsSetting
updateEnterpriseTeamDiscussionsSetting
updateEnterpriseTwoFactorAuthenticationRequiredSetting
updateIssue
updateIssueComment
updateLabel
updateProject
updateProjectCard
updateProjectColumn
updatePullRequest
updatePullRequestReview
updatePullRequestReviewComment
updateRef
updateRefs
updateRepository
updateSubscription
updateTeamDiscussion
updateTeamDiscussionComment
updateTeamReviewAssignment
updateTopics

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

addAssigneesToAssignable

Adds assignees to an assignable object.

Campos de entrada

input (AddAssigneesToAssignableInput!)

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

input (AddCommentInput!)

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.

addEnterpriseAdmin

Adds an administrator to the global enterprise account.

Campos de entrada

input (AddEnterpriseAdminInput!)

Campos de retorno

Nome	Descrição
`admin` (`User`)	The user who was added as an administrator.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterprise` (`Enterprise`)	The updated enterprise.
`role` (`EnterpriseAdministratorRole`)	The role of the administrator.
`viewer` (`User`)	The viewer performing the mutation.

addLabelsToLabelable

Adds labels to a labelable object.

Campos de entrada

input (AddLabelsToLabelableInput!)

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

input (AddProjectCardInput!)

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

input (AddProjectColumnInput!)

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

input (AddPullRequestReviewInput!)

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

input (AddPullRequestReviewCommentInput!)

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.

Aviso de pré-visualização

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

Campos de entrada

input (AddPullRequestReviewThreadInput!)

Aviso de pré-visualização

addPullRequestReviewThread is available under the Multi line comments 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

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

thread (PullRequestReviewThread)

The newly created thread.

Aviso de pré-visualização

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

addReaction

Adds a reaction to a subject.

Campos de entrada

input (AddReactionInput!)

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

input (AddStarInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

archiveRepository

Marks a repository as archived.

Campos de entrada

input (ArchiveRepositoryInput!)

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.

changeUserStatus

Update your status on GitHub.

Campos de entrada

input (ChangeUserStatusInput!)

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

input (ClearLabelsFromLabelableInput!)

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

input (CloneProjectInput!)

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

input (CloneTemplateRepositoryInput!)

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

input (CloseIssueInput!)

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

input (ClosePullRequestInput!)

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

input (ConvertProjectCardNoteToIssueInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

createBranchProtectionRule

Create a new branch protection rule.

Campos de entrada

input (CreateBranchProtectionRuleInput!)

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.

Aviso de pré-visualização

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

Campos de entrada

input (CreateCheckRunInput!)

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

checkRun (CheckRun)

The newly created check run.

Aviso de pré-visualização

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

createCheckSuite

Create a check suite.

Aviso de pré-visualização

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

Campos de entrada

input (CreateCheckSuiteInput!)

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

checkSuite (CheckSuite)

The newly created check suite.

Aviso de pré-visualização

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

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

input (CreateContentAttachmentInput!)

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

input (CreateDeploymentInput!)

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

input (CreateDeploymentStatusInput!)

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.

createIssue

Creates a new issue.

Campos de entrada

input (CreateIssueInput!)

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

input (CreateLabelInput!)

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

input (CreateProjectInput!)

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

input (CreatePullRequestInput!)

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

input (CreateRefInput!)

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

input (CreateRepositoryInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

createTeamDiscussion

Creates a new team discussion.

Campos de entrada

input (CreateTeamDiscussionInput!)

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

input (CreateTeamDiscussionCommentInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.

deleteBranchProtectionRule

Delete a branch protection rule.

Campos de entrada

input (DeleteBranchProtectionRuleInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIssue

Deletes an Issue object.

Campos de entrada

input (DeleteIssueInput!)

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

input (DeleteIssueCommentInput!)

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

input (DeleteLabelInput!)

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.

deleteProject

Deletes a project.

Campos de entrada

input (DeleteProjectInput!)

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

input (DeleteProjectCardInput!)

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

input (DeleteProjectColumnInput!)

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

input (DeletePullRequestReviewInput!)

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

input (DeletePullRequestReviewCommentInput!)

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

input (DeleteRefInput!)

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

input (DeleteTeamDiscussionInput!)

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

input (DeleteTeamDiscussionCommentInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

dismissPullRequestReview

Dismisses an approved or rejected pull request review.

Campos de entrada

input (DismissPullRequestReviewInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

followUser

Follow a user.

Campos de entrada

input (FollowUserInput!)

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

input (ImportProjectInput!)

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.

linkRepositoryToProject

Creates a repository link for a project.

Campos de entrada

input (LinkRepositoryToProjectInput!)

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

input (LockLockableInput!)

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.

markPullRequestReadyForReview

Marks a pull request ready for review.

Aviso de pré-visualização

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

Campos de entrada

input (MarkPullRequestReadyForReviewInput!)

Aviso de pré-visualização

markPullRequestReadyForReview is available under the Draft pull requests 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

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

pullRequest (PullRequest)

The pull request that is ready for review.

Aviso de pré-visualização

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

mergeBranch

Merge a head into a branch.

Campos de entrada

input (MergeBranchInput!)

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

input (MergePullRequestInput!)

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.

Aviso de pré-visualização

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

Campos de entrada

input (MinimizeCommentInput!)

Aviso de pré-visualização

minimizeComment is available under the Minimize comments 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

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

minimizedComment (Minimizable)

The comment that was minimized.

Aviso de pré-visualização

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

moveProjectCard

Moves a project card to another place.

Campos de entrada

input (MoveProjectCardInput!)

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

input (MoveProjectColumnInput!)

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.

Aviso de pré-visualização

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

Campos de entrada

input (PinIssueInput!)

Aviso de pré-visualização

pinIssue is available under the Pinned issues 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

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

issue (Issue)

The issue that was pinned.

Aviso de pré-visualização

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

removeAssigneesFromAssignable

Removes assignees from an assignable object.

Campos de entrada

input (RemoveAssigneesFromAssignableInput!)

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

input (RemoveEnterpriseAdminInput!)

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.

removeLabelsFromLabelable

Removes labels from a Labelable object.

Campos de entrada

input (RemoveLabelsFromLabelableInput!)

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

input (RemoveOutsideCollaboratorInput!)

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

input (RemoveReactionInput!)

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

input (RemoveStarInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

reopenIssue

Reopen a issue.

Campos de entrada

input (ReopenIssueInput!)

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

input (ReopenPullRequestInput!)

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

input (RequestReviewsInput!)

Campos de retorno

Nome Descrição

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.

Aviso de pré-visualização

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

Campos de entrada

input (RerequestCheckSuiteInput!)

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

checkSuite (CheckSuite)

The requested check suite.

Aviso de pré-visualização

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

resolveReviewThread

Marks a review thread as resolved.

Campos de entrada

input (ResolveReviewThreadInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

submitPullRequestReview

Submits a pending pull request review.

Campos de entrada

input (SubmitPullRequestReviewInput!)

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

input (TransferIssueInput!)

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

input (UnarchiveRepositoryInput!)

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

input (UnfollowUserInput!)

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

input (UnlinkRepositoryFromProjectInput!)

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

input (UnlockLockableInput!)

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.

unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

Campos de entrada

input (UnmarkIssueAsDuplicateInput!)

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.

Aviso de pré-visualização

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

Campos de entrada

input (UnminimizeCommentInput!)

Aviso de pré-visualização

unminimizeComment is available under the Minimize comments 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

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

unminimizedComment (Minimizable)

The comment that was unminimized.

Aviso de pré-visualização

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

unpinIssue

Unpin a pinned issue from a repository.

Aviso de pré-visualização

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

Campos de entrada

input (UnpinIssueInput!)

Aviso de pré-visualização

unpinIssue is available under the Pinned issues 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

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

issue (Issue)

The issue that was unpinned.

Aviso de pré-visualização

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

unresolveReviewThread

Marks a review thread as unresolved.

Campos de entrada

input (UnresolveReviewThreadInput!)

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

input (UpdateBranchProtectionRuleInput!)

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.

Aviso de pré-visualização

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

Campos de entrada

input (UpdateCheckRunInput!)

Aviso de pré-visualização

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

Campos de retorno

Nome Descrição

checkRun (CheckRun)

The updated check run.

Aviso de pré-visualização

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

Aviso de pré-visualização

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

updateCheckSuitePreferences

Modifies the settings of an existing check suite.

Aviso de pré-visualização

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

Campos de entrada

input (UpdateCheckSuitePreferencesInput!)

Aviso de pré-visualização

updateCheckSuitePreferences is available under the Checks 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

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

repository (Repository)

The updated repository.

Aviso de pré-visualização

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

updateEnterpriseActionExecutionCapabilitySetting

Sets the action execution capability setting for an enterprise.

Campos de entrada

input (UpdateEnterpriseActionExecutionCapabilitySettingInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated action execution capability setting.

message (String)

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

updateEnterpriseAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an enterprise.

Campos de entrada

input (UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!)

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

Campos de entrada

input (UpdateEnterpriseDefaultRepositoryPermissionSettingInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated default repository permission setting.

message (String)

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

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

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

Campos de entrada

input (UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!)

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

input (UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!)

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

input (UpdateEnterpriseMembersCanDeleteIssuesSettingInput!)

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

input (UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!)

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

input (UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!)

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

input (UpdateEnterpriseMembersCanMakePurchasesSettingInput!)

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

input (UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!)

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

input (UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!)

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

input (UpdateEnterpriseOrganizationProjectsSettingInput!)

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

input (UpdateEnterpriseProfileInput!)

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

input (UpdateEnterpriseRepositoryProjectsSettingInput!)

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

input (UpdateEnterpriseTeamDiscussionsSettingInput!)

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

input (UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!)

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.

updateIssue

Updates an Issue.

Campos de entrada

input (UpdateIssueInput!)

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

input (UpdateIssueCommentInput!)

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

input (UpdateLabelInput!)

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.

updateProject

Updates an existing project.

Campos de entrada

input (UpdateProjectInput!)

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

input (UpdateProjectCardInput!)

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

input (UpdateProjectColumnInput!)

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

input (UpdatePullRequestInput!)

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

input (UpdatePullRequestReviewInput!)

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

input (UpdatePullRequestReviewCommentInput!)

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

input (UpdateRefInput!)

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

input (UpdateRefsInput!)

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

input (UpdateRepositoryInput!)

Campos de retorno

Nome Descrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateSubscription

Updates the state for subscribable subjects.

Campos de entrada

input (UpdateSubscriptionInput!)

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

input (UpdateTeamDiscussionInput!)

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

input (UpdateTeamDiscussionCommentInput!)

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

input (UpdateTeamReviewAssignmentInput!)

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

input (UpdateTopicsInput!)

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.