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".
Input fields
input(AbortQueuedMigrationsInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
Did the operation succeed?. |
acceptEnterpriseAdministratorInvitation
Accepts a pending invitation for a user to become an administrator of an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The invitation that was accepted. |
|
A message confirming the result of accepting an administrator invitation. |
Input fields
input(AcceptTopicSuggestionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The accepted topic. |
Input fields
input(AddAssigneesToAssignableInput!)
Return fields
| Name | Description |
|---|---|
|
The item that was assigned. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(AddCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The edge from the subject's comment connection. |
|
The subject. |
|
The edge from the subject's timeline connection. |
Input fields
input(AddDiscussionCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created discussion comment. |
Input fields
input(AddDiscussionPollVoteInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The poll option that a vote was added to. |
Input fields
input(AddLabelsToLabelableInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The item that was labeled. |
addProjectCard
Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.
Input fields
input(AddProjectCardInput!)
Return fields
| Name | Description |
|---|---|
|
The edge from the ProjectColumn's card connection. |
|
A unique identifier for the client performing the mutation. |
|
The ProjectColumn. |
Input fields
input(AddProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The edge from the project's column connection. |
|
The project. |
Deprecation notice
addProjectDraftIssue is deprecated.
The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.
Input fields
input(AddProjectDraftIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The draft issue added to the project. Deprecation notice
The |
Deprecation notice
addProjectNextItem is deprecated.
The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.
Input fields
input(AddProjectNextItemInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The item added to the project. Deprecation notice
The |
Input fields
input(AddProjectV2DraftIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The draft issue added to the project. |
Input fields
input(AddProjectV2ItemByIdInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The item added to the project. |
Input fields
input(AddPullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created pull request review. |
|
The edge from the pull request's review connection. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created comment. |
|
The edge from the review's comment connection. |
Input fields
input(AddPullRequestReviewThreadInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created thread. |
Input fields
input(AddReactionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The reaction object. |
|
The reactable subject. |
Input fields
input(AddStarInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The starrable. |
Input fields
input(AddUpvoteInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The votable subject. |
Input fields
input(AddVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The verifiable domain that was added. |
Input fields
input(ApproveDeploymentsInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The affected deployments. |
Input fields
input(ApproveVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The verifiable domain that was approved. |
Input fields
input(ArchiveRepositoryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository that was marked as archived. |
cancelEnterpriseAdminInvitation
Cancels a pending invitation for an administrator to join an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The invitation that was canceled. |
|
A message confirming the result of canceling an administrator invitation. |
Input fields
input(CancelSponsorshipInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The tier that was being used at the time of cancellation. |
Input fields
input(ChangeUserStatusInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
Your updated status. |
Input fields
input(ClearLabelsFromLabelableInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The item that was unlabeled. |
Input fields
input(CloneProjectInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The id of the JobStatus for populating cloned fields. |
|
The new cloned project. |
cloneTemplateRepository
Create a new repository with the same files and directory structure as a template repository.
Input fields
input(CloneTemplateRepositoryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new repository. |
Input fields
input(CloseIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was closed. |
Input fields
input(ClosePullRequestInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request that was closed. |
convertProjectCardNoteToIssue
Convert a project note card to one associated with a newly created issue.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated ProjectCard. |
Input fields
input(ConvertPullRequestToDraftInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request that is now a draft. |
Input fields
input(CreateBranchProtectionRuleInput!)
Return fields
| Name | Description |
|---|---|
|
The newly created BranchProtectionRule. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(CreateCheckRunInput!)
Return fields
| Name | Description |
|---|---|
|
The newly created check run. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(CreateCheckSuiteInput!)
Return fields
| Name | Description |
|---|---|
|
The newly created check suite. |
|
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.
Input fields
input(CreateCommitOnBranchInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new commit. |
|
The ref which has been updated to point to the new commit. |
Preview notice
createDeployment is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields
input(CreateDeploymentInput!)
Return fields
| Name | Description |
|---|---|
|
True if the default branch has been auto-merged into the deployment ref. |
|
A unique identifier for the client performing the mutation. |
|
The new deployment. |
Preview notice
createDeploymentStatus is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields
input(CreateDeploymentStatusInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new deployment status. |
Input fields
input(CreateDiscussionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The discussion that was just created. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise that owns the created organization. |
|
The organization that was created. |
Input fields
input(CreateEnvironmentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new or existing environment. |
Input fields
input(CreateIpAllowListEntryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The IP allow list entry that was created. |
Input fields
input(CreateIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new issue. |
Preview notice
createLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
input(CreateLabelInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new label. |
Input fields
input(CreateMigrationSourceInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The created Octoshift migration source. |
Input fields
input(CreateProjectInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new project. |
Input fields
input(CreateProjectV2Input!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new project. |
Input fields
input(CreatePullRequestInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new pull request. |
Input fields
input(CreateRefInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created ref. |
Input fields
input(CreateRepositoryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new repository. |
Input fields
input(CreateSponsorsTierInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new tier. |
createSponsorship
Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.
Input fields
input(CreateSponsorshipInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The sponsorship that was started. |
Input fields
input(CreateTeamDiscussionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new discussion. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new comment. |
Input fields
input(DeclineTopicSuggestionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The declined topic. |
Input fields
input(DeleteBranchProtectionRuleInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
input(DeleteDeploymentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
input(DeleteDiscussionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The discussion that was just deleted. |
Input fields
input(DeleteDiscussionCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The discussion comment that was just deleted. |
Input fields
input(DeleteEnvironmentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
input(DeleteIpAllowListEntryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The IP allow list entry that was deleted. |
Input fields
input(DeleteIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository the issue belonged to. |
Input fields
input(DeleteIssueCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Preview notice
deleteLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
input(DeleteLabelInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Preview notice
deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.
Input fields
input(DeletePackageVersionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
Whether or not the operation succeeded. |
Input fields
input(DeleteProjectInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository or organization the project was removed from. |
Input fields
input(DeleteProjectCardInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The column the deleted card was in. |
|
The deleted card ID. |
Input fields
input(DeleteProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The deleted column ID. |
|
The project the deleted column was in. |
Deprecation notice
deleteProjectNextItem is deprecated.
The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.
Input fields
input(DeleteProjectNextItemInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The ID of the deleted item. Deprecation notice
The |
Input fields
input(DeleteProjectV2ItemInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The ID of the deleted item. |
Input fields
input(DeletePullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The deleted pull request review. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request review the deleted comment belonged to. |
Input fields
input(DeleteRefInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
input(DeleteTeamDiscussionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
input(DeleteVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The owning account from which the domain was deleted. |
Input fields
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The pull request auto merge was disabled on. |
Input fields
input(DismissPullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The dismissed pull request review. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The Dependabot alert that was dismissed. |
Input fields
input(EnablePullRequestAutoMergeInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The pull request auto-merge was enabled on. |
Input fields
input(FollowOrganizationInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The organization that was followed. |
Input fields
input(FollowUserInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The user that was followed. |
grantEnterpriseOrganizationsMigratorRole
Grant the migrator role to a user for all organizations under an enterprise account.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The organizations that had the migrator role applied to for the given user. |
Input fields
input(GrantMigratorRoleInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
Did the operation succeed?. |
Preview notice
importProject is available under the Import project preview. During the preview period, the API may change without notice.
Input fields
input(ImportProjectInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new Project!. |
Input fields
input(InviteEnterpriseAdminInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The created enterprise administrator invitation. |
Input fields
input(LinkRepositoryToProjectInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The linked Project. |
|
The linked Repository. |
Input fields
input(LockLockableInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The item that was locked. |
markDiscussionCommentAsAnswer
Mark a discussion comment as the chosen answer for discussions in an answerable category.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The discussion that includes the chosen comment. |
Input fields
input(MarkFileAsViewedInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated pull request. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request that is ready for review. |
Input fields
input(MergeBranchInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The resulting merge Commit. |
Input fields
input(MergePullRequestInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The pull request that was merged. |
Input fields
input(MinimizeCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The comment that was minimized. |
Input fields
input(MoveProjectCardInput!)
Return fields
| Name | Description |
|---|---|
|
The new edge of the moved card. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(MoveProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new edge of the moved column. |
Input fields
input(PinIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was pinned. |
regenerateEnterpriseIdentityProviderRecoveryCodes
Regenerates the identity provider recovery codes for an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The identity provider for the enterprise. |
Input fields
input(RejectDeploymentsInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The affected deployments. |
Input fields
Return fields
| Name | Description |
|---|---|
|
The item that was unassigned. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(RemoveEnterpriseAdminInput!)
Return fields
| Name | Description |
|---|---|
|
The user who was removed as an administrator. |
|
A unique identifier for the client performing the mutation. |
|
The updated enterprise. |
|
A message confirming the result of removing an administrator. |
|
The viewer performing the mutation. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The identity provider that was removed from the enterprise. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated enterprise. |
|
The organization that was removed from the enterprise. |
|
The viewer performing the mutation. |
Input fields
input(RemoveLabelsFromLabelableInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The Labelable the labels were removed from. |
Input fields
input(RemoveOutsideCollaboratorInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The user that was removed as an outside collaborator. |
Input fields
input(RemoveReactionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The reaction object. |
|
The reactable subject. |
Input fields
input(RemoveStarInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The starrable. |
Input fields
input(RemoveUpvoteInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The votable subject. |
Input fields
input(ReopenIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was opened. |
Input fields
input(ReopenPullRequestInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request that was reopened. |
Input fields
input(RequestReviewsInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The pull request that is getting requests. |
|
The edge from the pull request to the requested reviewers. |
Input fields
input(RerequestCheckSuiteInput!)
Return fields
| Name | Description |
|---|---|
|
The requested check suite. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(ResolveReviewThreadInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The thread to resolve. |
revokeEnterpriseOrganizationsMigratorRole
Revoke the migrator role to a user for all organizations under an enterprise account.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The organizations that had the migrator role revoked for the given user. |
Input fields
input(RevokeMigratorRoleInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
Did the operation succeed?. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The identity provider for the enterprise. |
setOrganizationInteractionLimit
Set an organization level interaction limit for an organization's public repositories.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The organization that the interaction limit was set for. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository that the interaction limit was set for. |
Input fields
input(SetUserInteractionLimitInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The user that the interaction limit was set for. |
Input fields
input(StartRepositoryMigrationInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The new Octoshift repository migration. |
Input fields
input(SubmitPullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The submitted pull request review. |
Input fields
input(TransferIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was transferred. |
Input fields
input(UnarchiveRepositoryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository that was unarchived. |
Input fields
input(UnfollowOrganizationInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The organization that was unfollowed. |
Input fields
input(UnfollowUserInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The user that was unfollowed. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The linked Project. |
|
The linked Repository. |
Input fields
input(UnlockLockableInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The item that was unlocked. |
unmarkDiscussionCommentAsAnswer
Unmark a discussion comment as the chosen answer for discussions in an answerable category.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The discussion that includes the comment. |
Input fields
input(UnmarkFileAsViewedInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated pull request. |
Input fields
input(UnmarkIssueAsDuplicateInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue or pull request that was marked as a duplicate. |
Input fields
input(UnminimizeCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The comment that was unminimized. |
Input fields
input(UnpinIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was unpinned. |
Input fields
input(UnresolveReviewThreadInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The thread to resolve. |
Input fields
input(UpdateBranchProtectionRuleInput!)
Return fields
| Name | Description |
|---|---|
|
The newly created BranchProtectionRule. |
|
A unique identifier for the client performing the mutation. |
Input fields
input(UpdateCheckRunInput!)
Return fields
| Name | Description |
|---|---|
|
The updated check run. |
|
A unique identifier for the client performing the mutation. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated repository. |
Input fields
input(UpdateDiscussionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The modified discussion. |
Input fields
input(UpdateDiscussionCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The modified discussion comment. |
updateEnterpriseAllowPrivateRepositoryForkingSetting
Sets whether private repository forks are enabled for an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated allow private repository forking setting. |
|
A message confirming the result of updating the allow private repository forking setting. |
updateEnterpriseDefaultRepositoryPermissionSetting
Sets the base repository permission for organizations in an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated base repository permission setting. |
|
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.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can change repository visibility setting. |
|
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.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can create repositories setting. |
|
A message confirming the result of updating the members can create repositories setting. |
updateEnterpriseMembersCanDeleteIssuesSetting
Sets the members can delete issues setting for an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can delete issues setting. |
|
A message confirming the result of updating the members can delete issues setting. |
updateEnterpriseMembersCanDeleteRepositoriesSetting
Sets the members can delete repositories setting for an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can delete repositories setting. |
|
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.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can invite collaborators setting. |
|
A message confirming the result of updating the members can invite collaborators setting. |
updateEnterpriseMembersCanMakePurchasesSetting
Sets whether or not an organization admin can make purchases.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can make purchases setting. |
|
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.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can update protected branches setting. |
|
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.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated members can view dependency insights setting. |
|
A message confirming the result of updating the members can view dependency insights setting. |
updateEnterpriseOrganizationProjectsSetting
Sets whether organization projects are enabled for an enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated organization projects setting. |
|
A message confirming the result of updating the organization projects setting. |
Input fields
input(UpdateEnterpriseProfileInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated enterprise. |
updateEnterpriseRepositoryProjectsSetting
Sets whether repository projects are enabled for a enterprise.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated repository projects setting. |
|
A message confirming the result of updating the repository projects setting. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated team discussions setting. |
|
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.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The enterprise with the updated two factor authentication required setting. |
|
A message confirming the result of updating the two factor authentication required setting. |
Input fields
input(UpdateEnvironmentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated environment. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The IP allow list owner on which the setting was updated. |
Input fields
input(UpdateIpAllowListEntryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The IP allow list entry that was updated. |
updateIpAllowListForInstalledAppsEnabledSetting
Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The IP allow list owner on which the setting was updated. |
Input fields
input(UpdateIssueInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The issue. |
Input fields
input(UpdateIssueCommentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
Preview notice
updateLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
input(UpdateLabelInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated label. |
updateNotificationRestrictionSetting
Update the setting to restrict notifications to only verified or approved domains available to an owner.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The owner on which the setting was updated. |
updateOrganizationAllowPrivateRepositoryForkingSetting
Sets whether private repository forks are enabled for an organization.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
A message confirming the result of updating the allow private repository forking setting. |
|
The organization with the updated allow private repository forking setting. |
Input fields
input(UpdateProjectInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated project. |
Input fields
input(UpdateProjectCardInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated ProjectCard. |
Input fields
input(UpdateProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated project column. |
Deprecation notice
updateProjectDraftIssue is deprecated.
The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.
Input fields
input(UpdateProjectDraftIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The draft issue updated in the project. |
Deprecation notice
updateProjectNext is deprecated.
The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.
Input fields
input(UpdateProjectNextInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated Project. Deprecation notice
The |
Deprecation notice
updateProjectNextItemField is deprecated.
The ProjectNext API is deprecated in favour of the more capable ProjectV2 API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.
Input fields
input(UpdateProjectNextItemFieldInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated item. Deprecation notice
The |
Input fields
input(UpdateProjectV2Input!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated Project. |
Input fields
input(UpdateProjectV2DraftIssueInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The draft issue updated in the project. |
updateProjectV2ItemFieldValue
This mutation updates the value of a field for an item in a Project. Currently only single-select, text, number, date, and iteration fields are supported.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated item. |
updateProjectV2ItemPosition
This mutation updates the position of the item in the project, where the position represents the priority of an item.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The items in the new order. |
Input fields
input(UpdatePullRequestInput!)
Return fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
A unique identifier for the client performing the mutation. |
|
The updated pull request. |
Input fields
input(UpdatePullRequestBranchInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated pull request. |
Input fields
input(UpdatePullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated pull request review. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
Input fields
input(UpdateRefInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
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.
Preview notice
updateRefs is available under the Update refs preview. During the preview period, the API may change without notice.
Input fields
input(UpdateRefsInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
Input fields
input(UpdateRepositoryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated repository. |
updateSponsorshipPreferences
Change visibility of your sponsorship and opt in or out of email updates from the maintainer.
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The sponsorship that was updated. |
Input fields
input(UpdateSubscriptionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The input subscribable entity. |
Input fields
input(UpdateTeamDiscussionInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated discussion. |
Input fields
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
Preview notice
updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.
Input fields
input(UpdateTeamReviewAssignmentInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The team that was modified. |
Input fields
input(UpdateTeamsRepositoryInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository that was updated. |
|
The teams granted permission on the repository. |
Input fields
input(UpdateTopicsInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
Names of the provided topics that are not valid. |
|
The updated repository. |
Input fields
input(VerifyVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
|
A unique identifier for the client performing the mutation. |
|
The verifiable domain that was verified. |