PullRequest [object]
A repository pull request.
Implements
Assignable [interface]
An object that can have users assigned to it.
Attributes
A list of Users assigned to this object.
Closable [interface]
An object that can be closed
Attributes
Indicates if the object is closed (definition of closed may depend on type)
Identifies the date and time when the object was closed.
Indicates if the object can be closed by the viewer.
Indicates if the object can be reopened by the viewer.
Comment [interface]
Represents a comment.
Attributes
The actor who authored the comment.
Author's association with the subject of the comment.
The body as Markdown.
The body rendered to HTML.
The body rendered to text.
Identifies the date and time when the object was created.
Check if this comment was created via an email reply.
The actor who edited the comment.
The Node ID of the Comment object
Check if this comment was edited and includes an edit with the creation data
The moment the editor made the last edit
Identifies when the comment was published at.
Identifies the date and time when the object was last updated.
A list of edits to this content.
Did the viewer author this comment.
Labelable [interface]
An object that can have labels assigned to it.
Attributes
A list of labels associated with the object.
Lockable [interface]
An object that can be locked.
Attributes
Reason that the conversation was locked.
true if the object is locked
ProjectV2Owner [interface]
Represents an owner of a project.
Attributes
The Node ID of the ProjectV2Owner object
Find a project by number.
A list of projects under the owner.
Reactable [interface]
Represents a subject that can be reacted on.
Attributes
Identifies the primary key from the database.
The Node ID of the Reactable object
A list of reactions grouped by content left on the subject.
A list of Reactions left on the Issue.
Can user react to this subject
RepositoryNode [interface]
Represents a object that belongs to a repository.
Attributes
The repository associated with this node.
Subscribable [interface]
Entities that can be subscribed to for web and email notifications.
Attributes
The Node ID of the Subscribable object
Check if the viewer is able to change their subscription status for the repository.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Updatable [interface]
Entities that can be updated.
Attributes
Check if the current viewer can update this object.
UpdatableComment [interface]
Comments that can be updated.
Attributes
Reasons why the current viewer can not update this comment.
Attributes
LockReason [enum]
The possible reasons that an issue or pull request was locked.
Possible values
The issue or pull request was locked because the conversation was off-topic.
The issue or pull request was locked because the conversation was resolved.
The issue or pull request was locked because the conversation was spam.
The issue or pull request was locked because the conversation was too heated.
Reason that the conversation was locked.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
The number of additions in this pull request.
A list of Users assigned to this object.
Actor [interface]
Represents an object which can take actions on GitHub. Typically a User or Bot.
Attributes
A URL pointing to the actor's public avatar.
The username of the actor.
The HTTP path for this actor.
The HTTP URL for this actor.
The actor who authored the comment.
CommentAuthorAssociation [enum]
A comment author association with repository.
Possible values
Author has been invited to collaborate on the repository.
Author has previously committed to the repository.
Author has not previously committed to GitHub.
Author has not previously committed to the repository.
Author is a placeholder for an unclaimed user.
Author is a member of the organization that owns the repository.
Author has no association with the repository.
Author is the owner of the repository.
Author's association with the subject of the comment.
AutoMergeRequest [object]
Represents an auto-merge request for a pull request
Attributes
The email address of the author of this auto-merge request.
The commit message of the auto-merge request. If a merge queue is required by
the base branch, this value will be set by the merge queue when merging.
The commit title of the auto-merge request. If a merge queue is required by
the base branch, this value will be set by the merge queue when merging
When was this auto-merge request was enabled.
The actor who created the auto-merge request.
The merge method of the auto-merge request. If a merge queue is required by
the base branch, this value will be set by the merge queue when merging.
The pull request that this auto-merge request is set against.
Returns the auto-merge request object if one exists for this pull request.
Ref [object]
Represents a Git reference.
Implements
Attributes
A list of pull requests with this ref as the head ref.
Branch protection rules for this ref
Compares the current ref as a base ref to another head ref, if the comparison can be made.
The Node ID of the Ref object
The ref name.
The ref's prefix, such as refs/heads/ or refs/tags/.
Branch protection rules that are viewable by non-admins
The repository the ref belongs to.
A list of rules from active Repository and Organization rulesets that apply to this ref.
The object the ref points to. Returns null when object does not exist.
Identifies the base Ref associated with the pull request.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
Repository [object]
A repository contains the content for a project.
Implements
Attributes
Whether or not a pull request head branch that is behind its base branch can
always be updated even if it is not required to be up to date before merging.
Identifies the date and time when the repository was archived.
A list of users that can be assigned to issues in this repository.
Whether or not Auto-merge can be enabled on pull requests in this repository.
A list of branch protection rules for this repository.
Returns the code of conduct for this repository
Information extracted from the repository's CODEOWNERS file.
A list of collaborators associated with the repository.
A list of commit comments associated with the repository.
Returns a list of contact links associated to the repository
Returns the contributing guidelines for this repository.
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The Ref associated with the repository's default branch.
Whether or not branches are automatically deleted when merged in this repository.
A list of dependency manifests contained in the repository
A list of deploy keys that are on this repository.
Deployments associated with the repository
The description of the repository.
The description of the repository rendered to HTML.
Returns a single discussion from the current repository by number.
A list of discussion categories that are available in the repository.
A discussion category by slug.
A list of discussions that have been opened in the repository.
The number of kilobytes this repository occupies on disk.
Returns a single active environment from the current repository by name.
A list of environments that are in this repository.
Returns how many forks there are of this repository in the whole network.
Whether this repository allows forks.
A list of direct forked repositories.
The funding links for this repository
Indicates if the repository has the Discussions feature enabled.
Indicates if the repository has issues feature enabled.
Indicates if the repository has the Projects feature enabled.
Indicates if the repository displays a Sponsor button for financial contributions.
Whether vulnerability alerts are enabled for the repository.
Indicates if the repository has wiki feature enabled.
The repository's URL.
The Node ID of the Repository object
The interaction ability settings for this repository.
Indicates if the repository is unmaintained.
Returns true if blank issue creation is allowed
Returns whether or not this repository disabled.
Returns whether or not this repository is empty.
Identifies if the repository is a fork.
Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
Indicates if the repository has been locked or not.
Identifies if the repository is a mirror.
Identifies if the repository is private or internal.
Returns true if this repository has a security policy
Identifies if the repository is a template that can be used to generate new repositories.
Is this repository a user configuration repository?
Returns a single issue from the current repository by number.
Returns a single issue-like object from the current repository by number.
Returns a list of issue templates associated to the repository
A list of issues that have been opened in the repository.
Returns a single label by name
A list of labels associated with the repository.
A list containing a breakdown of the language composition of the repository.
Get the latest release for the repository if one exists.
The license associated with the repository
The reason the repository has been locked.
A list of Users that can be mentioned in the context of the repository.
Whether or not PRs are merged with a merge commit on this repository.
How the default commit message will be generated when merging a pull request.
How the default commit title will be generated when merging a pull request.
The merge queue for a specified branch, otherwise the default branch if not provided.
Returns a single milestone from the current repository by number.
A list of milestones associated with the repository.
The repository's original mirror URL.
The name of the repository.
The repository's name with owner.
A Git object in the repository
The image used to represent this repository in Open Graph data.
The User owner of the repository.
A list of packages under the owner.
The repository parent, if this is a fork.
A list of discussions that have been pinned in this repository.
A list of pinned issues for this repository.
The primary language of the repository's code.
Find project by number.
Finds and returns the Project according to the provided Project number.
A list of projects under the owner.
The HTTP path listing the repository's projects
The HTTP URL listing the repository's projects
List of projects linked to this repository.
Returns a single pull request from the current repository by number.
Returns a list of pull request templates associated to the repository
A list of pull requests that have been opened in the repository.
Identifies the date and time when the repository was last pushed to.
Whether or not rebase-merging is enabled on this repository.
Recent projects that this user has modified in the context of the owner.
Fetch a given ref from the repository
Fetch a list of refs from the repository
Lookup a single release given various criteria.
List of releases which are dependent on this repository.
A list of applied repository-topic associations for this repository.
The HTTP path for this repository
Returns a single ruleset from the current repository by ID.
A list of rulesets for this repository.
The security policy URL.
A description of the repository, rendered to HTML without any links in it.
Whether or not squash-merging is enabled on this repository.
How the default commit message will be generated when squash merging a pull request.
How the default commit title will be generated when squash merging a pull request.
Whether a squash merge commit can use the pull request title as default.
The SSH URL to clone this repository
Returns a count of how many stargazers there are on this object
A list of users who have starred this starrable.
Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.
Temporary authentication token for cloning this repository.
The repository from which this repository was generated, if any.
Identifies the date and time when the object was last updated.
The HTTP URL for this repository
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
Indicates whether the viewer has admin permissions on this repository.
Can the current viewer create new projects on this owner.
Check if the viewer is able to change their subscription status for the repository.
Indicates whether the viewer can update the topics of this repository.
The last commit email for the viewer.
The last used merge method by the viewer or the default for the repository.
Returns a boolean indicating whether the viewing user has starred this starrable.
The users permission level on the repository. Will return null if authenticated as an GitHub App.
A list of emails this viewer can commit with.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Indicates the repository's visibility level.
Returns a single vulnerability alert from the current repository by number.
A list of vulnerability alerts that are on this repository.
A list of users watching the repository.
Whether contributors are required to sign off on web-based commits in this repository.
The repository associated with this pull request's base Ref.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
The body as Markdown.
The body rendered to HTML.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
The body rendered to text.
Boolean [scalar]
The Boolean scalar type represents true or false.
Whether or not the pull request is rebaseable.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
The number of changed files in this pull request.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for the checks of this pull request.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for the checks of this pull request.
Boolean [scalar]
The Boolean scalar type represents true or false.
true if the pull request is closed
Identifies the date and time when the object was closed.
List of issues that were may be closed by this pull request
IssueCommentConnection [object]
The connection type for IssueComment.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of comments associated with the pull request.
PullRequestCommitConnection [object]
The connection type for PullRequestCommit.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of commits present in this pull request's head branch not present in the base branch.
Identifies the date and time when the object was created.
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if this comment was created via an email reply.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Identifies the primary key from the database.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
The number of deletions in this pull request.
Actor [interface]
Represents an object which can take actions on GitHub. Typically a User or Bot.
Attributes
A URL pointing to the actor's public avatar.
The username of the actor.
The HTTP path for this actor.
The HTTP URL for this actor.
The actor who edited this pull request's body.
PullRequestChangedFileConnection [object]
The connection type for PullRequestChangedFile.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
Lists the files changed within this pull request.
BigInt [scalar]
Represents non-fractional signed whole numeric values. Since the value may
exceed the size of a 32-bit integer, it's encoded as a string.
Identifies the primary key from the database as a BigInt.
Ref [object]
Represents a Git reference.
Implements
Attributes
A list of pull requests with this ref as the head ref.
Branch protection rules for this ref
Compares the current ref as a base ref to another head ref, if the comparison can be made.
The Node ID of the Ref object
The ref name.
The ref's prefix, such as refs/heads/ or refs/tags/.
Branch protection rules that are viewable by non-admins
The repository the ref belongs to.
A list of rules from active Repository and Organization rulesets that apply to this ref.
The object the ref points to. Returns null when object does not exist.
Identifies the head Ref associated with the pull request.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.
Repository [object]
A repository contains the content for a project.
Implements
Attributes
Whether or not a pull request head branch that is behind its base branch can
always be updated even if it is not required to be up to date before merging.
Identifies the date and time when the repository was archived.
A list of users that can be assigned to issues in this repository.
Whether or not Auto-merge can be enabled on pull requests in this repository.
A list of branch protection rules for this repository.
Returns the code of conduct for this repository
Information extracted from the repository's CODEOWNERS file.
A list of collaborators associated with the repository.
A list of commit comments associated with the repository.
Returns a list of contact links associated to the repository
Returns the contributing guidelines for this repository.
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The Ref associated with the repository's default branch.
Whether or not branches are automatically deleted when merged in this repository.
A list of dependency manifests contained in the repository
A list of deploy keys that are on this repository.
Deployments associated with the repository
The description of the repository.
The description of the repository rendered to HTML.
Returns a single discussion from the current repository by number.
A list of discussion categories that are available in the repository.
A discussion category by slug.
A list of discussions that have been opened in the repository.
The number of kilobytes this repository occupies on disk.
Returns a single active environment from the current repository by name.
A list of environments that are in this repository.
Returns how many forks there are of this repository in the whole network.
Whether this repository allows forks.
A list of direct forked repositories.
The funding links for this repository
Indicates if the repository has the Discussions feature enabled.
Indicates if the repository has issues feature enabled.
Indicates if the repository has the Projects feature enabled.
Indicates if the repository displays a Sponsor button for financial contributions.
Whether vulnerability alerts are enabled for the repository.
Indicates if the repository has wiki feature enabled.
The repository's URL.
The Node ID of the Repository object
The interaction ability settings for this repository.
Indicates if the repository is unmaintained.
Returns true if blank issue creation is allowed
Returns whether or not this repository disabled.
Returns whether or not this repository is empty.
Identifies if the repository is a fork.
Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
Indicates if the repository has been locked or not.
Identifies if the repository is a mirror.
Identifies if the repository is private or internal.
Returns true if this repository has a security policy
Identifies if the repository is a template that can be used to generate new repositories.
Is this repository a user configuration repository?
Returns a single issue from the current repository by number.
Returns a single issue-like object from the current repository by number.
Returns a list of issue templates associated to the repository
A list of issues that have been opened in the repository.
Returns a single label by name
A list of labels associated with the repository.
A list containing a breakdown of the language composition of the repository.
Get the latest release for the repository if one exists.
The license associated with the repository
The reason the repository has been locked.
A list of Users that can be mentioned in the context of the repository.
Whether or not PRs are merged with a merge commit on this repository.
How the default commit message will be generated when merging a pull request.
How the default commit title will be generated when merging a pull request.
The merge queue for a specified branch, otherwise the default branch if not provided.
Returns a single milestone from the current repository by number.
A list of milestones associated with the repository.
The repository's original mirror URL.
The name of the repository.
The repository's name with owner.
A Git object in the repository
The image used to represent this repository in Open Graph data.
The User owner of the repository.
A list of packages under the owner.
The repository parent, if this is a fork.
A list of discussions that have been pinned in this repository.
A list of pinned issues for this repository.
The primary language of the repository's code.
Find project by number.
Finds and returns the Project according to the provided Project number.
A list of projects under the owner.
The HTTP path listing the repository's projects
The HTTP URL listing the repository's projects
List of projects linked to this repository.
Returns a single pull request from the current repository by number.
Returns a list of pull request templates associated to the repository
A list of pull requests that have been opened in the repository.
Identifies the date and time when the repository was last pushed to.
Whether or not rebase-merging is enabled on this repository.
Recent projects that this user has modified in the context of the owner.
Fetch a given ref from the repository
Fetch a list of refs from the repository
Lookup a single release given various criteria.
List of releases which are dependent on this repository.
A list of applied repository-topic associations for this repository.
The HTTP path for this repository
Returns a single ruleset from the current repository by ID.
A list of rulesets for this repository.
The security policy URL.
A description of the repository, rendered to HTML without any links in it.
Whether or not squash-merging is enabled on this repository.
How the default commit message will be generated when squash merging a pull request.
How the default commit title will be generated when squash merging a pull request.
Whether a squash merge commit can use the pull request title as default.
The SSH URL to clone this repository
Returns a count of how many stargazers there are on this object
A list of users who have starred this starrable.
Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.
Temporary authentication token for cloning this repository.
The repository from which this repository was generated, if any.
Identifies the date and time when the object was last updated.
The HTTP URL for this repository
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
Indicates whether the viewer has admin permissions on this repository.
Can the current viewer create new projects on this owner.
Check if the viewer is able to change their subscription status for the repository.
Indicates whether the viewer can update the topics of this repository.
The last commit email for the viewer.
The last used merge method by the viewer or the default for the repository.
Returns a boolean indicating whether the viewing user has starred this starrable.
The users permission level on the repository. Will return null if authenticated as an GitHub App.
A list of emails this viewer can commit with.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Indicates the repository's visibility level.
Returns a single vulnerability alert from the current repository by number.
A list of vulnerability alerts that are on this repository.
A list of users watching the repository.
Whether contributors are required to sign off on web-based commits in this repository.
The repository associated with this pull request's head Ref.
RepositoryOwner [interface]
Represents an owner of a Repository.
Attributes
A URL pointing to the owner's public avatar.
The Node ID of the RepositoryOwner object
The username used to login.
A list of repositories that the user owns.
Find Repository.
The HTTP URL for the owner.
The HTTP URL for the owner.
The owner of the repository associated with this pull request's head Ref.
Hovercard [object]
Detail needed to display a hovercard for a user
Attributes
Each of the contexts for this hovercard
The hovercard information for this issue
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.
The Node ID of the PullRequest object
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if this comment was edited and includes an edit with the creation data
Boolean [scalar]
The Boolean scalar type represents true or false.
The head and base repositories are different.
Boolean [scalar]
The Boolean scalar type represents true or false.
Identifies if the pull request is a draft.
Boolean [scalar]
The Boolean scalar type represents true or false.
Indicates whether the pull request is in a merge queue
Boolean [scalar]
The Boolean scalar type represents true or false.
Indicates whether the pull request's base ref has a merge queue enabled.
Boolean [scalar]
The Boolean scalar type represents true or false.
Is this pull request read by the viewer
A list of labels associated with the object.
The moment the editor made the last edit
PullRequestReviewConnection [object]
The connection type for PullRequestReview.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of latest reviews per user associated with the pull request.
PullRequestReviewConnection [object]
The connection type for PullRequestReview.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of latest reviews per user associated with the pull request that are not also pending review.
Boolean [scalar]
The Boolean scalar type represents true or false.
true if the pull request is locked
Boolean [scalar]
The Boolean scalar type represents true or false.
Indicates whether maintainers can modify the pull request.
Commit [object]
Represents a Git commit.
Implements
Attributes
An abbreviated version of the Git object ID
The number of additions in this commit.
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
Authorship details of the commit.
Check if the committer and the author match.
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.
Fetches git blame information.
We recommend using the changedFilesIfAvailable field instead ofchangedFiles, as changedFiles will cause your request to return an error
if GitHub is unable to calculate the number of changed files.
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 returnnull. We recommend using this field instead of changedFiles.
The check suites associated with a commit.
Comments made on the commit.
The HTTP path for this Git object
The HTTP URL for this Git object
The datetime when this commit was committed.
Check if committed via GitHub web UI.
Committer details of the commit.
The number of deletions in this commit.
The deployments associated with a commit.
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.
The Node ID of the Commit object
The Git commit message
The Git commit message body
The commit message body rendered to HTML.
The Git commit message headline
The commit message headline rendered to HTML.
The Git object ID
The organization this commit was made on behalf of.
The parents of a commit.
The datetime when this commit was pushed.
The Repository this commit belongs to
The HTTP path for this commit
Commit signing information, if present.
Status information for this commit
Check and Status rollup information for this commit.
Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
Commit's root Tree
The HTTP path for the tree of this commit
The HTTP URL for the tree of this commit
The HTTP URL for this commit
Check if the viewer is able to change their subscription status for the repository.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
The commit that was created when this pull request was merged.
MergeQueue [object]
The queue of pull request entries to be merged into a protected branch in a repository.
Implements
Attributes
The configuration for this merge queue
The entries in the queue
The Node ID of the MergeQueue object
The estimated time in seconds until a newly added entry would be merged
The repository this merge queue belongs to
The HTTP path for this merge queue
The HTTP URL for this merge queue
The merge queue for the pull request's base branch
MergeQueueEntry [object]
Entries in a MergeQueue
Implements
Attributes
The base commit for this entry
The date and time this entry was added to the merge queue
The actor that enqueued this entry
The estimated time in seconds until this entry will be merged
The head commit for this entry
The Node ID of the MergeQueueEntry object
Whether this pull request should jump the queue
The merge queue that this entry belongs to
The position of this entry in the queue
The pull request that will be added to a merge group
Does this pull request need to be deployed on its own
The state of this entry in the queue
The merge queue entry of the pull request in the base branch's merge queue
MergeStateStatus [enum]
Detailed status information about a pull request merge.
Possible values
The head ref is out of date.
The merge is blocked.
Mergeable and passing commit status.
The merge commit cannot be cleanly created.
The merge is blocked due to the pull request being a draft.
Mergeable with passing commit status and pre-receive hooks.
The state cannot currently be determined.
Mergeable with non-passing commit status.
Detailed information about the current pull request merge state status.
MergeableState [enum]
Whether or not a PullRequest can be merged.
Possible values
The pull request cannot be merged due to merge conflicts.
The pull request can be merged.
The mergeability of the pull request is still being calculated.
Whether or not the pull request can be merged based on the existence of merge conflicts.
Boolean [scalar]
The Boolean scalar type represents true or false.
Whether or not the pull request was merged.
The date and time that the pull request was merged.
Actor [interface]
Represents an object which can take actions on GitHub. Typically a User or Bot.
Attributes
A URL pointing to the actor's public avatar.
The username of the actor.
The HTTP path for this actor.
The HTTP URL for this actor.
The actor who merged the pull request.
Milestone [object]
Represents a Milestone object on a given repository.
Implements
Attributes
Indicates if the object is closed (definition of closed may depend on type)
Identifies the date and time when the object was closed.
Identifies the date and time when the object was created.
Identifies the actor who created the milestone.
Identifies the description of the milestone.
Identifies the due date of the milestone.
The Node ID of the Milestone object
A list of issues associated with the milestone.
Identifies the number of the milestone.
Identifies the percentage complete for the milestone
A list of pull requests associated with the milestone.
The repository associated with this milestone.
The HTTP path for this milestone
Identifies the state of the milestone.
Identifies the title of the milestone.
Identifies the date and time when the object was last updated.
The HTTP URL for this milestone
Indicates if the object can be closed by the viewer.
Indicates if the object can be reopened by the viewer.
Identifies the milestone associated with the pull request.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Identifies the pull request number.
A list of Users that are participating in the Pull Request conversation.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The permalink to the pull request.
Commit [object]
Represents a Git commit.
Implements
Attributes
An abbreviated version of the Git object ID
The number of additions in this commit.
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
Authorship details of the commit.
Check if the committer and the author match.
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.
Fetches git blame information.
We recommend using the changedFilesIfAvailable field instead ofchangedFiles, as changedFiles will cause your request to return an error
if GitHub is unable to calculate the number of changed files.
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 returnnull. We recommend using this field instead of changedFiles.
The check suites associated with a commit.
Comments made on the commit.
The HTTP path for this Git object
The HTTP URL for this Git object
The datetime when this commit was committed.
Check if committed via GitHub web UI.
Committer details of the commit.
The number of deletions in this commit.
The deployments associated with a commit.
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.
The Node ID of the Commit object
The Git commit message
The Git commit message body
The commit message body rendered to HTML.
The Git commit message headline
The commit message headline rendered to HTML.
The Git object ID
The organization this commit was made on behalf of.
The parents of a commit.
The datetime when this commit was pushed.
The Repository this commit belongs to
The HTTP path for this commit
Commit signing information, if present.
Status information for this commit
Check and Status rollup information for this commit.
Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
Commit's root Tree
The HTTP path for the tree of this commit
The HTTP URL for the tree of this commit
The HTTP URL for this commit
Check if the viewer is able to change their subscription status for the repository.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
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 themergeable field for more details on the mergeability of the pull request.
ProjectCardConnection [object]
The connection type for ProjectCard.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
List of project cards associated with this pull request.
ProjectV2ItemConnection [object]
The connection type for ProjectV2Item.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
List of project items associated with this pull request.
ProjectV2 [object]
New projects that manage issues, pull requests and drafts using tables and boards.
Implements
Attributes
Returns true if the project is closed.
Identifies the date and time when the object was closed.
Identifies the date and time when the object was created.
The actor who originally created the project.
Identifies the primary key from the database.
A field of the project
List of fields and their constraints in the project
The Node ID of the ProjectV2 object
List of items in the project
The project's number.
The project's owner. Currently limited to organizations and users.
Returns true if the project is public.
The project's readme.
The repositories the project is linked to.
The HTTP path for this project
The project's short description.
The teams the project is linked to.
Returns true if this project is a template.
The project's name.
Identifies the date and time when the object was last updated.
The HTTP URL for this project
A view of the project
Indicates if the object can be closed by the viewer.
Indicates if the object can be reopened by the viewer.
Check if the current viewer can update this object.
List of views in the project
A workflow of the project
List of the workflows in the project
Find a project by number.
ProjectV2Connection [object]
The connection type for ProjectV2.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of projects under the owner.
Identifies when the comment was published at.
ReactionGroup [object]
A group of emoji reactions to a particular piece of content.
Attributes
Identifies the emoji reaction.
Identifies when the reaction was created.
Reactors to the reaction subject with the emotion represented by this reaction group.
The subject that was reacted to.
Users who have reacted to the reaction subject with the emotion represented by this reaction group
Whether or not the authenticated user has left a reaction on the subject.
A list of reactions grouped by content left on the subject.
ReactionConnection [object]
A list of reactions that have been left on the subject.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
Whether or not the authenticated user has left a reaction on the subject.
A list of Reactions left on the Issue.
Repository [object]
A repository contains the content for a project.
Implements
Attributes
Whether or not a pull request head branch that is behind its base branch can
always be updated even if it is not required to be up to date before merging.
Identifies the date and time when the repository was archived.
A list of users that can be assigned to issues in this repository.
Whether or not Auto-merge can be enabled on pull requests in this repository.
A list of branch protection rules for this repository.
Returns the code of conduct for this repository
Information extracted from the repository's CODEOWNERS file.
A list of collaborators associated with the repository.
A list of commit comments associated with the repository.
Returns a list of contact links associated to the repository
Returns the contributing guidelines for this repository.
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The Ref associated with the repository's default branch.
Whether or not branches are automatically deleted when merged in this repository.
A list of dependency manifests contained in the repository
A list of deploy keys that are on this repository.
Deployments associated with the repository
The description of the repository.
The description of the repository rendered to HTML.
Returns a single discussion from the current repository by number.
A list of discussion categories that are available in the repository.
A discussion category by slug.
A list of discussions that have been opened in the repository.
The number of kilobytes this repository occupies on disk.
Returns a single active environment from the current repository by name.
A list of environments that are in this repository.
Returns how many forks there are of this repository in the whole network.
Whether this repository allows forks.
A list of direct forked repositories.
The funding links for this repository
Indicates if the repository has the Discussions feature enabled.
Indicates if the repository has issues feature enabled.
Indicates if the repository has the Projects feature enabled.
Indicates if the repository displays a Sponsor button for financial contributions.
Whether vulnerability alerts are enabled for the repository.
Indicates if the repository has wiki feature enabled.
The repository's URL.
The Node ID of the Repository object
The interaction ability settings for this repository.
Indicates if the repository is unmaintained.
Returns true if blank issue creation is allowed
Returns whether or not this repository disabled.
Returns whether or not this repository is empty.
Identifies if the repository is a fork.
Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
Indicates if the repository has been locked or not.
Identifies if the repository is a mirror.
Identifies if the repository is private or internal.
Returns true if this repository has a security policy
Identifies if the repository is a template that can be used to generate new repositories.
Is this repository a user configuration repository?
Returns a single issue from the current repository by number.
Returns a single issue-like object from the current repository by number.
Returns a list of issue templates associated to the repository
A list of issues that have been opened in the repository.
Returns a single label by name
A list of labels associated with the repository.
A list containing a breakdown of the language composition of the repository.
Get the latest release for the repository if one exists.
The license associated with the repository
The reason the repository has been locked.
A list of Users that can be mentioned in the context of the repository.
Whether or not PRs are merged with a merge commit on this repository.
How the default commit message will be generated when merging a pull request.
How the default commit title will be generated when merging a pull request.
The merge queue for a specified branch, otherwise the default branch if not provided.
Returns a single milestone from the current repository by number.
A list of milestones associated with the repository.
The repository's original mirror URL.
The name of the repository.
The repository's name with owner.
A Git object in the repository
The image used to represent this repository in Open Graph data.
The User owner of the repository.
A list of packages under the owner.
The repository parent, if this is a fork.
A list of discussions that have been pinned in this repository.
A list of pinned issues for this repository.
The primary language of the repository's code.
Find project by number.
Finds and returns the Project according to the provided Project number.
A list of projects under the owner.
The HTTP path listing the repository's projects
The HTTP URL listing the repository's projects
List of projects linked to this repository.
Returns a single pull request from the current repository by number.
Returns a list of pull request templates associated to the repository
A list of pull requests that have been opened in the repository.
Identifies the date and time when the repository was last pushed to.
Whether or not rebase-merging is enabled on this repository.
Recent projects that this user has modified in the context of the owner.
Fetch a given ref from the repository
Fetch a list of refs from the repository
Lookup a single release given various criteria.
List of releases which are dependent on this repository.
A list of applied repository-topic associations for this repository.
The HTTP path for this repository
Returns a single ruleset from the current repository by ID.
A list of rulesets for this repository.
The security policy URL.
A description of the repository, rendered to HTML without any links in it.
Whether or not squash-merging is enabled on this repository.
How the default commit message will be generated when squash merging a pull request.
How the default commit title will be generated when squash merging a pull request.
Whether a squash merge commit can use the pull request title as default.
The SSH URL to clone this repository
Returns a count of how many stargazers there are on this object
A list of users who have starred this starrable.
Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.
Temporary authentication token for cloning this repository.
The repository from which this repository was generated, if any.
Identifies the date and time when the object was last updated.
The HTTP URL for this repository
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
Indicates whether the viewer has admin permissions on this repository.
Can the current viewer create new projects on this owner.
Check if the viewer is able to change their subscription status for the repository.
Indicates whether the viewer can update the topics of this repository.
The last commit email for the viewer.
The last used merge method by the viewer or the default for the repository.
Returns a boolean indicating whether the viewing user has starred this starrable.
The users permission level on the repository. Will return null if authenticated as an GitHub App.
A list of emails this viewer can commit with.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Indicates the repository's visibility level.
Returns a single vulnerability alert from the current repository by number.
A list of vulnerability alerts that are on this repository.
A list of users watching the repository.
Whether contributors are required to sign off on web-based commits in this repository.
The repository associated with this node.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for this pull request.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for reverting this pull request.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for reverting this pull request.
PullRequestReviewDecision [enum]
The review status of a pull request.
Possible values
The pull request has received an approving review.
Changes have been requested on the pull request.
A review is required before the pull request can be merged.
The current status of this pull request with respect to code review.
ReviewRequestConnection [object]
The connection type for ReviewRequest.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of review requests associated with the pull request.
PullRequestReviewThreadConnection [object]
Review comment threads for a pull request review.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The list of all review threads for this pull request.
PullRequestReviewConnection [object]
The connection type for PullRequestReview.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of reviews associated with the pull request.
PullRequestState [enum]
The possible states of a pull request.
Possible values
A pull request that has been closed without being merged.
A pull request that has been closed by being merged.
A pull request that is still open.
Identifies the state of the pull request.
SuggestedReviewer [object]
A suggestion to review a pull request based on a user's commit history and review comments.
Attributes
Is this suggestion based on past commits?
Is this suggestion based on past review comments?
Identifies the user suggested to review the pull request.
A list of reviewer suggestions based on commit history and past review comments.
PullRequestTimelineConnection [object]
The connection type for PullRequestTimelineItem.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of events, comments, commits, etc. associated with the pull request.
PullRequestTimelineItemsConnection [object]
The connection type for PullRequestTimelineItems.
Attributes
A list of edges.
Identifies the count of items after applying before and after filters.
A list of nodes.
Identifies the count of items after applying before/after filters and first/last/skip slicing.
Information to aid in pagination.
Identifies the total count of items in the connection.
Identifies the date and time when the timeline was last updated.
A list of events, comments, commits, etc. associated with the pull request.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Identifies the pull request title.
Identifies the pull request title rendered to HTML.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Returns a count of how many comments this pull request has received.
Identifies the date and time when the object was last updated.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for this pull request.
UserContentEditConnection [object]
A list of edits to content.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of edits to this content.
Boolean [scalar]
The Boolean scalar type represents true or false.
Whether or not the viewer can apply suggestion.
Boolean [scalar]
The Boolean scalar type represents true or false.
Indicates if the object can be closed by the viewer.
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if the viewer can restore the deleted head ref.
Boolean [scalar]
The Boolean scalar type represents true or false.
Whether or not the viewer can disable auto-merge
Boolean [scalar]
The Boolean scalar type represents true or false.
Can the viewer edit files within this pull request.
Boolean [scalar]
The Boolean scalar type represents true or false.
Whether or not the viewer can enable auto-merge
Boolean [scalar]
The Boolean scalar type represents true or false.
Indicates whether the viewer can bypass branch protections and merge the pull request immediately
Boolean [scalar]
The Boolean scalar type represents true or false.
Can user react to this subject
Boolean [scalar]
The Boolean scalar type represents true or false.
Indicates if the object can be reopened by the viewer.
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if the viewer is able to change their subscription status for the repository.
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if the current viewer can update this object.
Boolean [scalar]
The Boolean scalar type represents true or false.
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.
CommentCannotUpdateReason [enum]
The possible errors that will prevent a user from updating a comment.
Possible values
Unable to create comment because repository is archived.
You cannot update this comment
You must be the author or have write access to this repository to update this comment.
Unable to create comment because issue is locked.
You must be logged in to update this comment.
Repository is under maintenance.
At least one email address must be verified to update this comment.
Reasons why the current viewer can not update this comment.
Boolean [scalar]
The Boolean scalar type represents true or false.
Did the viewer author this comment.
PullRequestReview [object]
A review object for a given pull request.
Implements
Attributes
The actor who authored the comment.
Author's association with the subject of the comment.
Indicates whether the author of this review has push access to the repository.
Identifies the pull request review body.
The body rendered to HTML.
The body of this review rendered as plain text.
A list of review comments for the current pull request review.
Identifies the commit associated with this pull request review.
Identifies the date and time when the object was created.
Check if this comment was created via an email reply.
Identifies the primary key from the database.
The actor who edited the comment.
Identifies the primary key from the database as a BigInt.
The Node ID of the PullRequestReview object
Check if this comment was edited and includes an edit with the creation data
Returns whether or not a comment has been minimized.
The moment the editor made the last edit
Returns why the comment was minimized. One of abuse, off-topic,outdated, resolved, duplicate and spam. Note that the case and
formatting of these values differs from the inputs to the MinimizeComment mutation.
A list of teams that this review was made on behalf of.
Identifies when the comment was published at.
Identifies the pull request associated with this pull request review.
A list of reactions grouped by content left on the subject.
A list of Reactions left on the Issue.
The repository associated with this node.
The HTTP path permalink for this PullRequestReview.
Identifies the current state of the pull request review.
Identifies when the Pull Request Review was submitted
Identifies the date and time when the object was last updated.
The HTTP URL permalink for this PullRequestReview.
A list of edits to this content.
Check if the current viewer can delete this object.
Check if the current viewer can minimize this object.
Can user react to this subject
Check if the current viewer can update this object.
Reasons why the current viewer can not update this comment.
Did the viewer author this comment.
The latest review given from the viewer.
ReviewRequest [object]
A request for a user to review a pull request.
Implements
Attributes
Whether this request was created for a code owner
Identifies the primary key from the database.
The Node ID of the ReviewRequest object
Identifies the pull request associated with this review request.
The reviewer that is requested.
The person who has requested the viewer for review on this pull request.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
The merge body text for the viewer and method.
String [scalar]
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
The merge headline text for the viewer and method.
SubscriptionState [enum]
The possible states of a subscription.
Possible values
The User is never notified.
The User is notified of all conversations.
The User is only notified when participating or @mentioned.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.