Github API - Test Config

PullRequestCommit [object]

Represents a Git commit part of a pull request.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
UniformResourceLocatable

UniformResourceLocatable [interface]

Represents a type that can be retrieved by a URL.

Attributes
resourcePath URI

The HTML path to this resource.

url URI

The URL to this resource.

API:
Github GraphQL API
Attributes
commit Commit

Commit [object]

Represents a Git commit.

Implements
GitObjectNodeSubscribableUniformResourceLocatable
Attributes
abbreviatedOid String

An abbreviated version of the Git object ID

additions Int

The number of additions in this commit.

associatedPullRequests PullRequestConnection

The merged Pull Request that introduced the commit to the repository. If the
commit is not present in the default branch, additionally returns open Pull
Requests associated with the commit

author GitActor

Authorship details of the commit.

authoredByCommitter Boolean

Check if the committer and the author match.

authoredDate DateTime

The datetime when this commit was authored.

The list of authors for this commit based on the git author and the Co-authored-by
message trailer. The git author will always be first.

blame Blame

Fetches git blame information.

changedFiles Int

We recommend using the changedFilesIfAvailable field instead of
changedFiles, as changedFiles will cause your request to return an error
if GitHub is unable to calculate the number of changed files.

Deprecated: `changedFiles` will be removed. Use `changedFilesIfAvailable` instead. Removal on 2023-01-01 UTC.
changedFilesIfAvailable Int

The number of changed files in this commit. If GitHub is unable to calculate
the number of changed files (for example due to a timeout), this will return
null. We recommend using this field instead of changedFiles.

checkSuites CheckSuiteConnection

The check suites associated with a commit.

Comments made on the commit.

commitResourcePath URI

The HTTP path for this Git object

commitUrl URI

The HTTP URL for this Git object

committedDate DateTime

The datetime when this commit was committed.

committedViaWeb Boolean

Check if committed via GitHub web UI.

committer GitActor

Committer details of the commit.

deletions Int

The number of deletions in this commit.

deployments DeploymentConnection

The deployments associated with a commit.

file TreeEntry

The tree entry representing the file located at the given path.

The linear commit history starting from (and including) this commit, in the same order as git log.

id ID

The Node ID of the Commit object

message String

The Git commit message

messageBody String

The Git commit message body

messageBodyHTML HTML

The commit message body rendered to HTML.

messageHeadline String

The Git commit message headline

messageHeadlineHTML HTML

The commit message headline rendered to HTML.

The Git object ID

onBehalfOf Organization

The organization this commit was made on behalf of.

The parents of a commit.

pushedDate DateTime

The datetime when this commit was pushed.

Deprecated: `pushedDate` is no longer supported. Removal on 2023-07-01 UTC.
repository Repository

The Repository this commit belongs to

resourcePath URI

The HTTP path for this commit

signature GitSignature

Commit signing information, if present.

status Status

Status information for this commit

statusCheckRollup StatusCheckRollup

Check and Status rollup information for this commit.

submodules SubmoduleConnection

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

tarballUrl URI

Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.

tree Tree

Commit's root Tree

treeResourcePath URI

The HTTP path for the tree of this commit

treeUrl URI

The HTTP URL for the tree of this commit

url URI

The HTTP URL for this commit

viewerCanSubscribe Boolean

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

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

zipballUrl URI

Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.

API:
Github GraphQL API

The Git commit object

id ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The Node ID of the PullRequestCommit object

pullRequest PullRequest

PullRequest [object]

A repository pull request.

Implements
AssignableClosableCommentLabelableLockableNodeProjectV2OwnerReactableRepositoryNodeSubscribableUniformResourceLocatableUpdatableUpdatableComment
Attributes
activeLockReason LockReason

Reason that the conversation was locked.

additions Int

The number of additions in this pull request.

assignees UserConnection

A list of Users assigned to this object.

author Actor

The actor who authored the comment.

authorAssociation CommentAuthorAssociation

Author's association with the subject of the comment.

autoMergeRequest AutoMergeRequest

Returns the auto-merge request object if one exists for this pull request.

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.

canBeRebased Boolean

Whether or not the pull request is rebaseable.

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.

closingIssuesReferences IssueConnection

List of issues that were may be closed by this pull request

A list of comments associated with the pull request.

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.

Deprecated: `databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2024-07-01 UTC.
deletions Int

The number of deletions in this pull request.

editor Actor

The actor who edited this pull request's body.

Lists the files changed within this pull request.

fullDatabaseId BigInt

Identifies the primary key from the database as a BigInt.

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 Hovercard

The hovercard information for this issue

id ID

The Node ID of the PullRequest object

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.

isInMergeQueue Boolean

Indicates whether the pull request is in a merge queue

isMergeQueueEnabled Boolean

Indicates whether the pull request's base ref has a merge queue enabled.

isReadByViewer Boolean

Is this pull request read by the viewer

A list of labels associated with the object.

lastEditedAt DateTime

The moment the editor made the last edit

latestOpinionatedReviews PullRequestReviewConnection

A list of latest reviews per user associated with the pull request.

A list of latest reviews per user associated with the pull request that are not also pending review.

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.

mergeQueue MergeQueue

The merge queue for the pull request's base branch

mergeQueueEntry MergeQueueEntry

The merge queue entry of the pull request in the base branch's merge queue

mergeStateStatus MergeStateStatus

Detailed information about the current pull request merge state status.

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 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 ProjectCardConnection

List of project cards associated with this pull request.

List of project items associated with this pull request.

projectV2 ProjectV2

Find a project by number.

projectsV2 ProjectV2Connection

A list of projects under the owner.

publishedAt DateTime

Identifies when the comment was published at.

reactionGroups ReactionGroup []

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

reactions ReactionConnection

A list of Reactions left on the Issue.

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 ReviewRequestConnection

A list of review requests associated with the pull request.

The list of all review threads for this pull request.

A list of reviews associated with the pull request.

Identifies the state of the pull request.

suggestedReviewers SuggestedReviewer []

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

A list of events, comments, commits, etc. associated with the pull request.

Deprecated: `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.

title String

Identifies the pull request title.

titleHTML HTML

Identifies the pull request title rendered to HTML.

totalCommentsCount Int

Returns a count of how many comments this pull request has received.

updatedAt DateTime

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

url URI

The HTTP URL for this pull request.

userContentEdits UserContentEditConnection

A list of edits to this content.

viewerCanApplySuggestion Boolean

Whether or not the viewer can apply suggestion.

viewerCanClose Boolean

Indicates if the object can be closed by the viewer.

viewerCanDeleteHeadRef Boolean

Check if the viewer can restore the deleted head ref.

viewerCanDisableAutoMerge Boolean

Whether or not the viewer can disable auto-merge

viewerCanEditFiles Boolean

Can the viewer edit files within this pull request.

viewerCanEnableAutoMerge Boolean

Whether or not the viewer can enable auto-merge

viewerCanMergeAsAdmin Boolean

Indicates whether the viewer can bypass branch protections and merge the pull request immediately

viewerCanReact Boolean

Can user react to this subject

viewerCanReopen Boolean

Indicates if the object can be reopened by the viewer.

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.

viewerCanUpdateBranch Boolean

Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref.
If the head ref is up to date or unable to be updated by this user, this will return false.

viewerCannotUpdateReasons CommentCannotUpdateReason []

Reasons why the current viewer can not update this comment.

viewerDidAuthor Boolean

Did the viewer author this comment.

viewerLatestReview PullRequestReview

The latest review given from the viewer.

viewerLatestReviewRequest ReviewRequest

The person who has requested the viewer for review on this pull request.

viewerMergeBodyText String

The merge body text for the viewer and method.

viewerMergeHeadlineText String

The merge headline text for the viewer and method.

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

API:
Github GraphQL API

The pull request this commit belongs to

resourcePath URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP path for this pull request commit

url URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP URL for this pull request commit

API:
Github GraphQL API