Mutations
addPullRequestCreationCapBypassUsers
Add users to the pull request creation cap bypass list. Bypassed users can create pull requests regardless of the configured cap. Only repository admins can manage the bypass list. You can add a maximum of 100 users per request. The bypass list can only hold a maximum of 100 users.
Input fields for addPullRequestCreationCapBypassUsers
Return fields for addPullRequestCreationCapBypassUsers
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository with the updated bypass list. |
addPullRequestReview
Adds a review to a Pull Request.
Input fields for addPullRequestReview
input(AddPullRequestReviewInput!)
Return fields for addPullRequestReview
| 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. |
addPullRequestReviewComment
Adds a comment to a review.
Input fields for addPullRequestReviewComment
Return fields for addPullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created comment. |
| The edge from the review's comment connection. |
addPullRequestReviewThread
Adds a new thread to a pending Pull Request Review.
Input fields for addPullRequestReviewThread
input(AddPullRequestReviewThreadInput!)
Return fields for addPullRequestReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created thread. |
addPullRequestReviewThreadReply
Adds a reply to an existing Pull Request Review Thread.
Input fields for addPullRequestReviewThreadReply
Return fields for addPullRequestReviewThreadReply
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created reply. |
archivePullRequest
Archive a pull request. Closes, locks, and marks the pull request as archived. Only repository admins can archive pull requests.
Input fields for archivePullRequest
input(ArchivePullRequestInput!)
Return fields for archivePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was archived. |
closePullRequest
Close a pull request.
Input fields for closePullRequest
input(ClosePullRequestInput!)
Return fields for closePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was closed. |
convertPullRequestToDraft
Converts a pull request to draft.
Input fields for convertPullRequestToDraft
input(ConvertPullRequestToDraftInput!)
Return fields for convertPullRequestToDraft
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is now a draft. |
createPullRequest
Create a new pull request.
Input fields for createPullRequest
input(CreatePullRequestInput!)
Return fields for createPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new pull request. |
deletePullRequestReview
Deletes a pull request review.
Input fields for deletePullRequestReview
input(DeletePullRequestReviewInput!)
Return fields for deletePullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted pull request review. |
deletePullRequestReviewComment
Deletes a pull request review comment.
Input fields for deletePullRequestReviewComment
Return fields for deletePullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request review the deleted comment belonged to. |
| The deleted pull request review comment. |
dequeuePullRequest
Remove a pull request from the merge queue.
Input fields for dequeuePullRequest
input(DequeuePullRequestInput!)
Return fields for dequeuePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The merge queue entry of the dequeued pull request. |
disablePullRequestAutoMerge
Disable auto merge on the given pull request.
Input fields for disablePullRequestAutoMerge
Return fields for disablePullRequestAutoMerge
| 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. |
dismissPullRequestReview
Dismisses an approved or rejected pull request review.
Input fields for dismissPullRequestReview
input(DismissPullRequestReviewInput!)
Return fields for dismissPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The dismissed pull request review. |
enablePullRequestAutoMerge
Enable the default auto-merge on a pull request.
Input fields for enablePullRequestAutoMerge
input(EnablePullRequestAutoMergeInput!)
Return fields for enablePullRequestAutoMerge
| 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. |
enqueuePullRequest
Add a pull request to the merge queue.
Input fields for enqueuePullRequest
input(EnqueuePullRequestInput!)
Return fields for enqueuePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The merge queue entry for the enqueued pull request. |
markFileAsViewed
Mark a pull request file as viewed.
Input fields for markFileAsViewed
input(MarkFileAsViewedInput!)
Return fields for markFileAsViewed
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Input fields for markPullRequestReadyForReview
Return fields for markPullRequestReadyForReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is ready for review. |
mergePullRequest
Merge a pull request.
Input fields for mergePullRequest
input(MergePullRequestInput!)
Return fields for mergePullRequest
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request that was merged. |
removePullRequestCreationCapBypassUsers
Remove users from the pull request creation cap bypass list. Only repository admins can manage the bypass list.
Input fields for removePullRequestCreationCapBypassUsers
Return fields for removePullRequestCreationCapBypassUsers
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository with the updated bypass list. |
reopenPullRequest
Reopen a pull request.
Input fields for reopenPullRequest
input(ReopenPullRequestInput!)
Return fields for reopenPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reopened. |
requestReviews
Set review requests on a pull request.
Input fields for requestReviews
input(RequestReviewsInput!)
Return fields for requestReviews
| 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. |
requestReviewsByLogin
Set review requests on a pull request using login strings instead of IDs.
Input fields for requestReviewsByLogin
input(RequestReviewsByLoginInput!)
Return fields for requestReviewsByLogin
| 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. |
resolveReviewThread
Marks a review thread as resolved.
Input fields for resolveReviewThread
input(ResolveReviewThreadInput!)
Return fields for resolveReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
revertPullRequest
Create a pull request that reverts the changes from a merged pull request.
Input fields for revertPullRequest
input(RevertPullRequestInput!)
Return fields for revertPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reverted. |
| The new pull request that reverts the input pull request. |
submitPullRequestReview
Submits a pending pull request review.
Input fields for submitPullRequestReview
input(SubmitPullRequestReviewInput!)
Return fields for submitPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The submitted pull request review. |
unarchivePullRequest
Unarchive a pull request. Removes the archived flag from the pull request. Does not automatically reopen or unlock the pull request. Only repository admins can unarchive pull requests.
Input fields for unarchivePullRequest
input(UnarchivePullRequestInput!)
Return fields for unarchivePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was unarchived. |
unmarkFileAsViewed
Unmark a pull request file as viewed.
Input fields for unmarkFileAsViewed
input(UnmarkFileAsViewedInput!)
Return fields for unmarkFileAsViewed
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
unresolveReviewThread
Marks a review thread as unresolved.
Input fields for unresolveReviewThread
input(UnresolveReviewThreadInput!)
Return fields for unresolveReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
updatePullRequest
Update a pull request.
Input fields for updatePullRequest
input(