PullRequest

A repository pull request.

Implements

Connections

assignees (UserConnection)
A list of Users assigned to this object.
Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

comments (IssueCommentConnection)
A list of comments associated with the pull request.
Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

commits (PullRequestCommitConnection)
A list of commits present in this pull request's head branch not present in the base branch.
Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

participants (UserConnection)
A list of Users that are participating in the Pull Request conversation.
Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

reactions (ReactionConnection)
A list of Reactions left on the Issue.
Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

content ReactionContent

Allows filtering Reactions by emoji.

orderBy ReactionOrder

Allows specifying the order in which reactions are returned.

timeline (PullRequestTimelineConnection)
A list of events associated with a PullRequest.
Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

since DateTime

Allows filtering timeline events by a since timestamp.

Fields

author (Actor)

The actor who authored the comment.

baseRef (Ref)

Identifies the base Ref associated with the pull request.

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

body (String!)

Identifies the body of the pull request.

bodyHTML (HTML!)

Identifies the body of the pull request rendered to HTML.

bodyText (String!)

Identifies the body of the pull request rendered to text.

closed (Boolean!)

true if the object is closed (definition of closed may depend on type)

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)
Deprecation notice

Exposed database IDs will eventually be removed in favor of global Relay IDs.

Identifies the primary key from the database.

editor (Actor)

The actor who edited this pull request's body.

headRef (Ref)

Identifies the head Ref associated with the pull request.

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

headRepository (Repository)

The repository associated with this pull request's head Ref.

headRepositoryOwner (RepositoryOwner!)

The owner of the repository associated with this pull request's head Ref.

labels (LabelConnection)

A list of labels associated with the object.

Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

lastEditedAt (DateTime)

The moment the editor made the last edit

locked (Boolean!)

true if the object is locked

mergeCommit (Commit)

The commit that was created when this pull request was merged.

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

merged (Boolean!)

Whether or not the pull request was merged.

mergedAt (DateTime)

The date and time that the pull request was merged.

number (Int!)

Identifies the pull request number.

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

repository (Repository!)

The repository associated with this pull request.

resourcePath (URI!)

The HTTP path for this issue

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

Argument Type Description
first Int

Returns the first n elements from the list.

after String

Returns the elements in the list that come after the specified global ID.

last Int

Returns the last n elements from the list.

before String

Returns the elements in the list that come before the specified global ID.

states [PullRequestReviewState!]

A list of states to filter the reviews.

state (PullRequestState!)

Identifies the state of the pull request.

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

title (String!)

Identifies the pull request title.

updatedAt (DateTime!)
Deprecation notice

General type updated timestamps will eventually be replaced by other field specific timestamps.

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP url for this issue

viaIntegration (Integration)

The integration that created this object.

viewerCanReact (Boolean!)

Can user react to this subject

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerSubscription (SubscriptionState!)

Identifies if the viewer is watching, not watching, or ignoring the repository.