Object GitHub::PullRequest
A repository pull request.
Fields
activeLockReason: LockReason
Reason that the conversation was locked.
additions: Int!
The number of additions in this pull request.
assignees(after: String, before: String, first: Int, last: Int): UserConnection!
A list of Users assigned to this object.
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.
baseRefOid: GitObjectID!
Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
baseRepository: Repository
The repository associated with this pull request's base Ref.
body: String!
The body as Markdown.
bodyHTML: HTML!
The body rendered to HTML.
bodyText: String!
The body rendered to text.
changedFiles: Int!
The number of changed files in this pull request.
checksResourcePath: URI!
The HTTP path for the checks of this pull request.
checksUrl: URI!
The HTTP URL for the checks of this pull request.
closed: Boolean!
true if the pull request is closed
closedAt: DateTime
Identifies the date and time when the object was closed.
comments(after: String, before: String, first: Int, last: Int): IssueCommentConnection!
A list of comments associated with the pull request.
commits(after: String, before: String, first: Int, last: Int): PullRequestCommitConnection!
A list of commits present in this pull request's head branch not present in the base branch.
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
Identifies the primary key from the database.
deletions: Int!
The number of deletions in this pull request.
editor: Actor
The actor who edited this pull request's body.
files(after: String, before: String, first: Int, last: Int): PullRequestChangedFileConnection
Lists the files changed within this pull request.
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.
headRefOid: GitObjectID!
Identifies the oid 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.
hovercard(includeNotificationContexts: Boolean = true): Hovercard!
The hovercard information for this issue
Args
includeNotificationContexts: Boolean = true
Whether or not to include notification contexts
id: ID!
includesCreatedEdit: Boolean!
Check if this comment was edited and includes an edit with the creation data
isCrossRepository: Boolean!
The head and base repositories are different.
isDraft: Boolean!
Identifies if the pull request is a draft.
labels(orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}, after: String, before: String, first: Int, last: Int): LabelConnection
A list of labels associated with the object.
Args
orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
Ordering options for labels returned from the connection.
lastEditedAt: DateTime
The moment the editor made the last edit
locked: Boolean!
true if the pull request is locked
maintainerCanModify: Boolean!
Indicates whether maintainers can modify the pull request.
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.
mergedBy: Actor
The actor who merged the pull request.
milestone: Milestone
Identifies the milestone associated with the pull request.
number: Int!
Identifies the pull request number.
participants(after: String, before: String, first: Int, last: Int): UserConnection!
A list of Users that are participating in the Pull Request conversation.
permalink: URI!
The permalink to the pull request.
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.
projectCards(after: String, before: String, first: Int, last: Int, archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]): ProjectCardConnection!
List of project cards associated with this pull request.
Args
archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
A list of archived states to filter the cards by
publishedAt: DateTime
Identifies when the comment was published at.
reactionGroups: [ReactionGroup!]
A list of reactions grouped by content left on the subject.
reactions(after: String, before: String, first: Int, last: Int, content: ReactionContent, orderBy: ReactionOrder): ReactionConnection!
A list of Reactions left on the Issue.
Args
content: ReactionContent
Allows filtering Reactions by emoji.
orderBy: ReactionOrder
Allows specifying the order in which reactions are returned.
repository: Repository!
The repository associated with this node.
resourcePath: URI!
The HTTP path for this pull request.
revertResourcePath: URI!
The HTTP path for reverting this pull request.
revertUrl: URI!
The HTTP URL for reverting this pull request.
reviewDecision: PullRequestReviewDecision
The current status of this pull request with respect to code review.
reviewRequests(after: String, before: String, first: Int, last: Int): ReviewRequestConnection
A list of review requests associated with the pull request.
reviewThreads(after: String, before: String, first: Int, last: Int): PullRequestReviewThreadConnection!
The list of all review threads for this pull request.
reviews(after: String, before: String, first: Int, last: Int, states: [PullRequestReviewState!], author: String): PullRequestReviewConnection
A list of reviews associated with the pull request.
Args
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.
timeline(since: DateTime, after: String, before: String, first: Int, last: Int): PullRequestTimelineConnection!
`timeline` will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.
A list of events, comments, commits, etc. associated with the pull request.
timelineItems(since: DateTime, skip: Int, itemTypes: [PullRequestTimelineItemsItemType!], after: String, before: String, first: Int, last: Int): PullRequestTimelineItemsConnection!
A list of events, comments, commits, etc. associated with the pull request.
Args
itemTypes: [PullRequestTimelineItemsItemType!]
Filter timeline items by type.
title: String!
Identifies the pull request title.
updatedAt: DateTime!
Identifies the date and time when the object was last updated.
url: URI!
The HTTP URL for this pull request.
userContentEdits(after: String, before: String, first: Int, last: Int): UserContentEditConnection
A list of edits to this content.
viewerCanApplySuggestion: Boolean!
Whether or not the viewer can apply suggestion.
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 subscribable entity.