GitHubMutation

The root query for implementing GraphQL mutations.

EXAMPLE USAGES
GitHubMergePullRequest

Merge a GitHub pull request by its number with $title as the commit message.

Note as a precaution against merging a PR into the wrong target, you'll need to provide the current sha of the target branch head. You can find the sha under the headRef.oid field of the Pull Request, as per the GitHubGetPullRequest example

To merge the first PR on the OneGraph GraphQL Docs Repository, we could pass in the following variables:

{
  "repoName": "graphql-docs",
  "repoOwner": "OneGraph",
  "number": 1,
  "title": "Merge the GitHub examples, thank you @dwwoelfel!",
  "sha": "44d4e20fd739f486411049b7e94849d7b3332770"
}
GitHubAddPullRequestComment

Add a comment to a pull request given its id - see the GitHubGetPullRequest example for how to find a PR's id given its repository and number.

GitHubDeleteIssueById

You'll need to find the GitHub issue id first (see the GitHubFindIssueIdByNumber example) to use as the argument to issueId.

Since issue ids are globally unique across every kind of object in GitHub, you won't need to add the repository owner/name, just the id!

{
  "id": "MDU6SXNzdWU1NDUyNDk2ODg="
}
GitHubCreateBranchMutation

Create a branch name $branchName (from master) on the GitHub project ${repoOwner}/${repoName}

FIELDS
acceptEnterpriseAdministratorInvitation (GitHubAcceptEnterpriseAdministratorInvitationPayload)

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

acceptTopicSuggestion (GitHubAcceptTopicSuggestionPayload)

Applies a suggested topic to the repository.

addAssigneesToAssignable (GitHubAddAssigneesToAssignablePayload)

Adds assignees to an assignable object.

addComment (GitHubAddCommentPayload)

Adds a comment to an Issue or Pull Request.

addDiscussionComment (GitHubAddDiscussionCommentPayload)

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

addEnterpriseSupportEntitlement (GitHubAddEnterpriseSupportEntitlementPayload)

Adds a support entitlement to an enterprise member.

addLabelsToLabelable (GitHubAddLabelsToLabelablePayload)

Adds labels to a labelable object.

addProjectCard (GitHubAddProjectCardPayload)

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

addProjectColumn (GitHubAddProjectColumnPayload)

Adds a column to a Project.

addPullRequestReview (GitHubAddPullRequestReviewPayload)

Adds a review to a Pull Request.

addPullRequestReviewComment (GitHubAddPullRequestReviewCommentPayload)

Adds a comment to a review.

addPullRequestReviewThread (GitHubAddPullRequestReviewThreadPayload)

Adds a new thread to a pending Pull Request Review.

addReaction (GitHubAddReactionPayload)

Adds a reaction to a subject.

addStar (GitHubAddStarPayload)

Adds a star to a Starrable.

addUpvote (GitHubAddUpvotePayload)

Add an upvote to a discussion or discussion comment.

addVerifiableDomain (GitHubAddVerifiableDomainPayload)

Adds a verifiable domain to an owning account.

approveVerifiableDomain (GitHubApproveVerifiableDomainPayload)

Approve a verifiable domain for notification delivery.

archiveRepository (GitHubArchiveRepositoryPayload)

Marks a repository as archived.

cancelEnterpriseAdminInvitation (GitHubCancelEnterpriseAdminInvitationPayload)

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

changeUserStatus (GitHubChangeUserStatusPayload)

Update your status on GitHub.

clearLabelsFromLabelable (GitHubClearLabelsFromLabelablePayload)

Clears all labels from a labelable object.

cloneProject (GitHubCloneProjectPayload)

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

cloneTemplateRepository (GitHubCloneTemplateRepositoryPayload)

Create a new repository with the same files and directory structure as a template repository.

closeIssue (GitHubCloseIssuePayload)

Close an issue.

closePullRequest (GitHubClosePullRequestPayload)

Close a pull request.

convertProjectCardNoteToIssue (GitHubConvertProjectCardNoteToIssuePayload)

Convert a project note card to one associated with a newly created issue.

createBranchProtectionRule (GitHubCreateBranchProtectionRulePayload)

Create a new branch protection rule

createCheckRun (GitHubCreateCheckRunPayload)

Create a check run.

createCheckSuite (GitHubCreateCheckSuitePayload)

Create a check suite

createDiscussion (GitHubCreateDiscussionPayload)

Create a discussion.

createEnterpriseOrganization (GitHubCreateEnterpriseOrganizationPayload)

Creates an organization as part of an enterprise account.

createIpAllowListEntry (GitHubCreateIpAllowListEntryPayload)

Creates a new IP allow list entry.

createIssue (GitHubCreateIssuePayload)

Creates a new issue.

createProject (GitHubCreateProjectPayload)

Creates a new project.

createPullRequest (GitHubCreatePullRequestPayload)

Create a new pull request

createRef (GitHubCreateRefPayload)

Create a new Git Ref.

createRepository (GitHubCreateRepositoryPayload)

Create a new repository.

createTeamDiscussion (GitHubCreateTeamDiscussionPayload)

Creates a new team discussion.

createTeamDiscussionComment (GitHubCreateTeamDiscussionCommentPayload)

Creates a new team discussion comment.

declineTopicSuggestion (GitHubDeclineTopicSuggestionPayload)

Rejects a suggested topic for the repository.

deleteBranchProtectionRule (GitHubDeleteBranchProtectionRulePayload)

Delete a branch protection rule

deleteDeployment (GitHubDeleteDeploymentPayload)

Deletes a deployment.

deleteDiscussion (GitHubDeleteDiscussionPayload)

Delete a discussion and all of its replies.

deleteDiscussionComment (GitHubDeleteDiscussionCommentPayload)

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

deleteIpAllowListEntry (GitHubDeleteIpAllowListEntryPayload)

Deletes an IP allow list entry.

deleteIssue (GitHubDeleteIssuePayload)

Deletes an Issue object.

deleteIssueComment (GitHubDeleteIssueCommentPayload)

Deletes an IssueComment object.

deleteProject (GitHubDeleteProjectPayload)

Deletes a project.

deleteProjectCard (GitHubDeleteProjectCardPayload)

Deletes a project card.

deleteProjectColumn (GitHubDeleteProjectColumnPayload)

Deletes a project column.

deletePullRequestReview (GitHubDeletePullRequestReviewPayload)

Deletes a pull request review.

deletePullRequestReviewComment (GitHubDeletePullRequestReviewCommentPayload)

Deletes a pull request review comment.

deleteRef (GitHubDeleteRefPayload)

Delete a Git Ref.

deleteTeamDiscussion (GitHubDeleteTeamDiscussionPayload)

Deletes a team discussion.

deleteTeamDiscussionComment (GitHubDeleteTeamDiscussionCommentPayload)

Deletes a team discussion comment.

deleteVerifiableDomain (GitHubDeleteVerifiableDomainPayload)

Deletes a verifiable domain.

disablePullRequestAutoMerge (GitHubDisablePullRequestAutoMergePayload)

Disable auto merge on the given pull request

dismissPullRequestReview (GitHubDismissPullRequestReviewPayload)

Dismisses an approved or rejected pull request review.

enablePullRequestAutoMerge (GitHubEnablePullRequestAutoMergePayload)

Enable the default auto-merge on a pull request.

followUser (GitHubFollowUserPayload)

Follow a user.

inviteEnterpriseAdmin (GitHubInviteEnterpriseAdminPayload)

Invite someone to become an administrator of the enterprise.

linkRepositoryToProject (GitHubLinkRepositoryToProjectPayload)

Creates a repository link for a project.

lockLockable (GitHubLockLockablePayload)

Lock a lockable object

makeRestCall (GithubPassthroughMutation!)

Make a REST API call to the GitHub API.

OneGraph will inject the auth params for the API call.

Use this as an escape hatch if OneGraph does not yet support functionality of the underlying API.

markDiscussionCommentAsAnswer (GitHubMarkDiscussionCommentAsAnswerPayload)

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

markFileAsViewed (GitHubMarkFileAsViewedPayload)

Mark a pull request file as viewed

markPullRequestReadyForReview (GitHubMarkPullRequestReadyForReviewPayload)

Marks a pull request ready for review.

mergeBranch (GitHubMergeBranchPayload)

Merge a head into a branch.

mergePullRequest (GitHubMergePullRequestPayload)

Merge a pull request.

minimizeComment (GitHubMinimizeCommentPayload)

Minimizes a comment on an Issue, Commit, Pull Request, or Gist

moveProjectCard (GitHubMoveProjectCardPayload)

Moves a project card to another place.

moveProjectColumn (GitHubMoveProjectColumnPayload)

Moves a project column to another place.

pinIssue (GitHubPinIssuePayload)

Pin an issue to a repository

regenerateEnterpriseIdentityProviderRecoveryCodes (GitHubRegenerateEnterpriseIdentityProviderRecoveryCodesPayload)

Regenerates the identity provider recovery codes for an enterprise

regenerateVerifiableDomainToken (GitHubRegenerateVerifiableDomainTokenPayload)

Regenerates a verifiable domain's verification token.

removeAssigneesFromAssignable (GitHubRemoveAssigneesFromAssignablePayload)

Removes assignees from an assignable object.

removeEnterpriseAdmin (GitHubRemoveEnterpriseAdminPayload)

Removes an administrator from the enterprise.

removeEnterpriseIdentityProvider (GitHubRemoveEnterpriseIdentityProviderPayload)

Removes the identity provider from an enterprise

removeEnterpriseOrganization (GitHubRemoveEnterpriseOrganizationPayload)

Removes an organization from the enterprise

removeEnterpriseSupportEntitlement (GitHubRemoveEnterpriseSupportEntitlementPayload)

Removes a support entitlement from an enterprise member.

removeLabelsFromLabelable (GitHubRemoveLabelsFromLabelablePayload)

Removes labels from a Labelable object.

removeOutsideCollaborator (GitHubRemoveOutsideCollaboratorPayload)

Removes outside collaborator from all repositories in an organization.

removeReaction (GitHubRemoveReactionPayload)

Removes a reaction from a subject.

removeStar (GitHubRemoveStarPayload)

Removes a star from a Starrable.

removeUpvote (GitHubRemoveUpvotePayload)

Remove an upvote to a discussion or discussion comment.

reopenIssue (GitHubReopenIssuePayload)

Reopen a issue.

reopenPullRequest (GitHubReopenPullRequestPayload)

Reopen a pull request.

requestReviews (GitHubRequestReviewsPayload)

Set review requests on a pull request.

rerequestCheckSuite (GitHubRerequestCheckSuitePayload)

Rerequests an existing check suite.

resolveReviewThread (GitHubResolveReviewThreadPayload)

Marks a review thread as resolved.

setEnterpriseIdentityProvider (GitHubSetEnterpriseIdentityProviderPayload)

Creates or updates the identity provider for an enterprise.

setOrganizationInteractionLimit (GitHubSetOrganizationInteractionLimitPayload)

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

setRepositoryInteractionLimit (GitHubSetRepositoryInteractionLimitPayload)

Sets an interaction limit setting for a repository.

setUserInteractionLimit (GitHubSetUserInteractionLimitPayload)

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

submitPullRequestReview (GitHubSubmitPullRequestReviewPayload)

Submits a pending pull request review.

transferIssue (GitHubTransferIssuePayload)

Transfer an issue to a different repository

unarchiveRepository (GitHubUnarchiveRepositoryPayload)

Unarchives a repository.

unfollowUser (GitHubUnfollowUserPayload)

Unfollow a user.

unlinkRepositoryFromProject (GitHubUnlinkRepositoryFromProjectPayload)

Deletes a repository link from a project.

unlockLockable (GitHubUnlockLockablePayload)

Unlock a lockable object

unmarkDiscussionCommentAsAnswer (GitHubUnmarkDiscussionCommentAsAnswerPayload)

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

unmarkFileAsViewed (GitHubUnmarkFileAsViewedPayload)

Unmark a pull request file as viewed

unmarkIssueAsDuplicate (GitHubUnmarkIssueAsDuplicatePayload)

Unmark an issue as a duplicate of another issue.

unminimizeComment (GitHubUnminimizeCommentPayload)

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

unpinIssue (GitHubUnpinIssuePayload)

Unpin a pinned issue from a repository

unresolveReviewThread (GitHubUnresolveReviewThreadPayload)

Marks a review thread as unresolved.

updateBranchProtectionRule (GitHubUpdateBranchProtectionRulePayload)

Create a new branch protection rule

updateCheckRun (GitHubUpdateCheckRunPayload)

Update a check run

updateCheckSuitePreferences (GitHubUpdateCheckSuitePreferencesPayload)

Modifies the settings of an existing check suite

updateDiscussion (GitHubUpdateDiscussionPayload)

Update a discussion

updateDiscussionComment (GitHubUpdateDiscussionCommentPayload)

Update the contents of a comment on a Discussion

updateEnterpriseAdministratorRole (GitHubUpdateEnterpriseAdministratorRolePayload)

Updates the role of an enterprise administrator.

updateEnterpriseAllowPrivateRepositoryForkingSetting (GitHubUpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload)

Sets whether private repository forks are enabled for an enterprise.

updateEnterpriseDefaultRepositoryPermissionSetting (GitHubUpdateEnterpriseDefaultRepositoryPermissionSettingPayload)

Sets the default repository permission for organizations in an enterprise.

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting (GitHubUpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload)

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

updateEnterpriseMembersCanCreateRepositoriesSetting (GitHubUpdateEnterpriseMembersCanCreateRepositoriesSettingPayload)

Sets the members can create repositories setting for an enterprise.

updateEnterpriseMembersCanDeleteIssuesSetting (GitHubUpdateEnterpriseMembersCanDeleteIssuesSettingPayload)

Sets the members can delete issues setting for an enterprise.

updateEnterpriseMembersCanDeleteRepositoriesSetting (GitHubUpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload)

Sets the members can delete repositories setting for an enterprise.

updateEnterpriseMembersCanInviteCollaboratorsSetting (GitHubUpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload)

Sets whether members can invite collaborators are enabled for an enterprise.

updateEnterpriseMembersCanMakePurchasesSetting (GitHubUpdateEnterpriseMembersCanMakePurchasesSettingPayload)

Sets whether or not an organization admin can make purchases.

updateEnterpriseMembersCanUpdateProtectedBranchesSetting (GitHubUpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload)

Sets the members can update protected branches setting for an enterprise.

updateEnterpriseMembersCanViewDependencyInsightsSetting (GitHubUpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload)

Sets the members can view dependency insights for an enterprise.

updateEnterpriseOrganizationProjectsSetting (GitHubUpdateEnterpriseOrganizationProjectsSettingPayload)

Sets whether organization projects are enabled for an enterprise.

updateEnterpriseProfile (GitHubUpdateEnterpriseProfilePayload)

Updates an enterprise's profile.

updateEnterpriseRepositoryProjectsSetting (GitHubUpdateEnterpriseRepositoryProjectsSettingPayload)

Sets whether repository projects are enabled for a enterprise.

updateEnterpriseTeamDiscussionsSetting (GitHubUpdateEnterpriseTeamDiscussionsSettingPayload)

Sets whether team discussions are enabled for an enterprise.

updateEnterpriseTwoFactorAuthenticationRequiredSetting (GitHubUpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload)

Sets whether two factor authentication is required for all users in an enterprise.

updateIpAllowListEnabledSetting (GitHubUpdateIpAllowListEnabledSettingPayload)

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

updateIpAllowListEntry (GitHubUpdateIpAllowListEntryPayload)

Updates an IP allow list entry.

updateIssue (GitHubUpdateIssuePayload)

Updates an Issue.

updateIssueComment (GitHubUpdateIssueCommentPayload)

Updates an IssueComment object.

updateNotificationRestrictionSetting (GitHubUpdateNotificationRestrictionSettingPayload)

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

updateProject (GitHubUpdateProjectPayload)

Updates an existing project.

updateProjectCard (GitHubUpdateProjectCardPayload)

Updates an existing project card.

updateProjectColumn (GitHubUpdateProjectColumnPayload)

Updates an existing project column.

updatePullRequest (GitHubUpdatePullRequestPayload)

Update a pull request

updatePullRequestReview (GitHubUpdatePullRequestReviewPayload)

Updates the body of a pull request review.

updatePullRequestReviewComment (GitHubUpdatePullRequestReviewCommentPayload)

Updates a pull request review comment.

updateRef (GitHubUpdateRefPayload)

Update a Git Ref.

updateRepository (GitHubUpdateRepositoryPayload)

Update information about a repository.

updateSubscription (GitHubUpdateSubscriptionPayload)

Updates the state for subscribable subjects.

updateTeamDiscussion (GitHubUpdateTeamDiscussionPayload)

Updates a team discussion.

updateTeamDiscussionComment (GitHubUpdateTeamDiscussionCommentPayload)

Updates a discussion comment.

updateTopics (GitHubUpdateTopicsPayload)

Replaces the repository's topics with the given topics.

verifyVerifiableDomain (GitHubVerifyVerifiableDomainPayload)

Verify that a verifiable domain has the expected DNS record.

DEPRECATED FIELDS
REQUIRED BY
Mutation

No description

____________________________________________________________________________________________________