Repository [object]
A repository contains the content for a project.
Implements
PackageOwner [interface]
Represents an owner of a package.
Attributes
The Node ID of the PackageOwner object
A list of packages under the owner.
ProjectOwner [interface]
Represents an owner of a Project.
Attributes
The Node ID of the ProjectOwner object
Find project by number.
A list of projects under the owner.
The HTTP path listing owners projects
The HTTP URL listing owners projects
Can the current viewer create new projects on this owner.
ProjectV2Recent [interface]
Recent projects for the owner.
Attributes
Recent projects that this user has modified in the context of the owner.
RepositoryInfo [interface]
A subset of repository info.
Attributes
Identifies the date and time when the repository was archived.
Identifies the date and time when the object was created.
The description of the repository.
The description of the repository rendered to HTML.
Returns how many forks there are of this repository in the whole network.
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.
Indicates if the repository has wiki feature enabled.
The repository's URL.
Indicates if the repository is unmaintained.
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.
Identifies if the repository is a template that can be used to generate new repositories.
The license associated with the repository
The reason the repository has been locked.
The repository's original mirror URL.
The name of the repository.
The repository's name with owner.
The image used to represent this repository in Open Graph data.
The User owner of the repository.
Identifies the date and time when the repository was last pushed to.
The HTTP path for this repository
A description of the repository, rendered to HTML without any links in it.
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 the repository's visibility level.
Starrable [interface]
Things that can be starred.
Attributes
The Node ID of the Starrable object
Returns a count of how many stargazers there are on this object
A list of users who have starred this starrable.
Returns a boolean indicating whether the viewing user has starred this starrable.
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.
Attributes
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
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.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether or not Auto-merge can be enabled on pull requests in this repository.
BranchProtectionRuleConnection [object]
The connection type for BranchProtectionRule.
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 branch protection rules for this repository.
CodeOfConduct [object]
The Code of Conduct for a repository
Implements
Attributes
The body of the Code of Conduct
The Node ID of the CodeOfConduct object
The key for the Code of Conduct
The formal name of the Code of Conduct
The HTTP path for this Code of Conduct
The HTTP URL for this Code of Conduct
Returns the code of conduct for this repository
RepositoryCodeowners [object]
Information extracted from a repository's CODEOWNERS
file.
Attributes
Any problems that were encountered while parsing the CODEOWNERS
file.
Information extracted from the repository's CODEOWNERS
file.
RepositoryCollaboratorConnection [object]
The connection type for User.
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 collaborators associated with the repository.
CommitCommentConnection [object]
The connection type for CommitComment.
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 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.
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.
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.
The Ref associated with the repository's default branch.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether or not branches are automatically deleted when merged in this repository.
DependencyGraphManifestConnection [object]
The connection type for DependencyGraphManifest.
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 dependency manifests contained in the repository
DeployKeyConnection [object]
The connection type for DeployKey.
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 deploy keys that are on this repository.
DeploymentConnection [object]
The connection type for Deployment.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
Deployments associated with the repository
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 description of the repository.
The description of the repository rendered to HTML.
Discussion [object]
A discussion in a repository.
Implements
Attributes
Reason that the conversation was locked.
The comment chosen as this discussion's answer, if any.
The time when a user chose this discussion's answer, if answered.
The user who chose this discussion's answer, if answered.
The actor who authored the comment.
Author's association with the subject of the comment.
The main text of the discussion post.
The body rendered to HTML.
The body rendered to text.
The category for this discussion.
Indicates if the object is closed (definition of closed may depend on type)
Identifies the date and time when the object was closed.
The replies to the discussion.
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.
The Node ID of the Discussion object
Check if this comment was edited and includes an edit with the creation data
Only return answered/unanswered discussions
A list of labels associated with the object.
The moment the editor made the last edit
true
if the object is locked
The number identifying this discussion within the repository.
The poll associated with this discussion, if one exists.
Identifies when the comment was published at.
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 path for this discussion.
Identifies the reason for the discussion's state.
The title of this discussion.
Identifies the date and time when the object was last updated.
Number of upvotes that this subject has received.
The URL for this discussion.
A list of edits to this content.
Indicates if the object can be closed by the viewer.
Check if the current viewer can delete this object.
Can user react to this subject
Indicates if the object can be reopened by the viewer.
Check if the viewer is able to change their subscription status for the repository.
Check if the current viewer can update this object.
Whether or not the current user can add or remove an upvote on this subject.
Did the viewer author this comment.
Whether or not the current user has already upvoted this subject.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Returns a single discussion from the current repository by number.
DiscussionCategoryConnection [object]
The connection type for DiscussionCategory.
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 discussion categories that are available in the repository.
DiscussionCategory [object]
A category for discussions in a repository.
Implements
Attributes
Identifies the date and time when the object was created.
A description of this category.
An emoji representing this category.
This category's emoji rendered as HTML.
The Node ID of the DiscussionCategory object
Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.
The name of this category.
The repository associated with this node.
The slug of this category.
Identifies the date and time when the object was last updated.
A discussion category by slug.
DiscussionConnection [object]
The connection type for Discussion.
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 discussions that have been opened in the repository.
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 kilobytes this repository occupies on disk.
Environment [object]
An environment.
Implements
Attributes
Identifies the primary key from the database.
The Node ID of the Environment object
The name of the environment
The protection rules defined for this environment
Returns a single active environment from the current repository by name.
EnvironmentConnection [object]
The connection type for Environment.
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 environments that are in this repository.
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 how many forks there are of this repository in the whole network.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether this repository allows forks.
RepositoryConnection [object]
A list of repositories owned by 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.
The total size in kilobytes of all repositories in the connection. Value will
never be larger than max 32-bit signed integer.
A list of direct forked repositories.
FundingLink [object]
A funding platform link for a repository.
Attributes
The funding platform this link is for.
The configured URL for this funding link.
The funding links for this repository
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository has the Discussions feature enabled.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository has issues feature enabled.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository has the Projects feature enabled.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository displays a Sponsor button for financial contributions.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether vulnerability alerts are enabled for the repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository has wiki feature enabled.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The repository's URL.
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 Repository object
RepositoryInteractionAbility [object]
Repository interaction limit that applies to this object.
Attributes
The time the currently active limit expires.
The current limit that is enabled on this object.
The origin of the currently active interaction limit.
The interaction ability settings for this repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository is unmaintained.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Returns true if blank issue creation is allowed
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Returns whether or not this repository disabled.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Returns whether or not this repository is empty.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Identifies if the repository is a fork.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates if the repository has been locked or not.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Identifies if the repository is a mirror.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Identifies if the repository is private or internal.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Returns true if this repository has a security policy
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Identifies if the repository is a template that can be used to generate new repositories.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Is this repository a user configuration repository?
Issue [object]
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
Implements
Attributes
Reason that the conversation was locked.
A list of Users assigned to this object.
The actor who authored the comment.
Author's association with the subject of the comment.
Identifies the body of the issue.
The body rendered to HTML.
The http path for this issue body
Identifies the body of the issue rendered to text.
The http URL for this issue body
Indicates if the object is closed (definition of closed may depend on type)
Identifies the date and time when the object was closed.
A list of comments associated with the Issue.
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 hovercard information for this issue
The Node ID of the Issue object
Check if this comment was edited and includes an edit with the creation data
Indicates whether or not this issue is currently pinned to the repository issues list
Is this issue read by the viewer
A list of labels associated with the object.
The moment the editor made the last edit
Branches linked to this issue.
true
if the object is locked
Identifies the milestone associated with the issue.
Identifies the issue number.
A list of Users that are participating in the Issue conversation.
List of project cards associated with this issue.
List of project items associated with this issue.
Find a project by number.
A list of projects under the owner.
Identifies when the comment was published at.
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 for this issue
Identifies the state of the issue.
Identifies the reason for the issue state.
A list of events, comments, commits, etc. associated with the issue.
A list of events, comments, commits, etc. associated with the issue.
Identifies the issue title.
Identifies the issue title rendered to HTML.
A list of issues that track this issue
A list of issues tracked inside the current issue
The number of tracked issues for this issue
Identifies the date and time when the object was last updated.
The HTTP URL for this issue
A list of edits to this content.
Indicates if the object can be closed by the viewer.
Check if the current viewer can delete this object.
Can user react to this subject
Indicates if the object can be reopened by the viewer.
Check if the viewer is able to change their subscription status for the repository.
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.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Identifies the viewer's thread subscription form action.
Identifies the viewer's thread subscription status.
Returns a single issue from the current repository by number.
IssueOrPullRequest [union]
Used for return value of Repository.issueOrPullRequest.
Union
Returns a single issue-like object from the current repository by number.
IssueTemplate [object]
A repository issue template.
Attributes
The template purpose.
The suggested assignees.
The suggested issue body.
The template filename.
The suggested issue labels
The template name.
The suggested issue title.
Returns a list of issue templates associated to the repository
A list of issues that have been opened in the repository.
Label [object]
A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.
Implements
Attributes
Identifies the label color.
Identifies the date and time when the label was created.
A brief description of this label.
The Node ID of the Label object
Indicates whether or not this is a default label.
A list of issues associated with this label.
Identifies the label name.
A list of pull requests associated with this label.
The repository associated with this label.
The HTTP path for this label.
Identifies the date and time when the label was last updated.
The HTTP URL for this label.
Returns a single label by name
A list of labels associated with the repository.
LanguageConnection [object]
A list of languages associated with the parent.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The total size in bytes of files written in that language.
A list containing a breakdown of the language composition of the repository.
Release [object]
A release contains the content for a release.
Implements
Attributes
The author of the release
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The description of the release.
The description of this release rendered to HTML.
The Node ID of the Release object
Whether or not the release is a draft
Whether or not the release is the latest releast
Whether or not the release is a prerelease
A list of users mentioned in the release description
The title of the release.
Identifies the date and time when the release was created.
A list of reactions grouped by content left on the subject.
A list of Reactions left on the Issue.
List of releases assets which are dependent on this release.
The repository that the release belongs to.
The HTTP path for this issue
A description of the release, rendered to HTML without any links in it.
The Git tag the release points to
The tag commit for this release.
The name of the release's Git tag
Identifies the date and time when the object was last updated.
The HTTP URL for this issue
Can user react to this subject
Get the latest release for the repository if one exists.
License [object]
A repository's open source license
Implements
Attributes
The full text of the license
The conditions set by the license
A human-readable description of the license
Whether the license should be featured
Whether the license should be displayed in license pickers
The Node ID of the License object
Instructions on how to implement the license
The lowercased SPDX ID of the license
The limitations set by the license
The license full name specified by <https://spdx.org/licenses>
Customary short name if applicable (e.g, GPLv3)
The permissions set by the license
Whether the license is a pseudo-license placeholder (e.g., other, no-license)
Short identifier specified by <https://spdx.org/licenses>
URL to the license on <https://choosealicense.com>
The license associated with the repository
RepositoryLockReason [enum]
The possible reasons a given repository could be in a locked state.
Possible values
The repository is locked due to a billing related reason.
The repository is locked due to a migration.
The repository is locked due to a move.
The repository is locked due to a rename.
The repository is locked due to a trade controls related reason.
The repository is locked due to an ownership transfer.
The reason the repository has been locked.
A list of Users that can be mentioned in the context of the repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether or not PRs are merged with a merge commit on this repository.
MergeCommitMessage [enum]
The possible default commit messages for merges.
Possible values
Default to a blank commit message.
Default to the pull request's body.
Default to the pull request's title.
How the default commit message will be generated when merging a pull request.
MergeCommitTitle [enum]
The possible default commit titles for merges.
Possible values
Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
Default to the pull request's title.
How the default commit title will be generated when merging a pull request.
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 a specified branch, otherwise the default branch if not provided.
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.
Returns a single milestone from the current repository by number.
MilestoneConnection [object]
The connection type for Milestone.
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 milestones associated with the repository.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The repository's original mirror URL.
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 name of the repository.
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 repository's name with owner.
GitObject [interface]
Represents a Git object.
Attributes
An abbreviated version of the Git object ID
The HTTP path for this Git object
The HTTP URL for this Git object
The Node ID of the GitObject object
The Git object ID
The Repository the Git object belongs to
A Git object in the repository
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The image used to represent this repository in Open Graph data.
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 User owner of the repository.
PackageConnection [object]
The connection type for Package.
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 packages under the owner.
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 parent, if this is a fork.
PinnedDiscussionConnection [object]
The connection type for PinnedDiscussion.
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 discussions that have been pinned in this repository.
PinnedIssueConnection [object]
The connection type for PinnedIssue.
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 pinned issues for this repository.
The primary language of the repository's code.
Project [object]
Projects manage issues, pull requests and notes within a project owner.
Implements
Attributes
The project's description body.
The projects description body rendered to HTML.
Indicates if the object is closed (definition of closed may depend on type)
Identifies the date and time when the object was closed.
List of columns in the project
Identifies the date and time when the object was created.
The actor who originally created the project.
Identifies the primary key from the database.
The Node ID of the Project object
The project's name.
The project's number.
The project's owner. Currently limited to repositories, organizations, and users.
List of pending cards in this project
Project progress details.
The HTTP path for this project
Whether the project is open or closed.
Identifies the date and time when the object was last updated.
The HTTP URL for this 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.
Find project by number.
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
Finds and returns the Project according to the provided Project number.
ProjectConnection [object]
A list of projects associated with the owner.
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.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path listing the repository's projects
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL listing the repository's projects
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.
List of projects linked to this repository.
PullRequest [object]
A repository pull request.
Implements
Attributes
Reason that the conversation was locked.
The number of additions in this pull request.
A list of Users assigned to this object.
The actor who authored the comment.
Author's association with the subject of the comment.
Returns the auto-merge request object if one exists for this pull request.
Identifies the base Ref associated with the pull request.
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.
The repository associated with this pull request's base Ref.
The body as Markdown.
The body rendered to HTML.
The body rendered to text.
Whether or not the pull request is rebaseable.
The number of changed files in this pull request.
The HTTP path for the checks of this pull request.
The HTTP URL for the checks of this pull request.
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
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.
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 number of deletions in this pull request.
The actor who edited this pull request's body.
Lists the files changed within this pull request.
Identifies the primary key from the database as a BigInt.
Identifies the head Ref associated with the pull request.
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.
The repository associated with this pull request's head Ref.
The owner of the repository associated with this pull request's head Ref.
The hovercard information for this issue
The Node ID of the PullRequest object
Check if this comment was edited and includes an edit with the creation data
The head and base repositories are different.
Identifies if the pull request is a draft.
Indicates whether the pull request is in a merge queue
Indicates whether the pull request's base ref has a merge queue enabled.
Is this pull request read by the viewer
A list of labels associated with the object.
The moment the editor made the last edit
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.
true
if the pull request is locked
Indicates whether maintainers can modify the pull request.
The commit that was created when this pull request was merged.
The merge queue for the pull request's base branch
The merge queue entry of the pull request in the base branch's merge queue
Detailed information about the current pull request merge state status.
Whether or not the pull request can be merged based on the existence of merge conflicts.
Whether or not the pull request was merged.
The date and time that the pull request was merged.
The actor who merged the pull request.
Identifies the milestone associated with the pull request.
Identifies the pull request number.
A list of Users that are participating in the Pull Request conversation.
The permalink to the pull request.
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.
List of project cards associated with this pull request.
List of project items associated with this pull request.
Find a project by number.
A list of projects under the owner.
Identifies when the comment was published at.
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 for this pull request.
The HTTP path for reverting this pull request.
The HTTP URL for reverting this pull request.
The current status of this pull request with respect to code review.
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.
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.
A list of events, comments, commits, etc. associated with the pull request.
Identifies the pull request title.
Identifies the pull request title rendered to HTML.
Returns a count of how many comments this pull request has received.
Identifies the date and time when the object was last updated.
The HTTP URL for this pull request.
A list of edits to this content.
Whether or not the viewer can apply suggestion.
Indicates if the object can be closed by the viewer.
Check if the viewer can restore the deleted head ref.
Whether or not the viewer can disable auto-merge
Can the viewer edit files within this pull request.
Whether or not the viewer can enable auto-merge
Indicates whether the viewer can bypass branch protections and merge the pull request immediately
Can user react to this subject
Indicates if the object can be reopened by the viewer.
Check if the viewer is able to change their subscription status for the repository.
Check if the current viewer can update this object.
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.
Reasons why the current viewer can not update this comment.
Did the viewer author this comment.
The latest review given from the viewer.
The person who has requested the viewer for review on this pull request.
The merge body text for the viewer and method.
The merge headline text for the viewer and method.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Returns a single pull request from the current repository by number.
PullRequestTemplate [object]
A repository pull request template.
Attributes
The body of the template
The filename of the template
The repository the template belongs to
Returns a list of pull request templates associated to the repository
PullRequestConnection [object]
The connection type for PullRequest.
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 pull requests that have been opened in the repository.
Identifies the date and time when the repository was last pushed to.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether or not rebase-merging is enabled on this repository.
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.
Recent projects that this user has modified in the context of the owner.
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.
Fetch a given ref from the repository
Fetch a list of refs from the repository
Release [object]
A release contains the content for a release.
Implements
Attributes
The author of the release
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The description of the release.
The description of this release rendered to HTML.
The Node ID of the Release object
Whether or not the release is a draft
Whether or not the release is the latest releast
Whether or not the release is a prerelease
A list of users mentioned in the release description
The title of the release.
Identifies the date and time when the release was created.
A list of reactions grouped by content left on the subject.
A list of Reactions left on the Issue.
List of releases assets which are dependent on this release.
The repository that the release belongs to.
The HTTP path for this issue
A description of the release, rendered to HTML without any links in it.
The Git tag the release points to
The tag commit for this release.
The name of the release's Git tag
Identifies the date and time when the object was last updated.
The HTTP URL for this issue
Can user react to this subject
Lookup a single release given various criteria.
ReleaseConnection [object]
The connection type for Release.
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 releases which are dependent on this repository.
RepositoryTopicConnection [object]
The connection type for RepositoryTopic.
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 applied repository-topic associations for this repository.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for this repository
RepositoryRuleset [object]
A repository ruleset.
Implements
Attributes
The actors that can bypass this ruleset
The set of conditions that must evaluate to true for this ruleset to apply
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The enforcement level of this ruleset
The Node ID of the RepositoryRuleset object
Name of the ruleset.
List of rules.
Source of ruleset.
Target of the ruleset.
Identifies the date and time when the object was last updated.
Returns a single ruleset from the current repository by ID.
RepositoryRulesetConnection [object]
The connection type for RepositoryRuleset.
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 rulesets for this repository.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The security policy URL.
A description of the repository, rendered to HTML without any links in it.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether or not squash-merging is enabled on this repository.
SquashMergeCommitMessage [enum]
The possible default commit messages for squash merges.
Possible values
Default to a blank commit message.
Default to the branch's commit messages.
Default to the pull request's body.
How the default commit message will be generated when squash merging a pull request.
SquashMergeCommitTitle [enum]
The possible default commit titles for squash merges.
Possible values
Default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
Default to the pull request's title.
How the default commit title will be generated when squash merging a pull request.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether a squash merge commit can use the pull request title as default.
The SSH URL to clone this repository
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 stargazers there are on this object
StargazerConnection [object]
The connection type for User.
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 users who have starred this starrable.
SubmoduleConnection [object]
The connection type for Submodule.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.
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.
Temporary authentication token for cloning this repository.
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 from which this repository was generated, if any.
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 repository
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Indicates whether the viewer has admin permissions on this repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Can the current viewer create new projects on this owner.
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
.
Indicates whether the viewer can update the topics of this repository.
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 last commit email for the viewer.
PullRequestMergeMethod [enum]
Represents available types of methods to use when merging a pull request.
Possible values
Add all commits from the head branch to the base branch with a merge commit.
Add all commits from the head branch onto the base branch individually.
Combine all commits from the head branch into a single commit in the base branch.
The last used merge method by the viewer or the default for the repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Returns a boolean indicating whether the viewing user has starred this starrable.
RepositoryPermission [enum]
The access level to a repository
Possible values
Can read, clone, and push to this repository. Can also manage issues, pull
requests, and repository settings, including adding collaborators
Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings
Can read and clone this repository. Can also open and comment on issues and pull requests
Can read and clone this repository. Can also manage issues and pull requests
Can read, clone, and push to this repository. Can also manage issues and pull requests
The users permission level on the repository. Will return null if authenticated as an GitHub App.
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.
A list of emails this viewer can commit with.
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.
RepositoryVisibility [enum]
The repository's visibility level.
Possible values
The repository is visible only to users in the same business.
The repository is visible only to those with explicit access.
The repository is visible to everyone.
Indicates the repository's visibility level.
RepositoryVulnerabilityAlert [object]
A Dependabot alert for a repository with a dependency affected by a security vulnerability.
Implements
Attributes
When was the alert auto-dismissed?
When was the alert created?
The associated Dependabot update
The scope of an alert's dependency
Comment explaining the reason the alert was dismissed
The reason the alert was dismissed
When was the alert dismissed?
The user who dismissed the alert
When was the alert fixed?
The Node ID of the RepositoryVulnerabilityAlert object
Identifies the alert number.
The associated repository
The associated security advisory
The associated security vulnerability
Identifies the state of the alert.
The vulnerable manifest filename
The vulnerable manifest path
The vulnerable requirements
Returns a single vulnerability alert from the current repository by number.
RepositoryVulnerabilityAlertConnection [object]
The connection type for RepositoryVulnerabilityAlert.
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 vulnerability alerts that are on this repository.
A list of users watching the repository.
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether contributors are required to sign off on web-based commits in this repository.