About objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
For example, the Repository
object has a field called name
, which is a String
.
For more information, see "Introduction to GraphQL."
ActorLocation
Location information for an actor.
AddedToMergeQueueEvent
Represents anadded_to_merge_queue
event on a given pull request.
AddedToMergeQueueEvent
Implements
Fields for AddedToMergeQueueEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who added this Pull Request to the merge queue. |
| The Node ID of the AddedToMergeQueueEvent object. |
| The merge queue where this pull request was added to. |
| PullRequest referenced by event. |
AddedToProjectEvent
Represents aadded_to_project
event on a given issue or pull request.
AddedToProjectEvent
Implements
Fields for AddedToProjectEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The Node ID of the AddedToProjectEvent object. |
| Project referenced by event. |
| Project card referenced by this project event. |
| Column name referenced by this project event. |
App
A GitHub App.
App
Implements
Fields for App
Name | Description |
---|---|
| The client ID of the app. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the app. |
| The Node ID of the App object. |
| The IP addresses of the app. Arguments for
|
| The hex color code, without the leading '#', for the logo background. |
| A URL pointing to the app's logo. Arguments for
|
| The name of the app. |
| A slug based on the name of the app for use in URLs. |
| Identifies the date and time when the object was last updated. |
| The URL to the app's homepage. |
AssignedEvent
Represents anassigned
event on any assignable object.
AssignedEvent
Implements
Fields for AssignedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the assignable associated with the event. |
| Identifies the user or mannequin that was assigned. |
| Identifies the date and time when the object was created. |
| The Node ID of the AssignedEvent object. |
| Identifies the user who was assigned. Warning
Assignees can now be mannequins. Use the |
AutoMergeDisabledEvent
Represents aauto_merge_disabled
event on a given pull request.
AutoMergeDisabledEvent
Implements
Fields for AutoMergeDisabledEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who disabled auto-merge for this Pull Request. |
| The Node ID of the AutoMergeDisabledEvent object. |
| PullRequest referenced by event. |
| The reason auto-merge was disabled. |
| The reason_code relating to why auto-merge was disabled. |
AutoMergeEnabledEvent
Represents aauto_merge_enabled
event on a given pull request.
AutoMergeEnabledEvent
Implements
Fields for AutoMergeEnabledEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge for this Pull Request. |
| The Node ID of the AutoMergeEnabledEvent object. |
| PullRequest referenced by event. |
AutoMergeRequest
Represents an auto-merge request for a pull request.
Fields for AutoMergeRequest
Name | Description |
---|---|
| 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. |
AutoRebaseEnabledEvent
Represents aauto_rebase_enabled
event on a given pull request.
AutoRebaseEnabledEvent
Implements
Fields for AutoRebaseEnabledEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge (rebase) for this Pull Request. |
| The Node ID of the AutoRebaseEnabledEvent object. |
| PullRequest referenced by event. |
AutoSquashEnabledEvent
Represents aauto_squash_enabled
event on a given pull request.
AutoSquashEnabledEvent
Implements
Fields for AutoSquashEnabledEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge (squash) for this Pull Request. |
| The Node ID of the AutoSquashEnabledEvent object. |
| PullRequest referenced by event. |
AutomaticBaseChangeFailedEvent
Represents aautomatic_base_change_failed
event on a given pull request.
AutomaticBaseChangeFailedEvent
Implements
Fields for AutomaticBaseChangeFailedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the AutomaticBaseChangeFailedEvent object. |
| The new base for this PR. |
| The old base for this PR. |
| PullRequest referenced by event. |
AutomaticBaseChangeSucceededEvent
Represents aautomatic_base_change_succeeded
event on a given pull request.
AutomaticBaseChangeSucceededEvent
Implements
Fields for AutomaticBaseChangeSucceededEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the AutomaticBaseChangeSucceededEvent object. |
| The new base for this PR. |
| The old base for this PR. |
| PullRequest referenced by event. |
BaseRefChangedEvent
Represents abase_ref_changed
event on a given issue or pull request.
BaseRefChangedEvent
Implements
Fields for BaseRefChangedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the name of the base ref for the pull request after it was changed. |
| Identifies the primary key from the database. |
| The Node ID of the BaseRefChangedEvent object. |
| Identifies the name of the base ref for the pull request before it was changed. |
| PullRequest referenced by event. |
BaseRefDeletedEvent
Represents abase_ref_deleted
event on a given pull request.
BaseRefDeletedEvent
Implements
Fields for BaseRefDeletedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the name of the Ref associated with the |
| Identifies the date and time when the object was created. |
| The Node ID of the BaseRefDeletedEvent object. |
| PullRequest referenced by event. |
BaseRefForcePushedEvent
Represents abase_ref_force_pushed
event on a given pull request.
BaseRefForcePushedEvent
Implements
Fields for BaseRefForcePushedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the after commit SHA for the |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| The Node ID of the BaseRefForcePushedEvent object. |
| PullRequest referenced by event. |
| Identifies the fully qualified ref name for the |
Blame
Represents a Git blame.
Fields for Blame
Name | Description |
---|---|
| The list of ranges from a Git blame. |
BlameRange
Represents a range of information from a Git blame.
Fields for BlameRange
Name | Description |
---|---|
| Identifies the recency of the change, from 1 (new) to 10 (old). This is calculated as a 2-quantile and determines the length of distance between the median age of all the changes in the file and the recency of the current range's change. |
| Identifies the line author. |
| The ending line for the range. |
| The starting line for the range. |
Blob
Represents a Git blob.
Blob
Implements
Fields for Blob
Name | Description |
---|---|
| An abbreviated version of the Git object ID. |
| Byte size of Blob object. |
| The HTTP path for this Git object. |
| The HTTP URL for this Git object. |
| The Node ID of the Blob object. |
| Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding. |
| Indicates whether the contents is truncated. |
| The Git object ID. |
| The Repository the Git object belongs to. |
| UTF8 text data or null if the Blob is binary. |
Bot
A special type of user which takes actions on behalf of GitHub Apps.
Bot
Implements
Fields for Bot
Name | Description |
---|---|
| A URL pointing to the GitHub App's public avatar. Arguments for
|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The Node ID of the Bot object. |
| The username of the actor. |
| The HTTP path for this bot. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this bot. |
BranchNamePatternParameters
Parameters to be used for the branch_name_pattern rule.
BranchProtectionRule
A branch protection rule.
BranchProtectionRule
Implements
Fields for BranchProtectionRule
Name | Description |
---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| Is branch creation a protected operation. |
| A list of conflicts matching branches protection rule and other branch protection rules. Arguments for
|
| A list of actors able to force push for this branch protection rule. Arguments for
|
| A list of actors able to bypass PRs for this branch protection rule. Arguments for
|
| The actor who created this branch protection rule. |
| Identifies the primary key from the database. |
| Will new commits pushed to matching branches dismiss pull request review approvals. |
| The Node ID of the BranchProtectionRule object. |
| Can admins override branch protection. |
| Whether users can pull changes from upstream when the branch is locked. Set to
|
| Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. |
| Repository refs that are protected by this rule. Arguments for
|
| Identifies the protection rule pattern. |
| A list push allowances for this branch protection rule. Arguments for
|
| The repository associated with this branch protection rule. |
| Whether the most recent push must be approved by someone other than the person who pushed it. |
| Number of approving reviews required to update matching branches. |
| List of required deployment environments that must be deployed successfully to update matching branches. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| List of required status checks that must pass for commits to be accepted to matching branches. |
| Are approving reviews required to update matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are commits required to be signed. |
| Are conversations required to be resolved before merging. |
| Does this branch require deployment to specific environments before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are status checks required to update matching branches. |
| Are branches required to be up to date before merging. |
| Is pushing to matching branches restricted. |
| Is dismissal of pull request reviews restricted. |
| A list review dismissal allowances for this branch protection rule. Arguments for
|
BranchProtectionRuleConflict
A conflict between two branch protection rules.
Fields for BranchProtectionRuleConflict
Name | Description |
---|---|
| Identifies the branch protection rule. |
| Identifies the conflicting branch protection rule. |
| Identifies the branch ref that has conflicting rules. |
BranchProtectionRuleConflictConnection
The connection type for BranchProtectionRuleConflict.
Fields for BranchProtectionRuleConflictConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
BranchProtectionRuleConflictEdge
An edge in a connection.
Fields for BranchProtectionRuleConflictEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
BranchProtectionRuleConnection
The connection type for BranchProtectionRule.
Fields for BranchProtectionRuleConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
BranchProtectionRuleEdge
An edge in a connection.
Fields for BranchProtectionRuleEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
BypassForcePushAllowance
A user, team, or app who has the ability to bypass a force push requirement on a protected branch.
BypassForcePushAllowance
Implements
Fields for BypassForcePushAllowance
Name | Description |
---|---|
| The actor that can force push. |
| Identifies the branch protection rule associated with the allowed user, team, or app. |
| The Node ID of the BypassForcePushAllowance object. |
BypassForcePushAllowanceConnection
The connection type for BypassForcePushAllowance.
Fields for BypassForcePushAllowanceConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
BypassForcePushAllowanceEdge
An edge in a connection.
Fields for BypassForcePushAllowanceEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
BypassPullRequestAllowance
A user, team, or app who has the ability to bypass a pull request requirement on a protected branch.
BypassPullRequestAllowance
Implements
Fields for BypassPullRequestAllowance
Name | Description |
---|---|
| The actor that can bypass. |
| Identifies the branch protection rule associated with the allowed user, team, or app. |
| The Node ID of the BypassPullRequestAllowance object. |
BypassPullRequestAllowanceConnection
The connection type for BypassPullRequestAllowance.
Fields for BypassPullRequestAllowanceConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
BypassPullRequestAllowanceEdge
An edge in a connection.
Fields for BypassPullRequestAllowanceEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CVSS
The Common Vulnerability Scoring System.
CWE
A common weakness enumeration.
CWEConnection
The connection type for CWE.
CWEEdge
An edge in a connection.
CheckAnnotation
A single check annotation.
Fields for CheckAnnotation
Name | Description |
---|---|
| The annotation's severity level. |
| The path to the file that this annotation was made on. |
| Identifies the primary key from the database. |
| The position of this annotation. |
| The annotation's message. |
| The path that this annotation was made on. |
| Additional information about the annotation. |
| The annotation's title. |
CheckAnnotationConnection
The connection type for CheckAnnotation.
Fields for CheckAnnotationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckAnnotationEdge
An edge in a connection.
Fields for CheckAnnotationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CheckAnnotationPosition
A character position in a check annotation.
CheckAnnotationSpan
An inclusive pair of positions for a check annotation.
Fields for CheckAnnotationSpan
Name | Description |
---|---|
| End position (inclusive). |
| Start position (inclusive). |
CheckRun
A check run.
CheckRun
Implements
Fields for CheckRun
Name | Description |
---|---|
| The check run's annotations. Arguments for
|
| The check suite that this run is a part of. |
| Identifies the date and time when the check run was completed. |
| The conclusion of the check run. |
| Identifies the primary key from the database. |
| The corresponding deployment for this job, if any. |
| The URL from which to find full details of the check run on the integrator's site. |
| A reference for the check run on the integrator's system. |
| The Node ID of the CheckRun object. |
| Whether this is required to pass before merging for a specific pull request. |
| The name of the check for this check run. |
| Information about a pending deployment, if any, in this check run. |
| The permalink to the check run summary. |
| The repository associated with this check run. |
| The HTTP path for this check run. |
| Identifies the date and time when the check run was started. |
| The current status of the check run. |
| The check run's steps. Arguments for
|
| A string representing the check run's summary. |
| A string representing the check run's text. |
| A string representing the check run. |
| The HTTP URL for this check run. |
CheckRunConnection
The connection type for CheckRun.
Fields for CheckRunConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckRunEdge
An edge in a connection.
CheckRunStateCount
Represents a count of the state of a check run.
Fields for CheckRunStateCount
Name | Description |
---|---|
| The number of check runs with this state. |
| The state of a check run. |
CheckStep
A single check step.
Fields for CheckStep
Name | Description |
---|---|
| Identifies the date and time when the check step was completed. |
| The conclusion of the check step. |
| A reference for the check step on the integrator's system. |
| The step's name. |
| The index of the step in the list of steps of the parent check run. |
| Number of seconds to completion. |
| Identifies the date and time when the check step was started. |
| The current status of the check step. |
CheckStepConnection
The connection type for CheckStep.
Fields for CheckStepConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckStepEdge
An edge in a connection.
CheckSuite
A check suite.
CheckSuite
Implements
Fields for CheckSuite
Name | Description |
---|---|
| The GitHub App which created this check suite. |
| The name of the branch for this check suite. |
| The check runs associated with a check suite. Arguments for
|
| The commit for this check suite. |
| The conclusion of this check suite. |
| Identifies the date and time when the object was created. |
| The user who triggered the check suite. |
| Identifies the primary key from the database. |
| The Node ID of the CheckSuite object. |
| A list of open pull requests matching the check suite. Arguments for
|
| The push that triggered this check suite. |
| The repository associated with this check suite. |
| The HTTP path for this check suite. |
| The status of this check suite. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this check suite. |
| The workflow run associated with this check suite. |
CheckSuiteConnection
The connection type for CheckSuite.
Fields for CheckSuiteConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckSuiteEdge
An edge in a connection.
Fields for CheckSuiteEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ClosedEvent
Represents aclosed
event on any Closable
.
ClosedEvent
Implements
Fields for ClosedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Object that was closed. |
| Object which triggered the creation of this event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ClosedEvent object. |
| The HTTP path for this closed event. |
| The reason the issue state was changed to closed. |
| The HTTP URL for this closed event. |
CodeOfConduct
The Code of Conduct for a repository.
CodeOfConduct
Implements
Fields for CodeOfConduct
Name | Description |
---|---|
| 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. |
CodeScanningParameters
Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
Fields for CodeScanningParameters
Name | Description |
---|---|
| Tools that must provide code scanning results for this rule to pass. |
CodeScanningTool
A tool that must provide code scanning results for this rule to pass.
Fields for CodeScanningTool
Name | Description |
---|---|
| The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts.". |
| The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts.". |
| The name of a code scanning tool. |
CommentDeletedEvent
Represents acomment_deleted
event on a given issue or pull request.
CommentDeletedEvent
Implements
Fields for CommentDeletedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The user who authored the deleted comment. |
| The Node ID of the CommentDeletedEvent object. |
Commit
Represents a Git commit.
Commit
Implements
Fields for Commit
Name | Description |
---|---|
| 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. Arguments for
|
| 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 Arguments for
|
| We recommend using the Warning
|
| The number of changed files in this commit. If GitHub is unable to calculate
the number of changed files (for example due to a timeout), this will return
|
| The check suites associated with a commit. Arguments for
|
| 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. Arguments for
|
| The tree entry representing the file located at the given path. Arguments for
|
| The linear commit history starting from (and including) this commit, in the same order as Arguments for
|
| 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. Warning
|
| 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. Arguments for
|
| 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. |
CommitAuthorEmailPatternParameters
Parameters to be used for the commit_author_email_pattern rule.
CommitComment
Represents a comment on a given Commit.
CommitComment
Implements
Fields for CommitComment
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Identifies the comment body. |
| The body rendered to HTML. |
| The body rendered to text. |
| Identifies the commit associated with the comment, if the commit exists. |
| 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 CommitComment 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 |
| Identifies the file path associated with the comment. |
| Identifies the line position associated with the comment. |
| 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. Arguments for
|
| The repository associated with this node. |
| The HTTP path permalink for this commit comment. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL permalink for this commit comment. |
| A list of edits to this content. Arguments for
|
| 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. |
CommitCommentConnection
The connection type for CommitComment.
Fields for CommitCommentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CommitCommentEdge
An edge in a connection.
Fields for CommitCommentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CommitCommentThread
A thread of comments on a commit.
CommitCommentThread
Implements
Fields for CommitCommentThread
Name | Description |
---|---|
| The comments that exist in this thread. |
| The commit the comments were made on. |
| The Node ID of the CommitCommentThread object. |
| The file the comments were made on. |
| The position in the diff for the commit that the comment was made on. |
| The repository associated with this node. |
CommitConnection
The connection type for Commit.
Fields for CommitConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CommitContributionsByRepository
This aggregates commits made by a user within one repository.
Fields for CommitContributionsByRepository
Name | Description |
---|---|
| The commit contributions, each representing a day. Arguments for
|
| The repository in which the commits were made. |
| The HTTP path for the user's commits to the repository in this time range. |
| The HTTP URL for the user's commits to the repository in this time range. |
CommitEdge
An edge in a connection.
CommitHistoryConnection
The connection type for Commit.
Fields for CommitHistoryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CommitMessagePatternParameters
Parameters to be used for the commit_message_pattern rule.
CommitterEmailPatternParameters
Parameters to be used for the committer_email_pattern rule.
Comparison
Represents a comparison between two commit revisions.
Comparison
Implements
Fields for Comparison
Name | Description |
---|---|
| The number of commits ahead of the base branch. |
| The base revision of this comparison. |
| The number of commits behind the base branch. |
| The commits which compose this comparison. |
| The head revision of this comparison. |
| The Node ID of the Comparison object. |
| The status of this comparison. |
ComparisonCommitConnection
The connection type for Commit.
Fields for ComparisonCommitConnection
Name | Description |
---|---|
| The total count of authors and co-authors across all commits. |
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ConnectedEvent
Represents aconnected
event on a given issue or pull request.
ConnectedEvent
Implements
Fields for ConnectedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ConnectedEvent object. |
| Reference originated in a different repository. |
| Issue or pull request that made the reference. |
| Issue or pull request which was connected. |
ContributingGuidelines
The Contributing Guidelines for a repository.
ContributionCalendar
A calendar of contributions made on GitHub by a user.
Fields for ContributionCalendar
Name | Description |
---|---|
| A list of hex color codes used in this calendar. The darker the color, the more contributions it represents. |
| Determine if the color set was chosen because it's currently Halloween. |
| A list of the months of contributions in this calendar. |
| The count of total contributions in the calendar. |
| A list of the weeks of contributions in this calendar. |
ContributionCalendarDay
Represents a single day of contributions on GitHub by a user.
Fields for ContributionCalendarDay
Name | Description |
---|---|
| The hex color code that represents how many contributions were made on this day compared to others in the calendar. |
| How many contributions were made by the user on this day. |
| Indication of contributions, relative to other days. Can be used to indicate which color to represent this day on a calendar. |
| The day this square represents. |
| A number representing which day of the week this square represents, e.g., 1 is Monday. |
ContributionCalendarMonth
A month of contributions in a user's contribution graph.
ContributionCalendarWeek
A week of contributions in a user's contribution graph.
Fields for ContributionCalendarWeek
Name | Description |
---|---|
| The days of contributions in this week. |
| The date of the earliest square in this week. |
ContributionsCollection
A contributions collection aggregates contributions such as opened issues and commits created by a user.
Fields for ContributionsCollection
Name | Description |
---|---|
| Commit contributions made by the user, grouped by repository. Arguments for
|
| A calendar of this user's contributions on GitHub. |
| The years the user has been making contributions with the most recent year first. |
| Determine if this collection's time span ends in the current month. |
| The date of the first restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts. |
| The ending date and time of this collection. |
| The first issue the user opened on GitHub. This will be null if that issue was opened outside the collection's time range and ignoreTimeRange is false. If the issue is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned. |
| The first pull request the user opened on GitHub. This will be null if that pull request was opened outside the collection's time range and ignoreTimeRange is not true. If the pull request is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned. |
| The first repository the user created on GitHub. This will be null if that first repository was created outside the collection's time range and ignoreTimeRange is false. If the repository is not visible, then a RestrictedContribution is returned. |
| Does the user have any more activity in the timeline that occurred prior to the collection's time range?. |
| Determine if there are any contributions in this collection. |
| Determine if the user made any contributions in this time frame whose details are not visible because they were made in a private repository. Can only be true if the user enabled private contribution counts. |
| Whether or not the collector's time span is all within the same day. |
| A list of issues the user opened. Arguments for
|
| Issue contributions made by the user, grouped by repository. Arguments for
|
| When the user signed up for GitHub. This will be null if that sign up date falls outside the collection's time range and ignoreTimeRange is false. |
| The date of the most recent restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts. |
| When this collection's time range does not include any activity from the user, use this to get a different collection from an earlier time range that does have activity. |
| Returns a different contributions collection from an earlier time range than this one that does not have any contributions. |
| The issue the user opened on GitHub that received the most comments in the specified time frame. |
| The pull request the user opened on GitHub that received the most comments in the specified time frame. |
| Pull request contributions made by the user. Arguments for
|
| Pull request contributions made by the user, grouped by repository. Arguments for
|
| Pull request review contributions made by the user. Returns the most recently submitted review for each PR reviewed by the user. Arguments for
|
| Pull request review contributions made by the user, grouped by repository. Arguments for
|
| A list of repositories owned by the user that the user created in this time range. Arguments for
|
| A count of contributions made by the user that the viewer cannot access. Only non-zero when the user has chosen to share their private contribution counts. |
| The beginning date and time of this collection. |
| How many commits were made by the user in this time span. |
| How many issues the user opened. |
| How many pull requests the user opened. |
| How many pull request reviews the user left. |
| How many different repositories the user committed to. |
| How many different repositories the user opened issues in. |
| How many different repositories the user left pull request reviews in. |
| How many different repositories the user opened pull requests in. Arguments for
|
| How many repositories the user created. Arguments for
|
| The user who made the contributions in this collection. |
ConvertToDraftEvent
Represents aconvert_to_draft
event on a given pull request.
ConvertToDraftEvent
Implements
Fields for ConvertToDraftEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ConvertToDraftEvent object. |
| PullRequest referenced by event. |
| The HTTP path for this convert to draft event. |
| The HTTP URL for this convert to draft event. |
ConvertedNoteToIssueEvent
Represents aconverted_note_to_issue
event on a given issue or pull request.
ConvertedNoteToIssueEvent
Implements
Fields for ConvertedNoteToIssueEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The Node ID of the ConvertedNoteToIssueEvent object. |
| Project referenced by event. |
| Project card referenced by this project event. |
| Column name referenced by this project event. |
ConvertedToDiscussionEvent
Represents aconverted_to_discussion
event on a given issue.
ConvertedToDiscussionEvent
Implements
Fields for ConvertedToDiscussionEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The discussion that the issue was converted into. |
| The Node ID of the ConvertedToDiscussionEvent object. |
CopilotEndpoints
Copilot endpoint information.
CreatedCommitContribution
Represents the contribution a user made by committing to a repository.
CreatedCommitContribution
Implements
Fields for CreatedCommitContribution
Name | Description |
---|---|
| How many commits were made on this day to this repository by the user. |
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The repository the user made a commit in. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedCommitContributionConnection
The connection type for CreatedCommitContribution.
Fields for CreatedCommitContributionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of commits across days and repositories in the connection. |
CreatedCommitContributionEdge
An edge in a connection.
Fields for CreatedCommitContributionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CreatedIssueContribution
Represents the contribution a user made on GitHub by opening an issue.
CreatedIssueContribution
Implements
Fields for CreatedIssueContribution
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| The issue that was opened. |
| When this contribution was made. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedIssueContributionConnection
The connection type for CreatedIssueContribution.
Fields for CreatedIssueContributionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CreatedIssueContributionEdge
An edge in a connection.
Fields for CreatedIssueContributionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CreatedPullRequestContribution
Represents the contribution a user made on GitHub by opening a pull request.
CreatedPullRequestContribution
Implements
Fields for CreatedPullRequestContribution
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The pull request that was opened. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedPullRequestContributionConnection
The connection type for CreatedPullRequestContribution.
Fields for CreatedPullRequestContributionConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CreatedPullRequestContributionEdge
An edge in a connection.
Fields for CreatedPullRequestContributionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
CreatedPullRequestReviewContribution
Represents the contribution a user made by leaving a review on a pull request.
CreatedPullRequestReviewContribution
Implements
Fields for CreatedPullRequestReviewContribution
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The pull request the user reviewed. |
| The review the user left on the pull request. |
| The repository containing the pull request that the user reviewed. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedPullRequestReviewContributionConnection
The connection type for CreatedPullRequestReviewContribution.
CreatedPullRequestReviewContributionEdge
An edge in a connection.
Fields for CreatedPullRequestReviewContributionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
CreatedRepositoryContribution
Represents the contribution a user made on GitHub by creating a repository.
CreatedRepositoryContribution
Implements
Fields for CreatedRepositoryContribution
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The repository that was created. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedRepositoryContributionConnection
The connection type for CreatedRepositoryContribution.
Fields for CreatedRepositoryContributionConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CreatedRepositoryContributionEdge
An edge in a connection.
Fields for CreatedRepositoryContributionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
CrossReferencedEvent
Represents a mention made by one issue or pull request to another.
CrossReferencedEvent
Implements
Fields for CrossReferencedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the CrossReferencedEvent object. |
| Reference originated in a different repository. |
| Identifies when the reference was made. |
| The HTTP path for this pull request. |
| Issue or pull request that made the reference. |
| Issue or pull request to which the reference was made. |
| The HTTP URL for this pull request. |
| Checks if the target will be closed when the source is merged. |
DemilestonedEvent
Represents ademilestoned
event on a given issue or pull request.
DemilestonedEvent
Implements
Fields for DemilestonedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the DemilestonedEvent object. |
| Identifies the milestone title associated with the |
| Object referenced by event. |
DependabotUpdate
A Dependabot Update for a dependency in a repository.
DependabotUpdate
Implements
Fields for DependabotUpdate
Name | Description |
---|---|
| The error from a dependency update. |
| The associated pull request. |
| The repository associated with this node. |
DependabotUpdateError
An error produced from a Dependabot Update.
DependencyGraphDependency
A dependency manifest entry.
Fields for DependencyGraphDependency
Name | Description |
---|---|
| Does the dependency itself have dependencies?. |
| The original name of the package, as it appears in the manifest. Warning
|
| The dependency package manager. |
| The name of the package in the canonical form used by the package manager. |
| The repository containing the package. |
| The dependency version requirements. |
DependencyGraphDependencyConnection
The connection type for DependencyGraphDependency.
Fields for DependencyGraphDependencyConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DependencyGraphDependencyEdge
An edge in a connection.
Fields for DependencyGraphDependencyEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DependencyGraphManifest
Dependency manifest for a repository.
DependencyGraphManifest
Implements
Fields for DependencyGraphManifest
Name | Description |
---|---|
| Path to view the manifest file blob. |
| A list of manifest dependencies. Arguments for
|
| The number of dependencies listed in the manifest. |
| Is the manifest too big to parse?. |
| Fully qualified manifest filename. |
| The Node ID of the DependencyGraphManifest object. |
| Were we able to parse the manifest?. |
| The repository containing the manifest. |
DependencyGraphManifestConnection
The connection type for DependencyGraphManifest.
Fields for DependencyGraphManifestConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DependencyGraphManifestEdge
An edge in a connection.
Fields for DependencyGraphManifestEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeployKey
A repository deploy key.
DeployKey
Implements
Fields for DeployKey
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The Node ID of the DeployKey object. |
| The deploy key. |
| Whether or not the deploy key is read only. |
| The deploy key title. |
| Whether or not the deploy key has been verified. |
DeployKeyConnection
The connection type for DeployKey.
Fields for DeployKeyConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeployKeyEdge
An edge in a connection.
DeployedEvent
Represents adeployed
event on a given pull request.
DeployedEvent
Implements
Fields for DeployedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The deployment associated with the |
| The Node ID of the DeployedEvent object. |
| PullRequest referenced by event. |
| The ref associated with the |
Deployment
Represents triggered deployment instance.
Deployment
Implements
Fields for Deployment
Name | Description |
---|---|
| Identifies the commit sha of the deployment. |
| Identifies the oid of the deployment commit, even if the commit has been deleted. |
| Identifies the date and time when the object was created. |
| Identifies the actor who triggered the deployment. |
| Identifies the primary key from the database. |
| The deployment description. |
| The latest environment to which this deployment was made. |
| The Node ID of the Deployment object. |
| The latest environment to which this deployment was made. |
| The latest status of this deployment. |
| The original environment to which this deployment was made. |
| Extra information that a deployment system might need. |
| Identifies the Ref of the deployment, if the deployment was created by ref. |
| Identifies the repository associated with the deployment. |
| The current state of the deployment. |
| A list of statuses associated with the deployment. |
| The deployment task. |
| Identifies the date and time when the object was last updated. |
DeploymentConnection
The connection type for Deployment.
Fields for DeploymentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentEdge
An edge in a connection.
Fields for DeploymentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentEnvironmentChangedEvent
Represents adeployment_environment_changed
event on a given pull request.
DeploymentEnvironmentChangedEvent
Implements
Fields for DeploymentEnvironmentChangedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The deployment status that updated the deployment environment. |
| The Node ID of the DeploymentEnvironmentChangedEvent object. |
| PullRequest referenced by event. |
DeploymentProtectionRule
A protection rule.
Fields for DeploymentProtectionRule
Name | Description |
---|---|
| Identifies the primary key from the database. |
| Whether deployments to this environment can be approved by the user who created the deployment. |
| The teams or users that can review the deployment. |
| The timeout in minutes for this protection rule. |
The type of protection rule. |
DeploymentProtectionRuleConnection
The connection type for DeploymentProtectionRule.
Fields for DeploymentProtectionRuleConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentProtectionRuleEdge
An edge in a connection.
Fields for DeploymentProtectionRuleEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentRequest
A request to deploy a workflow run to an environment.
Fields for DeploymentRequest
Name | Description |
---|---|
| Whether or not the current user can approve the deployment. |
| The target environment of the deployment. |
| The teams or users that can review the deployment. |
| The wait timer in minutes configured in the environment. |
| The wait timer in minutes configured in the environment. |
DeploymentRequestConnection
The connection type for DeploymentRequest.
Fields for DeploymentRequestConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentRequestEdge
An edge in a connection.
Fields for DeploymentRequestEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentReview
A deployment review.
DeploymentReview
Implements
Fields for DeploymentReview
Name | Description |
---|---|
| The comment the user left. |
| Identifies the primary key from the database. |
| The environments approved or rejected. Arguments for
|
| The Node ID of the DeploymentReview object. |
| The decision of the user. |
| The user that reviewed the deployment. |
DeploymentReviewConnection
The connection type for DeploymentReview.
Fields for DeploymentReviewConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentReviewEdge
An edge in a connection.
Fields for DeploymentReviewEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentReviewerConnection
The connection type for DeploymentReviewer.
Fields for DeploymentReviewerConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentReviewerEdge
An edge in a connection.
Fields for DeploymentReviewerEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentStatus
Describes the status of a given deployment attempt.
DeploymentStatus
Implements
Fields for DeploymentStatus
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the actor who triggered the deployment. |
| Identifies the deployment associated with status. |
| Identifies the description of the deployment. |
| Identifies the environment of the deployment at the time of this deployment status. |
| Identifies the environment URL of the deployment. |
| The Node ID of the DeploymentStatus object. |
| Identifies the log URL of the deployment. |
| Identifies the current state of the deployment. |
| Identifies the date and time when the object was last updated. |
DeploymentStatusConnection
The connection type for DeploymentStatus.
Fields for DeploymentStatusConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentStatusEdge
An edge in a connection.
Fields for DeploymentStatusEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DisconnectedEvent
Represents adisconnected
event on a given issue or pull request.
DisconnectedEvent
Implements
Fields for DisconnectedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the DisconnectedEvent object. |
| Reference originated in a different repository. |
| Issue or pull request from which the issue was disconnected. |
| Issue or pull request which was disconnected. |
Discussion
A discussion in a repository.
Discussion
Implements
Fields for Discussion
Name | Description |
---|---|
| 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. Arguments for
|
| The moment the editor made the last edit. |
|
|
| 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. Arguments for
|
| 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. Arguments for
|
| Indicates if the object can be closed by the viewer. |
| Check if the current viewer can delete this object. |
| Indicates if the viewer can edit labels for 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. |
DiscussionCategory
A category for discussions in a repository.
DiscussionCategory
Implements
Fields for DiscussionCategory
Name | Description |
---|---|
| 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. |
DiscussionCategoryConnection
The connection type for DiscussionCategory.
Fields for DiscussionCategoryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionCategoryEdge
An edge in a connection.
Fields for DiscussionCategoryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DiscussionComment
A comment on a discussion.
DiscussionComment
Implements
Fields for DiscussionComment
Name | Description |
---|---|
| 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. |
| Identifies the primary key from the database. |
| The time when this replied-to comment was deleted. |
| The discussion this comment was created in. |
| The actor who edited the comment. |
| The Node ID of the DiscussionComment object. |
| Check if this comment was edited and includes an edit with the creation data. |
| Has this comment been chosen as the answer of its discussion?. |
| 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 |
| 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. Arguments for
|
| The threaded replies to this comment. |
| The discussion comment this comment is a reply to. |
| The path for this discussion comment. |
| Identifies the date and time when the object was last updated. |
| Number of upvotes that this subject has received. |
| The URL for this discussion comment. |
| A list of edits to this content. Arguments for
|
| Check if the current viewer can delete this object. |
| Can the current user mark this comment as an answer?. |
| Check if the current viewer can minimize this object. |
| Can user react to this subject. |
| Can the current user unmark this comment as an answer?. |
| Check if the current viewer can update this object. |
| Whether or not the current user can add or remove an upvote on this subject. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
| Whether or not the current user has already upvoted this subject. |
DiscussionCommentConnection
The connection type for DiscussionComment.
Fields for DiscussionCommentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionCommentEdge
An edge in a connection.
Fields for DiscussionCommentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DiscussionConnection
The connection type for Discussion.
Fields for DiscussionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionEdge
An edge in a connection.
Fields for DiscussionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DiscussionPoll
A poll for a discussion.
DiscussionPoll
Implements
Fields for DiscussionPoll
Name | Description |
---|---|
| The discussion that this poll belongs to. |
| The Node ID of the DiscussionPoll object. |
| The options for this poll. Arguments for
|
| The question that is being asked by this poll. |
| The total number of votes that have been cast for this poll. |
| Indicates if the viewer has permission to vote in this poll. |
| Indicates if the viewer has voted for any option in this poll. |
DiscussionPollOption
An option for a discussion poll.
DiscussionPollOption
Implements
Fields for DiscussionPollOption
Name | Description |
---|---|
| The Node ID of the DiscussionPollOption object. |
| The text for this option. |
| The discussion poll that this option belongs to. |
| The total number of votes that have been cast for this option. |
| Indicates if the viewer has voted for this option in the poll. |
DiscussionPollOptionConnection
The connection type for DiscussionPollOption.
Fields for DiscussionPollOptionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionPollOptionEdge
An edge in a connection.
Fields for DiscussionPollOptionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DraftIssue
A draft issue within a project.
DraftIssue
Implements
Fields for DraftIssue
Name | Description |
---|---|
| A list of users to assigned to this draft issue. |
| The body of the draft issue. |
| The body of the draft issue rendered to HTML. |
| The body of the draft issue rendered to text. |
| Identifies the date and time when the object was created. |
| The actor who created this draft issue. |
| The Node ID of the DraftIssue object. |
| List of items linked with the draft issue (currently draft issue can be linked to only one item). Arguments for
|
| Projects that link to this draft issue (currently draft issue can be linked to only one project). Arguments for
|
| The title of the draft issue. |
| Identifies the date and time when the object was last updated. |
Enterprise
An account to manage multiple organizations with consolidated policy and billing.
Enterprise
Implements
Fields for Enterprise
Name | Description |
---|---|
| The text of the announcement. |
| The date the announcement was created. |
| The expiration date of the announcement, if any. |
| Whether the announcement can be dismissed by the user. |
| A URL pointing to the enterprise's public avatar. Arguments for
|
| The enterprise's billing email. |
| Enterprise billing information visible to enterprise billing managers. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the enterprise. |
| The description of the enterprise as HTML. |
| The Node ID of the Enterprise object. |
| The location of the enterprise. |
| A list of users who are members of this enterprise. Arguments for
|
| The name of the enterprise. |
| A list of organizations that belong to this enterprise. Arguments for
|
| Enterprise information visible to enterprise owners or enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope. |
| The raw content of the enterprise README. |
| The content of the enterprise README as HTML. |
| The HTTP path for this enterprise. |
| The URL-friendly identifier for the enterprise. |
| The HTTP URL for this enterprise. |
| Is the current viewer an admin of this enterprise?. |
| The URL of the enterprise website. |
EnterpriseAdministratorConnection
The connection type for User.
Fields for EnterpriseAdministratorConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseAdministratorEdge
A User who is an administrator of an enterprise.
Fields for EnterpriseAdministratorEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
| The role of the administrator. |
EnterpriseAdministratorInvitation
An invitation for a user to become an owner or billing manager of an enterprise.
EnterpriseAdministratorInvitation
Implements
Fields for EnterpriseAdministratorInvitation
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The email of the person who was invited to the enterprise. |
| The enterprise the invitation is for. |
| The Node ID of the EnterpriseAdministratorInvitation object. |
| The user who was invited to the enterprise. |
| The user who created the invitation. |
| The invitee's pending role in the enterprise (owner or billing_manager). |
EnterpriseAdministratorInvitationConnection
The connection type for EnterpriseAdministratorInvitation.
EnterpriseAdministratorInvitationEdge
An edge in a connection.
Fields for EnterpriseAdministratorInvitationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
EnterpriseBillingInfo
Enterprise billing information visible to enterprise billing managers and owners.
Fields for EnterpriseBillingInfo
Name | Description |
---|---|
| The number of licenseable users/emails across the enterprise. |
| The number of data packs used by all organizations owned by the enterprise. |
| The bandwidth quota in GB for all organizations owned by the enterprise. |
| The bandwidth usage in GB for all organizations owned by the enterprise. |
| The bandwidth usage as a percentage of the bandwidth quota. |
| The storage quota in GB for all organizations owned by the enterprise. |
| The storage usage in GB for all organizations owned by the enterprise. |
| The storage usage as a percentage of the storage quota. |
| The number of available licenses across all owned organizations based on the unique number of billable users. |
| The total number of licenses allocated. |
EnterpriseConnection
The connection type for Enterprise.
Fields for EnterpriseConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseEdge
An edge in a connection.
Fields for EnterpriseEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseFailedInvitationConnection
The connection type for OrganizationInvitation.
Fields for EnterpriseFailedInvitationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the total count of unique users in the connection. |
EnterpriseFailedInvitationEdge
A failed invitation to be a member in an enterprise organization.
Fields for EnterpriseFailedInvitationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseIdentityProvider
An identity provider configured to provision identities for an enterprise. Visible to enterprise owners or enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.
EnterpriseIdentityProvider
Implements
Fields for EnterpriseIdentityProvider
Name | Description |
---|---|
| The digest algorithm used to sign SAML requests for the identity provider. |
| The enterprise this identity provider belongs to. |
| ExternalIdentities provisioned by this identity provider. Arguments for
|
| The Node ID of the EnterpriseIdentityProvider object. |
| The x509 certificate used by the identity provider to sign assertions and responses. |
| The Issuer Entity ID for the SAML identity provider. |
| Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable. |
| The signature algorithm used to sign SAML requests for the identity provider. |
| The URL endpoint for the identity provider's SAML SSO. |
EnterpriseMemberConnection
The connection type for EnterpriseMember.
Fields for EnterpriseMemberConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseMemberEdge
A User who is a member of an enterprise through one or more organizations.
Fields for EnterpriseMemberEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseMemberInvitation
An invitation for a user to become an unaffiliated member of an enterprise.
EnterpriseMemberInvitation
Implements
Fields for EnterpriseMemberInvitation
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The email of the person who was invited to the enterprise. |
| The enterprise the invitation is for. |
| The Node ID of the EnterpriseMemberInvitation object. |
| The user who was invited to the enterprise. |
| The user who created the invitation. |
EnterpriseMemberInvitationConnection
The connection type for EnterpriseMemberInvitation.
Fields for EnterpriseMemberInvitationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseMemberInvitationEdge
An edge in a connection.
Fields for EnterpriseMemberInvitationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseOrganizationMembershipConnection
The connection type for Organization.
Fields for EnterpriseOrganizationMembershipConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseOrganizationMembershipEdge
An enterprise organization that a user is a member of.
Fields for EnterpriseOrganizationMembershipEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
The role of the user in the enterprise membership. |
EnterpriseOutsideCollaboratorConnection
The connection type for User.
EnterpriseOutsideCollaboratorEdge
A User who is an outside collaborator of an enterprise through one or more organizations.
Fields for EnterpriseOutsideCollaboratorEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
| The enterprise organization repositories this user is a member of. Arguments for
|
EnterpriseOwnerInfo
Enterprise information visible to enterprise owners or enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.
Fields for EnterpriseOwnerInfo
Name | Description |
---|---|
| A list of all of the administrators for this enterprise. Arguments for
|
| A list of users in the enterprise who currently have two-factor authentication disabled. Arguments for
|
| Whether or not affiliated users with two-factor authentication disabled exist in the enterprise. |
| The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise. |
| A list of enterprise organizations configured with the provided private repository forking setting value. Arguments for
|
| The value for the allow private repository forking policy on the enterprise. |
| The setting value for base repository permissions for organizations in this enterprise. |
| A list of enterprise organizations configured with the provided base repository permission. Arguments for
|
| A list of domains owned by the enterprise. Visible to enterprise owners or enterprise owners' personal access tokens (classic) with admin:enterprise scope. Arguments for
|
| Enterprise Server installations owned by the enterprise. Arguments for
|
| A list of failed invitations in the enterprise. Arguments for
|
| The setting value for whether the enterprise has an IP allow list enabled. |
| The IP addresses that are allowed to access resources owned by the enterprise. Visible to enterprise owners or enterprise owners' personal access tokens (classic) with admin:enterprise scope. Arguments for
|
| The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled. |
| Whether or not the base repository permission is currently being updated. |
| Whether the two-factor authentication requirement is currently being enforced. |
| The setting value for whether organization members with admin permissions on a repository can change repository visibility. |
| A list of enterprise organizations configured with the provided can change repository visibility setting value. Arguments for
|
| The setting value for whether members of organizations in the enterprise can create internal repositories. |
| The setting value for whether members of organizations in the enterprise can create private repositories. |
| The setting value for whether members of organizations in the enterprise can create public repositories. |
| The setting value for whether members of organizations in the enterprise can create repositories. |
| A list of enterprise organizations configured with the provided repository creation setting value. Arguments for
|
| The setting value for whether members with admin permissions for repositories can delete issues. |
| A list of enterprise organizations configured with the provided members can delete issues setting value. Arguments for
|
| The setting value for whether members with admin permissions for repositories can delete or transfer repositories. |
| A list of enterprise organizations configured with the provided members can delete repositories setting value. Arguments for
|
| The setting value for whether members of organizations in the enterprise can invite outside collaborators. |
| A list of enterprise organizations configured with the provided members can invite collaborators setting value. Arguments for
|
| Indicates whether members of this enterprise's organizations can purchase additional services for those organizations. |
| The setting value for whether members with admin permissions for repositories can update protected branches. |
| A list of enterprise organizations configured with the provided members can update protected branches setting value. Arguments for
|
| The setting value for whether members can view dependency insights. |
| A list of enterprise organizations configured with the provided members can view dependency insights setting value. Arguments for
|
| Indicates if email notification delivery for this enterprise is restricted to verified or approved domains. |
| The OIDC Identity Provider for the enterprise. |
| The setting value for whether organization projects are enabled for organizations in this enterprise. |
| A list of enterprise organizations configured with the provided organization projects setting value. Arguments for
|
| A list of outside collaborators across the repositories in the enterprise. Arguments for
|
| A list of pending administrator invitations for the enterprise. Arguments for
|
| A list of pending collaborator invitations across the repositories in the enterprise. Arguments for
|
| A list of pending member invitations for organizations in the enterprise. Arguments for
|
| A list of pending unaffiliated member invitations for the enterprise. Arguments for
|
| The setting value for whether repository projects are enabled in this enterprise. |
| A list of enterprise organizations configured with the provided repository projects setting value. Arguments for
|
| The SAML Identity Provider for the enterprise. |
| A list of enterprise organizations configured with the SAML single sign-on setting value. Arguments for
|
| A list of members with a support entitlement. Arguments for
|
| The setting value for whether team discussions are enabled for organizations in this enterprise. |
| A list of enterprise organizations configured with the provided team discussions setting value. Arguments for
|
| The setting value for what methods of two-factor authentication the enterprise prevents its users from having. |
| The setting value for whether the enterprise requires two-factor authentication for its organizations and users. |
| A list of enterprise organizations configured with the two-factor authentication setting value. Arguments for
|
EnterprisePendingMemberInvitationConnection
The connection type for OrganizationInvitation.
Fields for EnterprisePendingMemberInvitationConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the total count of unique users in the connection. |
EnterprisePendingMemberInvitationEdge
An invitation to be a member in an enterprise organization.
Fields for EnterprisePendingMemberInvitationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseRepositoryInfo
A subset of repository information queryable from an enterprise.
EnterpriseRepositoryInfo
Implements
Fields for EnterpriseRepositoryInfo
Name | Description |
---|---|
| The Node ID of the EnterpriseRepositoryInfo object. |
| Identifies if the repository is private or internal. |
| The repository's name. |
| The repository's name with owner. |
EnterpriseRepositoryInfoConnection
The connection type for EnterpriseRepositoryInfo.
Fields for EnterpriseRepositoryInfoConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseRepositoryInfoEdge
An edge in a connection.
Fields for EnterpriseRepositoryInfoEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseServerInstallation
An Enterprise Server installation.
EnterpriseServerInstallation
Implements
Fields for EnterpriseServerInstallation
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The customer name to which the Enterprise Server installation belongs. |
| The host name of the Enterprise Server installation. |
| The Node ID of the EnterpriseServerInstallation object. |
| Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect. |
| Identifies the date and time when the object was last updated. |
| User accounts on this Enterprise Server installation. Arguments for
|
| User accounts uploads for the Enterprise Server installation. Arguments for
|
EnterpriseServerInstallationConnection
The connection type for EnterpriseServerInstallation.
Fields for EnterpriseServerInstallationConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseServerInstallationEdge
An edge in a connection.
Fields for EnterpriseServerInstallationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseServerInstallationMembershipConnection
The connection type for EnterpriseServerInstallation.
Fields for EnterpriseServerInstallationMembershipConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseServerInstallationMembershipEdge
An Enterprise Server installation that a user is a member of.
Fields for EnterpriseServerInstallationMembershipEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
The role of the user in the enterprise membership. |
EnterpriseServerUserAccount
A user account on an Enterprise Server installation.
EnterpriseServerUserAccount
Implements
Fields for EnterpriseServerUserAccount
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
User emails belonging to this user account. Arguments for
| |
| The Enterprise Server installation on which this user account exists. |
| The Node ID of the EnterpriseServerUserAccount object. |
| Whether the user account is a site administrator on the Enterprise Server installation. |
| The login of the user account on the Enterprise Server installation. |
| The profile name of the user account on the Enterprise Server installation. |
| The date and time when the user account was created on the Enterprise Server installation. |
| The ID of the user account on the Enterprise Server installation. |
| Identifies the date and time when the object was last updated. |
EnterpriseServerUserAccountConnection
The connection type for EnterpriseServerUserAccount.
Fields for EnterpriseServerUserAccountConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseServerUserAccountEdge
An edge in a connection.
Fields for EnterpriseServerUserAccountEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseServerUserAccountEmail
An email belonging to a user account on an Enterprise Server installation.
EnterpriseServerUserAccountEmail
Implements
Fields for EnterpriseServerUserAccountEmail
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The email address. |
| The Node ID of the EnterpriseServerUserAccountEmail object. |
| Indicates whether this is the primary email of the associated user account. |
| Identifies the date and time when the object was last updated. |
| The user account to which the email belongs. |
EnterpriseServerUserAccountEmailConnection
The connection type for EnterpriseServerUserAccountEmail.
EnterpriseServerUserAccountEmailEdge
An edge in a connection.
Fields for EnterpriseServerUserAccountEmailEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
EnterpriseServerUserAccountsUpload
A user accounts upload from an Enterprise Server installation.
EnterpriseServerUserAccountsUpload
Implements
Fields for EnterpriseServerUserAccountsUpload
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The enterprise to which this upload belongs. |
| The Enterprise Server installation for which this upload was generated. |
| The Node ID of the EnterpriseServerUserAccountsUpload object. |
| The name of the file uploaded. |
| The synchronization state of the upload. |
| Identifies the date and time when the object was last updated. |
EnterpriseServerUserAccountsUploadConnection
The connection type for EnterpriseServerUserAccountsUpload.
EnterpriseServerUserAccountsUploadEdge
An edge in a connection.
Fields for EnterpriseServerUserAccountsUploadEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
EnterpriseUserAccount
An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.
EnterpriseUserAccount
Implements
Fields for EnterpriseUserAccount
Name | Description |
---|---|
| A URL pointing to the enterprise user account's public avatar. Arguments for
|
| Identifies the date and time when the object was created. |
| The enterprise in which this user account exists. |
| A list of Enterprise Server installations this user is a member of. Arguments for
|
| The Node ID of the EnterpriseUserAccount object. |
| An identifier for the enterprise user account, a login or email address. |
| The name of the enterprise user account. |
| A list of enterprise organizations this user is a member of. Arguments for
|
| The HTTP path for this user. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this user. |
| The user within the enterprise. |
Environment
An environment.
Environment
Implements
Fields for Environment
Name | Description |
---|---|
| Identifies the primary key from the database. |
| The Node ID of the Environment object. |
| Indicates whether or not this environment is currently pinned to the repository. |
| The latest completed deployment with status success, failure, or error if it exists. |
| The name of the environment. |
| The position of the environment if it is pinned, null if it is not pinned. |
| The protection rules defined for this environment. Arguments for
|
EnvironmentConnection
The connection type for Environment.
Fields for EnvironmentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnvironmentEdge
An edge in a connection.
Fields for EnvironmentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ExternalIdentity
An external identity provisioned by SAML SSO or SCIM. If SAML is configured on the organization, the external identity is visible to (1) organization owners, (2) organization owners' personal access tokens (classic) with read:org or admin:org scope, (3) GitHub App with an installation token with read or write access to members. If SAML is configured on the enterprise, the external identity is visible to (1) enterprise owners, (2) enterprise owners' personal access tokens (classic) with read:enterprise or admin:enterprise scope.
ExternalIdentity
Implements
Fields for ExternalIdentity
Name | Description |
---|---|
| The GUID for this identity. |
| The Node ID of the ExternalIdentity object. |
| Organization invitation for this SCIM-provisioned external identity. |
| SAML Identity attributes. |
| SCIM Identity attributes. |
| User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member. |
ExternalIdentityAttribute
An attribute for the External Identity attributes collection.
ExternalIdentityConnection
The connection type for ExternalIdentity.
Fields for ExternalIdentityConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ExternalIdentityEdge
An edge in a connection.
Fields for ExternalIdentityEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ExternalIdentitySamlAttributes
SAML attributes for the External Identity.
Fields for ExternalIdentitySamlAttributes
Name | Description |
---|---|
| SAML Identity attributes. |
| The emails associated with the SAML identity. |
| Family name of the SAML identity. |
| Given name of the SAML identity. |
| The groups linked to this identity in IDP. |
| The NameID of the SAML identity. |
| The userName of the SAML identity. |
ExternalIdentityScimAttributes
SCIM attributes for the External Identity.
Fields for ExternalIdentityScimAttributes
Name | Description |
---|---|
| The emails associated with the SCIM identity. |
| Family name of the SCIM identity. |
| Given name of the SCIM identity. |
| The groups linked to this identity in IDP. |
| The userName of the SCIM identity. |
FileExtensionRestrictionParameters
Prevent commits that include files with specified file extensions from being pushed to the commit graph.
Fields for FileExtensionRestrictionParameters
Name | Description |
---|---|
| The file extensions that are restricted from being pushed to the commit graph. |
FilePathRestrictionParameters
Prevent commits that include changes in specified file paths from being pushed to the commit graph.
Fields for FilePathRestrictionParameters
Name | Description |
---|---|
| The file paths that are restricted from being pushed to the commit graph. |
FollowerConnection
The connection type for User.
Fields for FollowerConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
FollowingConnection
The connection type for User.
Fields for FollowingConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
FundingLink
A funding platform link for a repository.
Fields for FundingLink
Name | Description |
---|---|
| The funding platform this link is for. |
| The configured URL for this funding link. |
GenericHovercardContext
A generic hovercard context with a message and icon.
Gist
A Gist.
Gist
Implements
Fields for Gist
Name | Description |
---|---|
| A list of comments associated with the gist. |
| Identifies the date and time when the object was created. |
| The gist description. |
| The files in this gist. Arguments for
|
| A list of forks associated with the gist. Arguments for
|
| The Node ID of the Gist object. |
| Identifies if the gist is a fork. |
| Whether the gist is public or not. |
| The gist name. |
| The gist owner. |
| Identifies when the gist was last pushed to. |
| The HTML path to this resource. |
| Returns a count of how many stargazers there are on this object. |
| A list of users who have starred this starrable. Arguments for
|
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this Gist. |
| Returns a boolean indicating whether the viewing user has starred this starrable. |
GistComment
Represents a comment on an Gist.
GistComment
Implements
Fields for GistComment
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the gist. |
| Identifies the comment body. |
| 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. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| The associated gist. |
| The Node ID of the GistComment 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 |
| 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. Arguments for
|
| Check if the current viewer can delete this object. |
| Check if the current viewer can minimize this object. |
| 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. |
GistCommentConnection
The connection type for GistComment.
Fields for GistCommentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GistCommentEdge
An edge in a connection.
Fields for GistCommentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
GistConnection
The connection type for Gist.
Fields for GistConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GistEdge
An edge in a connection.
GistFile
A file in a gist.
Fields for GistFile
Name | Description |
---|---|
| The file name encoded to remove characters that are invalid in URL paths. |
| The gist file encoding. |
| The file extension from the file name. |
| Indicates if this file is an image. |
| Whether the file's contents were truncated. |
| The programming language this file is written in. |
| The gist file name. |
| The gist file size in bytes. |
| UTF8 text data or null if the file is binary. Arguments for
|
GitActor
Represents an actor in a Git commit (ie. an author or committer).
Fields for GitActor
Name | Description |
---|---|
| A URL pointing to the author's public avatar. Arguments for
|
| The timestamp of the Git action (authoring or committing). |
| The email in the Git commit. |
| The name in the Git commit. |
| The GitHub user corresponding to the email field. Null if no such user exists. |
GitActorConnection
The connection type for GitActor.
Fields for GitActorConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GitActorEdge
An edge in a connection.
GitHubMetadata
Represents information about the GitHub instance.
Fields for GitHubMetadata
Name | Description |
---|---|
| Returns a String that's a SHA of |
| IP addresses that users connect to for git operations. |
| IP addresses that GitHub Enterprise Importer uses for outbound connections. |
| IP addresses that service hooks are sent from. |
| IP addresses that the importer connects from. |
| Whether or not users are verified. |
| IP addresses for GitHub Pages' A records. |
GpgSignature
Represents a GPG signature on a Commit or Tag.
GpgSignature
Implements
Fields for GpgSignature
Name | Description |
---|---|
| Email used to sign this object. |
| True if the signature is valid and verified by GitHub. |
| Hex-encoded ID of the key that signed this object. |
| Payload for GPG signing object. Raw ODB object without the signature header. |
| ASCII-armored signature header from object. |
| GitHub user corresponding to the email signing this commit. |
| The state of this signature. |
| True if the signature was made with GitHub's signing key. |
HeadRefDeletedEvent
Represents ahead_ref_deleted
event on a given pull request.
HeadRefDeletedEvent
Implements
Fields for HeadRefDeletedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the Ref associated with the |
| Identifies the name of the Ref associated with the |
| The Node ID of the HeadRefDeletedEvent object. |
| PullRequest referenced by event. |
HeadRefForcePushedEvent
Represents ahead_ref_force_pushed
event on a given pull request.
HeadRefForcePushedEvent
Implements
Fields for HeadRefForcePushedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the after commit SHA for the |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| The Node ID of the HeadRefForcePushedEvent object. |
| PullRequest referenced by event. |
| Identifies the fully qualified ref name for the |
HeadRefRestoredEvent
Represents ahead_ref_restored
event on a given pull request.
HeadRefRestoredEvent
Implements
Fields for HeadRefRestoredEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the HeadRefRestoredEvent object. |
| PullRequest referenced by event. |
Hovercard
Detail needed to display a hovercard for a user.
Fields for Hovercard
Name | Description |
---|---|
| Each of the contexts for this hovercard. |
IpAllowListEntry
An IP address or range of addresses that is allowed to access an owner's resources.
IpAllowListEntry
Implements
Fields for IpAllowListEntry
Name | Description |
---|---|
| A single IP address or range of IP addresses in CIDR notation. |
| Identifies the date and time when the object was created. |
| The Node ID of the IpAllowListEntry object. |
| Whether the entry is currently active. |
| The name of the IP allow list entry. |
| The owner of the IP allow list entry. |
| Identifies the date and time when the object was last updated. |
IpAllowListEntryConnection
The connection type for IpAllowListEntry.
Fields for IpAllowListEntryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IpAllowListEntryEdge
An edge in a connection.
Fields for IpAllowListEntryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
Issue
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
Issue
Implements
Assignable
Closable
Comment
Deletable
Labelable
Lockable
Node
ProjectV2Owner
Reactable
RepositoryNode
Subscribable
SubscribableThread
UniformResourceLocatable
Updatable
UpdatableComment
Fields for Issue
Name | Description |
---|---|
| 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. |
| List of open pull requests referenced from this issue. Arguments for
|
| A list of comments associated with the Issue. Arguments for
|
| 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. Arguments for
|
| 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. Arguments for
|
| The moment the editor made the last edit. |
| Branches linked to this issue. Arguments for
|
|
|
| Identifies the milestone associated with the issue. |
| Identifies the issue number. |
| A list of Users that are participating in the Issue conversation. Arguments for
|
| List of project cards associated with this issue. Arguments for
|
| List of project items associated with this issue. Arguments for
|
| Find a project by number. Arguments for
|
| A list of projects under the owner. Arguments for
|
| 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. Arguments for
|
| 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. Warning
Arguments for
|
| A list of events, comments, commits, etc. associated with the issue. Arguments for
|
| Identifies the issue title. |
| Identifies the issue title rendered to HTML. |
| A list of issues that track this issue. Arguments for
|
| A list of issues tracked inside the current issue. Arguments for
|
| The number of tracked issues for this issue. Arguments for
|
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this issue. |
| A list of edits to this content. Arguments for
|
| Indicates if the object can be closed by the viewer. |
| Check if the current viewer can delete this object. |
| Indicates if the viewer can edit labels for 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. |
IssueComment
Represents a comment on an Issue.
IssueComment
Implements
Fields for IssueComment
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| The body as Markdown. |