Skip to main content

Pull requests

Reference documentation for GraphQL schema types in the Pull requests category.

In this article

Mutations

addPullRequestReview

Mutation

Adds a review to a Pull Request.

Input fields for addPullRequestReview

Return fields for addPullRequestReview

NameDescription

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

Mutation

Adds a comment to a review.

Input fields for addPullRequestReviewComment

Return fields for addPullRequestReviewComment

NameDescription

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

Mutation

Adds a new thread to a pending Pull Request Review.

Input fields for addPullRequestReviewThread

Return fields for addPullRequestReviewThread

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.

addPullRequestReviewThreadReply

Mutation

Adds a reply to an existing Pull Request Review Thread.

Input fields for addPullRequestReviewThreadReply

Return fields for addPullRequestReviewThreadReply

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created reply.

closePullRequest

Mutation

Close a pull request.

Input fields for closePullRequest

Return fields for closePullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was closed.

convertPullRequestToDraft

Mutation

Converts a pull request to draft.

Input fields for convertPullRequestToDraft

Return fields for convertPullRequestToDraft

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is now a draft.

createPullRequest

Mutation

Create a new pull request.

Input fields for createPullRequest

Return fields for createPullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.

deletePullRequestReview

Mutation

Deletes a pull request review.

Input fields for deletePullRequestReview

Return fields for deletePullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The deleted pull request review.

deletePullRequestReviewComment

Mutation

Deletes a pull request review comment.

Input fields for deletePullRequestReviewComment

Return fields for deletePullRequestReviewComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.

pullRequestReviewComment (PullRequestReviewComment)

The deleted pull request review comment.

dequeuePullRequest

Mutation

Remove a pull request from the merge queue.

Input fields for dequeuePullRequest

Return fields for dequeuePullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry of the dequeued pull request.

disablePullRequestAutoMerge

Mutation

Disable auto merge on the given pull request.

Input fields for disablePullRequestAutoMerge

Return fields for disablePullRequestAutoMerge

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request auto merge was disabled on.

dismissPullRequestReview

Mutation

Dismisses an approved or rejected pull request review.

Input fields for dismissPullRequestReview

Return fields for dismissPullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

enablePullRequestAutoMerge

Mutation

Enable the default auto-merge on a pull request.

Input fields for enablePullRequestAutoMerge

Return fields for enablePullRequestAutoMerge

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request auto-merge was enabled on.

enqueuePullRequest

Mutation

Add a pull request to the merge queue.

Input fields for enqueuePullRequest

Return fields for enqueuePullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry for the enqueued pull request.

markFileAsViewed

Mutation

Mark a pull request file as viewed.

Input fields for markFileAsViewed

Return fields for markFileAsViewed

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

markPullRequestReadyForReview

Mutation

Marks a pull request ready for review.

Input fields for markPullRequestReadyForReview

Return fields for markPullRequestReadyForReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is ready for review.

mergePullRequest

Mutation

Merge a pull request.

Input fields for mergePullRequest

Return fields for mergePullRequest

NameDescription

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.

reopenPullRequest

Mutation

Reopen a pull request.

Input fields for reopenPullRequest

Return fields for reopenPullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reopened.

requestReviews

Mutation

Set review requests on a pull request.

Input fields for