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.
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. |
| N/A |
| Project referenced by event. Note
|
| Project card referenced by this project event. Note
|
| Column name referenced by this project event. Note
|
App
A GitHub App.
App
Implements
Fields for App
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the app. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| Can admins overwrite 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. |
| N/A |
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. |
| N/A |
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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
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. |
| N/A |
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
|
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| Project referenced by event. Note
|
| Project card referenced by this project event. Note
|
| Column name referenced by this project event. Note
|
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. |
| N/A |
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. |
| N/A |
| 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. |
| N/A |
| 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.
Note
DependencyGraphDependency
is available under the Access to a repository's dependency graph preview. During the preview period, the API may change without notice.
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.
Note
DependencyGraphDependencyConnection
is available under the Access to a repository's dependency graph preview. During the preview period, the API may change without notice.
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.
Note
DependencyGraphDependencyEdge
is available under the Access to a repository's dependency graph preview. During the preview period, the API may change without notice.
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.
Note
DependencyGraphManifest
is available under the Access to a repository's dependency graph preview. During the preview period, the API may change without notice.
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. |
| N/A |
| Were we able to parse the manifest?. |
| The repository containing the manifest. |
DependencyGraphManifestConnection
The connection type for DependencyGraphManifest.
Note
DependencyGraphManifestConnection
is available under the Access to a repository's dependency graph preview. During the preview period, the API may change without notice.
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.
Note
DependencyGraphManifestEdge
is available under the Access to a repository's dependency graph preview. During the preview period, the API may change without notice.
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. |
| N/A |
| 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 |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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
|
| N/A |
| 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. Note
|
| Identifies the environment URL of the deployment. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| Check if this comment was edited and includes an edit with the creation data. |
| 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. |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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 |
---|---|
| N/A |
| 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. |
| N/A |
| 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 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
|
| 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. |
| N/A |
| 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 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. |
| N/A |
| 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
|
| N/A |
| 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. |
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
|
| 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 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
|
| 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
|
| 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 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.
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. |
| N/A |
| 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
|
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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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
|
| N/A |
| 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. |
| N/A |
| The name of the environment. |
| 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. |
| N/A |
| 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. |
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. |
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
|
| N/A |
| 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. |
| N/A |
| 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 |
| Whether or not users are verified. |
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 |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| N/A |
| 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. |
| 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
|
| N/A |
| 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
|
| 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. |
| 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. |
| 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. |
| 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. |
| Identifies the primary key from the database as a BigInt. |
| N/A |
| Check if this comment was edited and includes an edit with the creation data. |
| Returns whether or not a comment has been minimized. |
| Identifies the issue associated with the comment. |
| The moment the editor made the last edit. |
| Returns why the comment was minimized. One of |
| Identifies when the comment was published at. |
| Returns the pull request associated with the comment, if this comment was made on a pull request. |
| 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 comment. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this issue 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. |
IssueCommentConnection
The connection type for IssueComment.
Fields for IssueCommentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IssueCommentEdge
An edge in a connection.
Fields for IssueCommentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
IssueConnection
The connection type for Issue.
Fields for IssueConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IssueContributionsByRepository
This aggregates issues opened by a user within one repository.
Fields for IssueContributionsByRepository
Name | Description |
---|---|
| The issue contributions. Arguments for
|
| The repository in which the issues were opened. |
IssueEdge
An edge in a connection.
IssueTemplate
A repository issue template.
Fields for IssueTemplate
Name | Description |
---|---|
| The template purpose. |
| The suggested assignees. |
| The suggested issue body. |
| The template filename. |
| The suggested issue labels. Arguments for
|
| The template name. |
| The suggested issue title. |
IssueTimelineConnection
The connection type for IssueTimelineItem.
Fields for IssueTimelineConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IssueTimelineItemEdge
An edge in a connection.
Fields for IssueTimelineItemEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
IssueTimelineItemsConnection
The connection type for IssueTimelineItems.
Fields for IssueTimelineItemsConnection
Name | Description |
---|---|
| A list of edges. |
| Identifies the count of items after applying |
| A list of nodes. |
| Identifies the count of items after applying |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the date and time when the timeline was last updated. |
IssueTimelineItemsEdge
An edge in a connection.
Fields for IssueTimelineItemsEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
JoinedGitHubContribution
Represents a user signing up for a GitHub account.
JoinedGitHubContribution
Implements
Fields for JoinedGitHubContribution
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 HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
Label
A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.
Label
Implements
Fields for Label
Name | Description |
---|---|
| Identifies the label color. |
| Identifies the date and time when the label was created. |
| A brief description of this label. |
| N/A |
| Indicates whether or not this is a default label. |
| A list of issues associated with this label. Arguments for
|
| Identifies the label name. |
| A list of pull requests associated with this label. Arguments for
|
| The repository associated with this label. |
| The HTTP path for this label. |
| Identifies the date and time when the label was last updated. |
| The HTTP URL for this label. |
LabelConnection
The connection type for Label.
Fields for LabelConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
LabelEdge
An edge in a connection.
LabeledEvent
Represents alabeled
event on a given issue or pull request.
LabeledEvent
Implements
Fields for LabeledEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| Identifies the label associated with the |
| Identifies the |
Language
Represents a given language found in repositories.
LanguageConnection
A list of languages associated with the parent.
Fields for LanguageConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| The total size in bytes of files written in that language. |
LanguageEdge
Represents the language of a repository.
License
A repository's open source license.
License
Implements
Fields for License
Name | Description |
---|---|
| The full text of the license. |
| The conditions set by the license. |
| A human-readable description of the license. |
| Whether the license should be featured. |
| Whether the license should be displayed in license pickers. |
| N/A |
| Instructions on how to implement the license. |
| The lowercased SPDX ID of the license. |
| The limitations set by the license. |
| The license full name specified by https://spdx.org/licenses. |
| Customary short name if applicable (e.g, GPLv3). |
| The permissions set by the license. |
| Whether the license is a pseudo-license placeholder (e.g., other, no-license). |
| Short identifier specified by https://spdx.org/licenses. |
| URL to the license on https://choosealicense.com. |
LicenseRule
Describes a License's conditions, permissions, and limitations.
LinkedBranch
A branch linked to an issue.
LinkedBranchConnection
The connection type for LinkedBranch.
Fields for LinkedBranchConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
LinkedBranchEdge
An edge in a connection.
Fields for LinkedBranchEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
LockedEvent
Represents alocked
event on a given issue or pull request.
LockedEvent
Implements
Fields for LockedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| Reason that the conversation was locked (optional). |
| Object that was locked. |
Mannequin
A placeholder user for attribution of imported data on GitHub.
Mannequin
Implements
Fields for Mannequin
Name | Description |
---|---|
| A URL pointing to the GitHub App's public avatar. Arguments for
|
| The user that has claimed the data attributed to this mannequin. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The mannequin's email on the source instance. |
| N/A |
| The username of the actor. |
| The HTML path to this resource. |
| Identifies the date and time when the object was last updated. |
| The URL to this resource. |
MannequinConnection
The connection type for Mannequin.
Fields for MannequinConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
MannequinEdge
Represents a mannequin.
MarkedAsDuplicateEvent
Represents amarked_as_duplicate
event on a given issue or pull request.
MarkedAsDuplicateEvent
Implements
Fields for MarkedAsDuplicateEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| The authoritative issue or pull request which has been duplicated by another. |
| Identifies the date and time when the object was created. |
| The issue or pull request which has been marked as a duplicate of another. |
| N/A |
| Canonical and duplicate belong to different repositories. |
MembersCanDeleteReposClearAuditEntry
Audit log entry for a members_can_delete_repos.clear event.
MembersCanDeleteReposClearAuditEntry
Implements
Fields for MembersCanDeleteReposClearAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
MembersCanDeleteReposDisableAuditEntry
Audit log entry for a members_can_delete_repos.disable event.
MembersCanDeleteReposDisableAuditEntry
Implements
Fields for MembersCanDeleteReposDisableAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
MembersCanDeleteReposEnableAuditEntry
Audit log entry for a members_can_delete_repos.enable event.
MembersCanDeleteReposEnableAuditEntry
Implements
Fields for MembersCanDeleteReposEnableAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
MentionedEvent
Represents amentioned
event on a given issue or pull request.
MergedEvent
Represents amerged
event on a given pull request.
MergedEvent
Implements
Fields for MergedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the commit associated with the |
| Identifies the date and time when the object was created. |
| N/A |
| Identifies the Ref associated with the |
| Identifies the name of the Ref associated with the |
| PullRequest referenced by event. |
| The HTTP path for this merged event. |
| The HTTP URL for this merged event. |
MigrationSource
A GitHub Enterprise Importer (GEI) migration source.
MigrationSource
Implements
Fields for MigrationSource
Name | Description |
---|---|
| N/A |
| The migration source name. |
| The migration source type. |
| The migration source URL, for example |
Milestone
Represents a Milestone object on a given repository.
Milestone
Implements
Fields for Milestone
Name | Description |
---|---|
| Indicates if the object is closed (definition of closed may depend on type). |
| Identifies the date and time when the object was closed. |
| Identifies the date and time when the object was created. |
| Identifies the actor who created the milestone. |
| Identifies the description of the milestone. |
| Identifies the due date of the milestone. |
| N/A |
| A list of issues associated with the milestone. Arguments for
|
| Identifies the number of the milestone. |
| Identifies the percentage complete for the milestone. |
| A list of pull requests associated with the milestone. Arguments for
|
| The repository associated with this milestone. |
| The HTTP path for this milestone. |
| Identifies the state of the milestone. |
| Identifies the title of the milestone. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this milestone. |
| Indicates if the object can be closed by the viewer. |
| Indicates if the object can be reopened by the viewer. |
MilestoneConnection
The connection type for Milestone.
Fields for MilestoneConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
MilestoneEdge
An edge in a connection.
MilestonedEvent
Represents amilestoned
event on a given issue or pull request.
MilestonedEvent
Implements
Fields for MilestonedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| Identifies the milestone title associated with the |
| Object referenced by event. |
MovedColumnsInProjectEvent
Represents amoved_columns_in_project
event on a given issue or pull request.
MovedColumnsInProjectEvent
Implements
Fields for MovedColumnsInProjectEvent
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. |
| N/A |
| Column name the issue or pull request was moved from. Note
|
| Project referenced by event. Note
|
| Project card referenced by this project event. Note
|
| Column name the issue or pull request was moved to. Note
|
OauthApplicationCreateAuditEntry
Audit log entry for a oauth_application.create event.
OauthApplicationCreateAuditEntry
Implements
Fields for OauthApplicationCreateAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The application URL of the OAuth application. |
| The callback URL of the OAuth application. |
| The time the action was initiated. |
| N/A |
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The rate limit of the OAuth application. |
The state of the OAuth application. | |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgAddBillingManagerAuditEntry
Audit log entry for a org.add_billing_manager.
OrgAddBillingManagerAuditEntry
Implements
Fields for OrgAddBillingManagerAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The email address used to invite a billing manager for the organization. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgAddMemberAuditEntry
Audit log entry for a org.add_member.
OrgAddMemberAuditEntry
Implements
Fields for OrgAddMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The permission level of the member added to the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgBlockUserAuditEntry
Audit log entry for a org.block_user.
OrgBlockUserAuditEntry
Implements
Fields for OrgBlockUserAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The blocked user. |
| The username of the blocked user. |
| The HTTP path for the blocked user. |
| The HTTP URL for the blocked user. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgConfigDisableCollaboratorsOnlyAuditEntry
Audit log entry for a org.config.disable_collaborators_only event.
OrgConfigDisableCollaboratorsOnlyAuditEntry
Implements
Fields for OrgConfigDisableCollaboratorsOnlyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgConfigEnableCollaboratorsOnlyAuditEntry
Audit log entry for a org.config.enable_collaborators_only event.
OrgConfigEnableCollaboratorsOnlyAuditEntry
Implements
Fields for OrgConfigEnableCollaboratorsOnlyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgCreateAuditEntry
Audit log entry for a org.create event.
OrgCreateAuditEntry
Implements
Fields for OrgCreateAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The billing plan for the Organization. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgDisableOauthAppRestrictionsAuditEntry
Audit log entry for a org.disable_oauth_app_restrictions event.
OrgDisableOauthAppRestrictionsAuditEntry
Implements
Fields for OrgDisableOauthAppRestrictionsAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgDisableSamlAuditEntry
Audit log entry for a org.disable_saml event.
OrgDisableSamlAuditEntry
Implements
Fields for OrgDisableSamlAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The SAML provider's digest algorithm URL. |
| N/A |
| The SAML provider's issuer URL. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The SAML provider's signature algorithm URL. |
| The SAML provider's single sign-on URL. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgDisableTwoFactorRequirementAuditEntry
Audit log entry for a org.disable_two_factor_requirement event.
OrgDisableTwoFactorRequirementAuditEntry
Implements
Fields for OrgDisableTwoFactorRequirementAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgEnableOauthAppRestrictionsAuditEntry
Audit log entry for a org.enable_oauth_app_restrictions event.
OrgEnableOauthAppRestrictionsAuditEntry
Implements
Fields for OrgEnableOauthAppRestrictionsAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgEnableSamlAuditEntry
Audit log entry for a org.enable_saml event.
OrgEnableSamlAuditEntry
Implements
Fields for OrgEnableSamlAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The SAML provider's digest algorithm URL. |
| N/A |
| The SAML provider's issuer URL. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The SAML provider's signature algorithm URL. |
| The SAML provider's single sign-on URL. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgEnableTwoFactorRequirementAuditEntry
Audit log entry for a org.enable_two_factor_requirement event.
OrgEnableTwoFactorRequirementAuditEntry
Implements
Fields for OrgEnableTwoFactorRequirementAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgInviteMemberAuditEntry
Audit log entry for a org.invite_member event.
OrgInviteMemberAuditEntry
Implements
Fields for OrgInviteMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The email address of the organization invitation. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The organization invitation. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgInviteToBusinessAuditEntry
Audit log entry for a org.invite_to_business event.
OrgInviteToBusinessAuditEntry
Implements
Fields for OrgInviteToBusinessAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessApprovedAuditEntry
Audit log entry for a org.oauth_app_access_approved event.
OrgOauthAppAccessApprovedAuditEntry
Implements
Fields for OrgOauthAppAccessApprovedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessBlockedAuditEntry
Audit log entry for a org.oauth_app_access_blocked event.
OrgOauthAppAccessBlockedAuditEntry
Implements
Fields for OrgOauthAppAccessBlockedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessDeniedAuditEntry
Audit log entry for a org.oauth_app_access_denied event.
OrgOauthAppAccessDeniedAuditEntry
Implements
Fields for OrgOauthAppAccessDeniedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessRequestedAuditEntry
Audit log entry for a org.oauth_app_access_requested event.
OrgOauthAppAccessRequestedAuditEntry
Implements
Fields for OrgOauthAppAccessRequestedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessUnblockedAuditEntry
Audit log entry for a org.oauth_app_access_unblocked event.
OrgOauthAppAccessUnblockedAuditEntry
Implements
Fields for OrgOauthAppAccessUnblockedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRemoveBillingManagerAuditEntry
Audit log entry for a org.remove_billing_manager event.
OrgRemoveBillingManagerAuditEntry
Implements
Fields for OrgRemoveBillingManagerAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
The reason for the billing manager being removed. | |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRemoveMemberAuditEntry
Audit log entry for a org.remove_member event.
OrgRemoveMemberAuditEntry
Implements
Fields for OrgRemoveMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The types of membership the member has with the organization. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The reason for the member being removed. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRemoveOutsideCollaboratorAuditEntry
Audit log entry for a org.remove_outside_collaborator event.
OrgRemoveOutsideCollaboratorAuditEntry
Implements
Fields for OrgRemoveOutsideCollaboratorAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The types of membership the outside collaborator has with the organization. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
The reason for the outside collaborator being removed from the Organization. | |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRestoreMemberAuditEntry
Audit log entry for a org.restore_member event.
OrgRestoreMemberAuditEntry
Implements
Fields for OrgRestoreMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The number of custom email routings for the restored member. |
| The number of issue assignments for the restored member. |
| Restored organization membership objects. |
| The number of restored memberships. |
| The number of repositories of the restored member. |
| The number of starred repositories for the restored member. |
| The number of watched repositories for the restored member. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRestoreMemberMembershipOrganizationAuditEntryData
Metadata for an organization membership for org.restore_member actions.
OrgRestoreMemberMembershipOrganizationAuditEntryData
Implements
Fields for OrgRestoreMemberMembershipOrganizationAuditEntryData
Name | Description |
---|---|
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
OrgRestoreMemberMembershipRepositoryAuditEntryData
Metadata for a repository membership for org.restore_member actions.
OrgRestoreMemberMembershipRepositoryAuditEntryData
Implements
Fields for OrgRestoreMemberMembershipRepositoryAuditEntryData
Name | Description |
---|---|
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
OrgRestoreMemberMembershipTeamAuditEntryData
Metadata for a team membership for org.restore_member actions.
OrgRestoreMemberMembershipTeamAuditEntryData
Implements
Fields for OrgRestoreMemberMembershipTeamAuditEntryData
Name | Description |
---|---|
| The team associated with the action. |
| The name of the team. |
| The HTTP path for this team. |
| The HTTP URL for this team. |
OrgUnblockUserAuditEntry
Audit log entry for a org.unblock_user.
OrgUnblockUserAuditEntry
Implements
Fields for OrgUnblockUserAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The user being unblocked by the organization. |
| The username of the blocked user. |
| The HTTP path for the blocked user. |
| The HTTP URL for the blocked user. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgUpdateDefaultRepositoryPermissionAuditEntry
Audit log entry for a org.update_default_repository_permission.
OrgUpdateDefaultRepositoryPermissionAuditEntry
Implements
Fields for OrgUpdateDefaultRepositoryPermissionAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The new base repository permission level for the organization. |
| The former base repository permission level for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgUpdateMemberAuditEntry
Audit log entry for a org.update_member event.
OrgUpdateMemberAuditEntry
Implements
Fields for OrgUpdateMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The new member permission level for the organization. |
| The former member permission level for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgUpdateMemberRepositoryCreationPermissionAuditEntry
Audit log entry for a org.update_member_repository_creation_permission event.
OrgUpdateMemberRepositoryCreationPermissionAuditEntry
Implements
Fields for OrgUpdateMemberRepositoryCreationPermissionAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| Can members create repositories in the organization. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The permission for visibility level of repositories for this organization. |
OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
Audit log entry for a org.update_member_repository_invitation_permission event.
OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
Implements
Fields for OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| Can outside collaborators be invited to repositories in the organization. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
Organization
An account on GitHub, with one or more owners, that has repositories, members and teams.
Organization
Implements
Actor
AnnouncementBanner
MemberStatusable
Node
PackageOwner
ProfileOwner
ProjectOwner
ProjectV2Owner
ProjectV2Recent
RepositoryDiscussionAuthor
RepositoryDiscussionCommentAuthor
RepositoryOwner
UniformResourceLocatable
Fields for Organization
Name | Description |
---|---|
| The text of the announcement. |
| The expiration date of the announcement, if any. |
| Whether the announcement can be dismissed by the user. |
| Determine if this repository owner has any items that can be pinned to their profile. Arguments for
|
| Identifies the date and time when the organization was archived. |
| Audit log entries of the organization. Arguments for
|
| A URL pointing to the organization's public avatar. Arguments for
|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The organization's public profile description. |
| The organization's public profile description rendered to HTML. |
| A list of domains owned by the organization. Arguments for
|
| The organization's public email. |
| A list of owners of the organization's enterprise account. Arguments for
|
| N/A |
| The setting value for whether the organization has an IP allow list enabled. |
| The IP addresses that are allowed to access resources owned by the organization. Arguments for
|
| The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled. |
| Whether the organization has verified its profile email and website. |
| Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity. |
| The organization's public profile location. |
| The organization's login name. |
| A list of all mannequins for this organization. Arguments for
|
| Get the status messages members of this entity have set that are either public or visible only to the organization. Arguments for
|
| Members can fork private repositories in this organization. |
| A list of users who are members of this organization. Arguments for
|
| The organization's public profile name. |
| The HTTP path creating a new team. |
| The HTTP URL creating a new team. |
| Indicates if email notification delivery for this organization is restricted to verified or approved domains. |
| The billing email for the organization. |
| A list of packages under the owner. Arguments for
|
| A list of users who have been invited to join this organization. Arguments for
|
| A list of repositories and gists this profile owner can pin to their profile. Arguments for
|
| A list of repositories and gists this profile owner has pinned to their profile. Arguments for
|
| Returns how many more items this profile owner can pin to their profile. |
| Find project by number. Arguments for
|
| Find a project by number. Arguments for
|
| A list of projects under the owner. Arguments for
|
| The HTTP path listing organization's projects. |
| The HTTP URL listing organization's projects. |
| A list of projects under the owner. Arguments for
|
| Recent projects that this user has modified in the context of the owner. Arguments for
|
| A list of repositories that the user owns. Arguments for
|
| Find Repository. |
| Discussion comments this user has authored. Arguments for
|
| Discussions this user has started. Arguments for
|
| A list of all repository migrations for this organization. Arguments for
|
| When true the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication. |
| The HTTP path for this organization. |
| Returns a single ruleset from the current organization by ID. Arguments for
|
| A list of rulesets for this organization. Arguments for
|
| The Organization's SAML identity provider. 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. |
| Find an organization's team by its slug. Arguments for
|
| A list of teams in this organization. Arguments for
|
| The HTTP path listing organization's teams. |
| The HTTP URL listing organization's teams. |
| The organization's Twitter username. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this organization. |
| Organization is adminable by the viewer. |
| Can the viewer pin repositories and gists to the profile?. |
| Can the current viewer create new projects on this owner. |
| Viewer can create repositories on this organization. |
| Viewer can create teams on this organization. |
| Viewer is an active member of this organization. |
| Whether or not this Organization is followed by the viewer. |
| Whether contributors are required to sign off on web-based commits for repositories in this organization. |
| The organization's public profile URL. |
OrganizationAuditEntryConnection
The connection type for OrganizationAuditEntry.
Fields for OrganizationAuditEntryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
OrganizationAuditEntryEdge
An edge in a connection.
Fields for OrganizationAuditEntryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
OrganizationConnection
A list of organizations managed by an enterprise.
Fields for OrganizationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
OrganizationEdge
An edge in a connection.
Fields for OrganizationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
OrganizationEnterpriseOwnerConnection
The connection type for User.
OrganizationEnterpriseOwnerEdge
An enterprise owner in the context of an organization that is part of the enterprise.
Fields for OrganizationEnterpriseOwnerEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
| The role of the owner with respect to the organization. |
OrganizationIdentityProvider
An Identity Provider configured to provision SAML and SCIM identities for Organizations. 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.
OrganizationIdentityProvider
Implements
Fields for OrganizationIdentityProvider
Name | Description |
---|---|
| The digest algorithm used to sign SAML requests for the Identity Provider. |
| External Identities provisioned by this Identity Provider. Arguments for
|
| N/A |
| The x509 certificate used by the Identity Provider to sign assertions and responses. |
| The Issuer Entity ID for the SAML Identity Provider. |
| Organization this Identity Provider belongs to. |
| The signature algorithm used to sign SAML requests for the Identity Provider. |
| The URL endpoint for the Identity Provider's SAML SSO. |
OrganizationInvitation
An Invitation for a user to an organization.
OrganizationInvitation
Implements
Fields for OrganizationInvitation
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The email address of the user invited to the organization. |
| N/A |
| The source of the invitation. |
| The type of invitation that was sent (e.g. email, user). |
| The user who was invited to the organization. |
| The user who created the invitation. |
| The organization the invite is for. |
| The user's pending role in the organization (e.g. member, owner). |
OrganizationInvitationConnection
The connection type for OrganizationInvitation.
Fields for OrganizationInvitationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
OrganizationInvitationEdge
An edge in a connection.
Fields for OrganizationInvitationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
OrganizationMemberConnection
The connection type for User.
Fields for OrganizationMemberConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
OrganizationMemberEdge
Represents a user within an organization.
Fields for OrganizationMemberEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer. |
| The item at the end of the edge. |
| The role this user has in the organization. |
OrganizationMigration
A GitHub Enterprise Importer (GEI) organization migration.
OrganizationMigration
Implements
Fields for OrganizationMigration
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The reason the organization migration failed. |
| N/A |
| The remaining amount of repos to be migrated. |
| The name of the source organization to be migrated. |
| The URL of the source organization to migrate. |
| The migration state. |
| The name of the target organization. |
| The total amount of repositories to be migrated. |
OrganizationTeamsHovercardContext
An organization teams hovercard context.
OrganizationTeamsHovercardContext
Implements
Fields for OrganizationTeamsHovercardContext
Name | Description |
---|---|
| A string describing this context. |
| An octicon to accompany this context. |
| Teams in this organization the user is a member of that are relevant. Arguments for
|
| The path for the full team list for this user. |
| The URL for the full team list for this user. |
| The total number of teams the user is on in the organization. |
OrganizationsHovercardContext
An organization list hovercard context.
OrganizationsHovercardContext
Implements
Fields for OrganizationsHovercardContext
Name | Description |
---|---|
| A string describing this context. |
| An octicon to accompany this context. |
| Organizations this user is a member of that are relevant. Arguments for
|
| The total number of organizations this user is in. |
Package
Information for an uploaded package.
Package
Implements
Fields for Package
Name | Description |
---|---|
| N/A |
| Find the latest version for the package. |
| Identifies the name of the package. |
| Identifies the type of the package. |
| The repository this package belongs to. |
| Statistics about package activity. |
| Find package version by version string. Arguments for
|
| list of versions for this package. Arguments for
|
PackageConnection
The connection type for Package.
Fields for PackageConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PackageEdge
An edge in a connection.
PackageFile
A file in a package version.
PackageFile
Implements
Fields for PackageFile
Name | Description |
---|---|
| N/A |
| MD5 hash of the file. |
| Name of the file. |
| The package version this file belongs to. |
| SHA1 hash of the file. |
| SHA256 hash of the file. |
| Size of the file in bytes. |
| Identifies the date and time when the object was last updated. |
| URL to download the asset. |
PackageFileConnection
The connection type for PackageFile.
Fields for PackageFileConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PackageFileEdge
An edge in a connection.
Fields for PackageFileEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PackageStatistics
Represents a object that contains package activity statistics such as downloads.
Fields for PackageStatistics
Name | Description |
---|---|
| Number of times the package was downloaded since it was created. |
PackageTag
A version tag contains the mapping between a tag name and a version.
PackageTag
Implements
Fields for PackageTag
Name | Description |
---|---|
| N/A |
| Identifies the tag name of the version. |
| Version that the tag is associated with. |
PackageVersion
Information about a specific package version.
PackageVersion
Implements
Fields for PackageVersion
Name | Description |
---|---|
| List of files associated with this package version. Arguments for
|
| N/A |
| The package associated with this version. |
| The platform this version was built for. |
| Whether or not this version is a pre-release. |
| The README of this package version. |
| The release associated with this package version. |
| Statistics about package activity. |
| The package version summary. |
| The version string. |
PackageVersionConnection
The connection type for PackageVersion.
Fields for PackageVersionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PackageVersionEdge
An edge in a connection.
Fields for PackageVersionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PackageVersionStatistics
Represents a object that contains package version activity statistics such as downloads.
Fields for PackageVersionStatistics
Name | Description |
---|---|
| Number of times the package was downloaded since it was created. |
PageInfo
Information about pagination in a connection.
Fields for PageInfo
Name | Description |
---|---|
| When paginating forwards, the cursor to continue. |
| When paginating forwards, are there more items?. |
| When paginating backwards, are there more items?. |
| When paginating backwards, the cursor to continue. |
PermissionSource
A level of permission and source for a user's access to a repository.
Fields for PermissionSource
Name | Description |
---|---|
| The organization the repository belongs to. |
| The level of access this source has granted to the user. |
| The source of this permission. |
PinnableItemConnection
The connection type for PinnableItem.
Fields for PinnableItemConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PinnableItemEdge
An edge in a connection.
Fields for PinnableItemEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PinnedDiscussion
A Pinned Discussion is a discussion pinned to a repository's index page.
PinnedDiscussion
Implements
Fields for PinnedDiscussion
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The discussion that was pinned. |
| Color stops of the chosen gradient. |
| N/A |
| Background texture pattern. |
| The actor that pinned this discussion. |
| Preconfigured background gradient option. |
| The repository associated with this node. |
| Identifies the date and time when the object was last updated. |
PinnedDiscussionConnection
The connection type for PinnedDiscussion.
Fields for PinnedDiscussionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PinnedDiscussionEdge
An edge in a connection.
Fields for PinnedDiscussionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PinnedEvent
Represents apinned
event on a given issue or pull request.
PinnedIssue
A Pinned Issue is a issue pinned to a repository's index page.
PinnedIssue
Implements
Fields for PinnedIssue
Name | Description |
---|---|
| Identifies the primary key from the database. |
| Identifies the primary key from the database as a BigInt. |
| N/A |
| The issue that was pinned. |
| The actor that pinned this issue. |
| The repository that this issue was pinned to. |
PinnedIssueConnection
The connection type for PinnedIssue.
Fields for PinnedIssueConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PinnedIssueEdge
An edge in a connection.
Fields for PinnedIssueEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PrivateRepositoryForkingDisableAuditEntry
Audit log entry for a private_repository_forking.disable event.
PrivateRepositoryForkingDisableAuditEntry
Implements
Fields for PrivateRepositoryForkingDisableAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
PrivateRepositoryForkingEnableAuditEntry
Audit log entry for a private_repository_forking.enable event.
PrivateRepositoryForkingEnableAuditEntry
Implements
Fields for PrivateRepositoryForkingEnableAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
ProfileItemShowcase
A curatable list of repositories relating to a repository owner, which defaults to showing the most popular repositories they own.
Fields for ProfileItemShowcase
Name | Description |
---|---|
| Whether or not the owner has pinned any repositories or gists. |
| The repositories and gists in the showcase. If the profile owner has any pinned items, those will be returned. Otherwise, the profile owner's popular repositories will be returned. |
Project
Projects manage issues, pull requests and notes within a project owner.
Project
Implements
Fields for Project
Name | Description |
---|---|
| The project's description body. |
| The projects description body rendered to HTML. |
| Indicates if the object is closed (definition of closed may depend on type). |
| Identifies the date and time when the object was closed. |
| List of columns in the project. |
| Identifies the date and time when the object was created. |
| The actor who originally created the project. |
| Identifies the primary key from the database. |
| N/A |
| The project's name. |
| The project's number. |
| The project's owner. Currently limited to repositories, organizations, and users. |
| List of pending cards in this project. Arguments for
|
| Project progress details. |
| The HTTP path for this project. |
| Whether the project is open or closed. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this project. |
| Indicates if the object can be closed by the viewer. |
| Indicates if the object can be reopened by the viewer. |
| Check if the current viewer can update this object. |
ProjectCard
A card in a project.
ProjectCard
Implements
Fields for ProjectCard
Name | Description |
---|---|
| The project column this card is associated under. A card may only belong to one project column at a time. The column field will be null if the card is created in a pending state and has yet to be associated with a column. Once cards are associated with a column, they will not become pending in the future. |
| The card content item. |
| Identifies the date and time when the object was created. |
| The actor who created this card. |
| Identifies the primary key from the database. |
| N/A |
| Whether the card is archived. |
| The card note. |
| The project that contains this card. |
| The HTTP path for this card. |
| The state of ProjectCard. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this card. |
ProjectCardConnection
The connection type for ProjectCard.
Fields for ProjectCardConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectCardEdge
An edge in a connection.
Fields for ProjectCardEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectColumn
A column inside a project.
ProjectColumn
Implements
Fields for ProjectColumn
Name | Description |
---|---|
| List of cards in the column. Arguments for
|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| N/A |
| The project column's name. |
| The project that contains this column. |
| The semantic purpose of the column. |
| The HTTP path for this project column. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this project column. |
ProjectColumnConnection
The connection type for ProjectColumn.
Fields for ProjectColumnConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectColumnEdge
An edge in a connection.
Fields for ProjectColumnEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectConnection
A list of projects associated with the owner.
Fields for ProjectConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectEdge
An edge in a connection.
ProjectProgress
Project progress stats.
Fields for ProjectProgress
Name | Description |
---|---|
| The number of done cards. |
| The percentage of done cards. |
| Whether progress tracking is enabled and cards with purpose exist for this project. |
| The number of in-progress cards. |
| The percentage of in-progress cards. |
| The number of to do cards. |
| The percentage of to do cards. |
ProjectV2
New projects that manage issues, pull requests and drafts using tables and boards.
ProjectV2
Implements
Fields for ProjectV2
Name | Description |
---|---|
| Returns true if the project is closed. |
| Identifies the date and time when the object was closed. |
| Identifies the date and time when the object was created. |
| The actor who originally created the project. |
| Identifies the primary key from the database. |
| A field of the project. Arguments for
|
List of fields and their constraints in the project. Arguments for
| |
| N/A |
| List of items in the project. Arguments for
|
| The project's number. |
| The project's owner. Currently limited to organizations and users. |
| Returns true if the project is public. |
| The project's readme. |
| The repositories the project is linked to. Arguments for
|
| The HTTP path for this project. |
| The project's short description. |
| The teams the project is linked to. Arguments for
|
| Returns true if this project is a template. |
| The project's name. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this project. |
| A view of the project. Arguments for
|
| Indicates if the object can be closed by the viewer. |
| Indicates if the object can be reopened by the viewer. |
| Check if the current viewer can update this object. |
| List of views in the project. Arguments for
|
| A workflow of the project. Arguments for
|
| List of the workflows in the project. Arguments for
|
ProjectV2ActorConnection
The connection type for ProjectV2Actor.
Fields for ProjectV2ActorConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2ActorEdge
An edge in a connection.
Fields for ProjectV2ActorEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2Connection
The connection type for ProjectV2.
Fields for ProjectV2Connection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2Edge
An edge in a connection.
ProjectV2Field
A field inside a project.
ProjectV2Field
Implements
Fields for ProjectV2Field
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The field's type. |
| Identifies the primary key from the database. |
| N/A |
| The project field's name. |
| The project that contains this field. |
| Identifies the date and time when the object was last updated. |
ProjectV2FieldConfigurationConnection
The connection type for ProjectV2FieldConfiguration.
Fields for ProjectV2FieldConfigurationConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2FieldConfigurationEdge
An edge in a connection.
Fields for ProjectV2FieldConfigurationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2FieldConnection
The connection type for ProjectV2Field.
Fields for ProjectV2FieldConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2FieldEdge
An edge in a connection.
Fields for ProjectV2FieldEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2Item
An item within a Project.
ProjectV2Item
Implements
Fields for ProjectV2Item
Name | Description |
---|---|
| The content of the referenced draft issue, issue, or pull request. |
| Identifies the date and time when the object was created. |
| The actor who created the item. |
| Identifies the primary key from the database. |
| The field value of the first project field which matches the Arguments for
|
| The field values that are set on the item. Arguments for
|
| N/A |
| Whether the item is archived. |
| The project that contains this item. |
| The type of the item. |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemConnection
The connection type for ProjectV2Item.
Fields for ProjectV2ItemConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2ItemEdge
An edge in a connection.
Fields for ProjectV2ItemEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2ItemFieldDateValue
The value of a date field in a Project item.
ProjectV2ItemFieldDateValue
Implements
Fields for ProjectV2ItemFieldDateValue
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The actor who created the item. |
| Identifies the primary key from the database. |
| Date value for the field. |
| The project field that contains this value. |
| N/A |
| The project item that contains this value. |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemFieldIterationValue
The value of an iteration field in a Project item.
ProjectV2ItemFieldIterationValue
Implements
Fields for ProjectV2ItemFieldIterationValue
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The actor who created the item. |
| Identifies the primary key from the database. |
| The duration of the iteration in days. |
| The project field that contains this value. |
| N/A |
| The project item that contains this value. |
| The ID of the iteration. |
| The start date of the iteration. |
| The title of the iteration. |
| The title of the iteration, with HTML. |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemFieldLabelValue
The value of the labels field in a Project item.
Fields for ProjectV2ItemFieldLabelValue
Name | Description |
---|---|
| The field that contains this value. |
| Labels value of a field. |
ProjectV2ItemFieldMilestoneValue
The value of a milestone field in a Project item.
Fields for ProjectV2ItemFieldMilestoneValue
Name | Description |
---|---|
| The field that contains this value. |
| Milestone value of a field. |
ProjectV2ItemFieldNumberValue
The value of a number field in a Project item.
ProjectV2ItemFieldNumberValue
Implements
Fields for ProjectV2ItemFieldNumberValue
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The actor who created the item. |
| Identifies the primary key from the database. |
| The project field that contains this value. |
| N/A |
| The project item that contains this value. |
| Number as a float(8). |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemFieldPullRequestValue
The value of a pull request field in a Project item.
Fields for ProjectV2ItemFieldPullRequestValue
Name | Description |
---|---|
| The field that contains this value. |
| The pull requests for this field. Arguments for
|
ProjectV2ItemFieldRepositoryValue
The value of a repository field in a Project item.
Fields for ProjectV2ItemFieldRepositoryValue
Name | Description |
---|---|
| The field that contains this value. |
| The repository for this field. |
ProjectV2ItemFieldReviewerValue
The value of a reviewers field in a Project item.
Fields for ProjectV2ItemFieldReviewerValue
Name | Description |
---|---|
| The field that contains this value. |
| The reviewers for this field. |
ProjectV2ItemFieldSingleSelectValue
The value of a single select field in a Project item.
ProjectV2ItemFieldSingleSelectValue
Implements
Fields for ProjectV2ItemFieldSingleSelectValue
Name | Description |
---|---|
The color applied to the selected single-select option. | |
| Identifies the date and time when the object was created. |
| The actor who created the item. |
| Identifies the primary key from the database. |
| A plain-text description of the selected single-select option, such as what the option means. |
| The description of the selected single-select option, including HTML tags. |
| The project field that contains this value. |
| N/A |
| The project item that contains this value. |
| The name of the selected single select option. |
| The html name of the selected single select option. |
| The id of the selected single select option. |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemFieldTextValue
The value of a text field in a Project item.
ProjectV2ItemFieldTextValue
Implements
Fields for ProjectV2ItemFieldTextValue
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The actor who created the item. |
| Identifies the primary key from the database. |
| The project field that contains this value. |
| N/A |
| The project item that contains this value. |
| Text value of a field. |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemFieldUserValue
The value of a user field in a Project item.
Fields for ProjectV2ItemFieldUserValue
Name | Description |
---|---|
| The field that contains this value. |
| The users for this field. |
ProjectV2ItemFieldValueConnection
The connection type for ProjectV2ItemFieldValue.
Fields for ProjectV2ItemFieldValueConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2ItemFieldValueEdge
An edge in a connection.
Fields for ProjectV2ItemFieldValueEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2IterationField
An iteration field inside a project.
ProjectV2IterationField
Implements
Fields for ProjectV2IterationField
Name | Description |
---|---|
| Iteration configuration settings. |
| Identifies the date and time when the object was created. |
| The field's type. |
| Identifies the primary key from the database. |
| N/A |
| The project field's name. |
| The project that contains this field. |
| Identifies the date and time when the object was last updated. |
ProjectV2IterationFieldConfiguration
Iteration field configuration for a project.
Fields for ProjectV2IterationFieldConfiguration
Name | Description |
---|---|
| The iteration's completed iterations. |
| The iteration's duration in days. |
| The iteration's iterations. |
| The iteration's start day of the week. |
ProjectV2IterationFieldIteration
Iteration field iteration settings for a project.
ProjectV2SingleSelectField
A single select field inside a project.
ProjectV2SingleSelectField
Implements
Fields for ProjectV2SingleSelectField
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The field's type. |
| Identifies the primary key from the database. |
| N/A |
| The project field's name. |
| Options for the single select field. Arguments for
|
| The project that contains this field. |
| Identifies the date and time when the object was last updated. |
ProjectV2SingleSelectFieldOption
Single select field option for a configuration for a project.
Fields for ProjectV2SingleSelectFieldOption
Name | Description |
---|---|
The option's display color. | |
| The option's plain-text description. |
| The option's description, possibly containing HTML. |
| The option's ID. |
| The option's name. |
| The option's html name. |
ProjectV2SortBy
Represents a sort by field and direction.
Fields for ProjectV2SortBy
Name | Description |
---|---|
| The direction of the sorting. Possible values are ASC and DESC. |
| The field by which items are sorted. |
ProjectV2SortByConnection
The connection type for ProjectV2SortBy.
Fields for ProjectV2SortByConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2SortByEdge
An edge in a connection.
Fields for ProjectV2SortByEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2SortByField
Represents a sort by field and direction.
Fields for ProjectV2SortByField
Name | Description |
---|---|
| The direction of the sorting. Possible values are ASC and DESC. |
| The field by which items are sorted. |
ProjectV2SortByFieldConnection
The connection type for ProjectV2SortByField.
Fields for ProjectV2SortByFieldConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2SortByFieldEdge
An edge in a connection.
Fields for ProjectV2SortByFieldEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2View
A view within a ProjectV2.
ProjectV2View
Implements
Fields for ProjectV2View
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
The view's visible fields. Arguments for
| |
| The project view's filter. |
| The view's group-by field. Warning
The Arguments for
|
| The view's group-by field. Arguments for
|
| N/A |
| The project view's layout. |
| The project view's name. |
| The project view's number. |
| The project that contains this view. |
| The view's sort-by config. Warning
The |
| The view's sort-by config. Arguments for
|
| Identifies the date and time when the object was last updated. |
| The view's vertical-group-by field. Warning
The Arguments for
|
| The view's vertical-group-by field. Arguments for
|
| The view's visible fields. Warning
The Arguments for
|
ProjectV2ViewConnection
The connection type for ProjectV2View.
Fields for ProjectV2ViewConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2ViewEdge
An edge in a connection.
Fields for ProjectV2ViewEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ProjectV2Workflow
A workflow inside a project.
ProjectV2Workflow
Implements
Fields for ProjectV2Workflow
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The workflows' enabled state. |
| N/A |
| The workflows' name. |
| The workflows' number. |
| The project that contains this workflow. |
| Identifies the date and time when the object was last updated. |
ProjectV2WorkflowConnection
The connection type for ProjectV2Workflow.
Fields for ProjectV2WorkflowConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ProjectV2WorkflowEdge
An edge in a connection.
Fields for ProjectV2WorkflowEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PublicKey
A user's public key.
PublicKey
Implements
Fields for PublicKey
Name | Description |
---|---|
| The last time this authorization was used to perform an action. Values will be null for keys not owned by the user. |
| Identifies the date and time when the key was created. Keys created before March 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user. |
| The fingerprint for this PublicKey. |
| N/A |
| Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user. |
| The public key string. |
| Identifies the date and time when the key was updated. Keys created before March 5th, 2014 may have inaccurate values. Values will be null for keys not owned by the user. |
PublicKeyConnection
The connection type for PublicKey.
Fields for PublicKeyConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PublicKeyEdge
An edge in a connection.
PullRequest
A repository pull request.
PullRequest
Implements
Assignable
Closable
Comment
Labelable
Lockable
Node
ProjectV2Owner
Reactable
RepositoryNode
Subscribable
UniformResourceLocatable
Updatable
UpdatableComment
Fields for PullRequest
Name | Description |
---|---|
| Reason that the conversation was locked. |
| The number of additions in this pull request. |
| A list of Users assigned to this object. |
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Returns the auto-merge request object if one exists for this pull request. |
| Identifies the base Ref associated with the pull request. |
| Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. |
| Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted. |
| The repository associated with this pull request's base Ref. |
| The body as Markdown. |
| The body rendered to HTML. |
| The body rendered to text. |
| Whether or not the pull request is rebaseable. Note
|
| The number of changed files in this pull request. |
| The HTTP path for the checks of this pull request. |
| The HTTP URL for the checks of this pull request. |
|
|
| Identifies the date and time when the object was closed. |
| List of issues that were may be closed by this pull request. Arguments for
|
| A list of comments associated with the pull request. Arguments for
|
| A list of commits present in this pull request's head branch not present in the base branch. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The number of deletions in this pull request. |
| The actor who edited this pull request's body. |
| Lists the files changed within this pull request. |
| Identifies the head Ref associated with the pull request. |
| Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. |
| Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted. |
| The repository associated with this pull request's head Ref. |
| The owner of the repository associated with this pull request's head Ref. |
| The hovercard information for this issue. Arguments for
|
| N/A |
| Check if this comment was edited and includes an edit with the creation data. |
| The head and base repositories are different. |
| Identifies if the pull request is a draft. |
| Is this pull request read by the viewer. |
| A list of labels associated with the object. Arguments for
|
| The moment the editor made the last edit. |
| A list of latest reviews per user associated with the pull request. Arguments for
|
| A list of latest reviews per user associated with the pull request that are not also pending review. Arguments for
|
|
|
| Indicates whether maintainers can modify the pull request. |
| The commit that was created when this pull request was merged. |
| Detailed information about the current pull request merge state status. Note
|
| Whether or not the pull request can be merged based on the existence of merge conflicts. |
| Whether or not the pull request was merged. |
| The date and time that the pull request was merged. |
| The actor who merged the pull request. |
| Identifies the milestone associated with the pull request. |
| Identifies the pull request number. |
| A list of Users that are participating in the Pull Request conversation. Arguments for
|
| The permalink to the pull request. |
| The commit that GitHub automatically generated to test if this pull request
could be merged. This field will not return a value if the pull request is
merged, or if the test merge commit is still being generated. See the
|
| List of project cards associated with this pull request. 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 pull request. |
| The HTTP path for reverting this pull request. |
| The HTTP URL for reverting this pull request. |
| The current status of this pull request with respect to code review. |
| A list of review requests associated with the pull request. Arguments for
|
| The list of all review threads for this pull request. Arguments for
|
| A list of reviews associated with the pull request. Arguments for
|
| Identifies the state of the pull request. |
| A list of reviewer suggestions based on commit history and past review comments. |
| A list of events, comments, commits, etc. associated with the pull request. Warning
Arguments for
|
| A list of events, comments, commits, etc. associated with the pull request. Arguments for
|
| Identifies the pull request title. |
| Identifies the pull request title rendered to HTML. |
| Returns a count of how many comments this pull request has received. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this pull request. |
| A list of edits to this content. Arguments for
|
| Whether or not the viewer can apply suggestion. |
| Indicates if the object can be closed by the viewer. |
| Check if the viewer can restore the deleted head ref. |
| Whether or not the viewer can disable auto-merge. |
| Can the viewer edit files within this pull request. |
| Whether or not the viewer can enable auto-merge. |
| Indicates whether the viewer can bypass branch protections and merge the pull request immediately. |
| Can user react to this subject. |
| Indicates if the object can be reopened by the viewer. |
| Check if the viewer is able to change their subscription status for the repository. |
| Check if the current viewer can update this object. |
| Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. If the head ref is up to date or unable to be updated by this user, this will return false. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
| The latest review given from the viewer. |
| The person who has requested the viewer for review on this pull request. |
| The merge body text for the viewer and method. Arguments for
|
| The merge headline text for the viewer and method. Arguments for
|
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
PullRequestChangedFile
A file changed in a pull request.
Fields for PullRequestChangedFile
Name | Description |
---|---|
| The number of additions to the file. |
| How the file was changed in this PullRequest. |
| The number of deletions to the file. |
| The path of the file. |
| The state of the file for the viewer. |
PullRequestChangedFileConnection
The connection type for PullRequestChangedFile.
Fields for PullRequestChangedFileConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestChangedFileEdge
An edge in a connection.
Fields for PullRequestChangedFileEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestCommit
Represents a Git commit part of a pull request.
PullRequestCommit
Implements
Fields for PullRequestCommit
Name | Description |
---|---|
| The Git commit object. |
| N/A |
| The pull request this commit belongs to. |
| The HTTP path for this pull request commit. |
| The HTTP URL for this pull request commit. |
PullRequestCommitCommentThread
Represents a commit comment thread part of a pull request.
PullRequestCommitCommentThread
Implements
Fields for PullRequestCommitCommentThread
Name | Description |
---|---|
| The comments that exist in this thread. |
| The commit the comments were made on. |
| N/A |
| The file the comments were made on. |
| The position in the diff for the commit that the comment was made on. |
| The pull request this commit comment thread belongs to. |
| The repository associated with this node. |
PullRequestCommitConnection
The connection type for PullRequestCommit.
Fields for PullRequestCommitConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestCommitEdge
An edge in a connection.
Fields for PullRequestCommitEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestConnection
The connection type for PullRequest.
Fields for PullRequestConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestContributionsByRepository
This aggregates pull requests opened by a user within one repository.
Fields for PullRequestContributionsByRepository
Name | Description |
---|---|
| The pull request contributions. Arguments for
|
| The repository in which the pull requests were opened. |
PullRequestEdge
An edge in a connection.
Fields for PullRequestEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestParameters
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Fields for PullRequestParameters
Name | Description |
---|---|
| New, reviewable commits pushed will dismiss previous pull request review approvals. |
| Require an approving review in pull requests that modify files that have a designated code owner. |
| Whether the most recent reviewable push must be approved by someone other than the person who pushed it. |
| The number of approving reviews that are required before a pull request can be merged. |
| All conversations on code must be resolved before a pull request can be merged. |
PullRequestReview
A review object for a given pull request.
PullRequestReview
Implements
Fields for PullRequestReview
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Indicates whether the author of this review has push access to the repository. |
| Identifies the pull request review body. |
| The body rendered to HTML. |
| The body of this review rendered as plain text. |
| A list of review comments for the current pull request review. |
| Identifies the commit associated with this pull request review. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| N/A |
| Check if this comment was edited and includes an edit with the creation data. |
| The moment the editor made the last edit. |
| A list of teams that this review was made on behalf of. Arguments for
|
| Identifies when the comment was published at. |
| Identifies the pull request associated with this pull request review. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments for
|
| The repository associated with this node. |
| The HTTP path permalink for this PullRequestReview. |
| Identifies the current state of the pull request review. |
| Identifies when the Pull Request Review was submitted. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL permalink for this PullRequestReview. |
| A list of edits to this content. Arguments for
|
| Check if the current viewer can delete 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. |
PullRequestReviewComment
A review comment associated with a given repository pull request.
PullRequestReviewComment
Implements
Fields for PullRequestReviewComment
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| The comment body of this review comment. |
| The body rendered to HTML. |
| The comment body of this review comment rendered as plain text. |
| Identifies the commit associated with the comment. |
| Identifies when the comment was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The diff hunk to which the comment applies. |
| Identifies when the comment was created in a draft state. |
| The actor who edited the comment. |
| N/A |
| 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. |
| The end line number on the file to which the comment applies. |
| Returns why the comment was minimized. One of |
| Identifies the original commit associated with the comment. |
| The end line number on the file to which the comment applied when it was first created. |
| The original line index in the diff to which the comment applies. Warning
We are phasing out diff-relative positioning for PR comments Removal on 2023-10-01 UTC. |
| The start line number on the file to which the comment applied when it was first created. |
| Identifies when the comment body is outdated. |
| The path to which the comment applies. |
| The line index in the diff to which the comment applies. Warning
We are phasing out diff-relative positioning for PR comments Use the |
| Identifies when the comment was published at. |
| The pull request associated with this review comment. |
| The pull request review associated with this review comment. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments for
|
| The comment this is a reply to. |
| The repository associated with this node. |
| The HTTP path permalink for this review comment. |
| The start line number on the file to which the comment applies. |
| Identifies the state of the comment. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
| Identifies when the comment was last updated. |
| The HTTP URL permalink for this review 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. |
PullRequestReviewCommentConnection
The connection type for PullRequestReviewComment.
Fields for PullRequestReviewCommentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestReviewCommentEdge
An edge in a connection.
Fields for PullRequestReviewCommentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestReviewConnection
The connection type for PullRequestReview.
Fields for PullRequestReviewConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestReviewContributionsByRepository
This aggregates pull request reviews made by a user within one repository.
Fields for PullRequestReviewContributionsByRepository
Name | Description |
---|---|
| The pull request review contributions. Arguments for
|
| The repository in which the pull request reviews were made. |
PullRequestReviewEdge
An edge in a connection.
Fields for PullRequestReviewEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestReviewThread
A threaded list of comments for a given pull request.
PullRequestReviewThread
Implements
Fields for PullRequestReviewThread
Name | Description |
---|---|
| A list of pull request comments associated with the thread. Arguments for
|
| The side of the diff on which this thread was placed. |
| N/A |
| Whether or not the thread has been collapsed (resolved). |
| Indicates whether this thread was outdated by newer changes. |
| Whether this thread has been resolved. |
| The line in the file to which this thread refers. |
| The original line in the file to which this thread refers. |
| The original start line in the file to which this thread refers (multi-line only). |
| Identifies the file path of this thread. |
| Identifies the pull request associated with this thread. |
| Identifies the repository associated with this thread. |
| The user who resolved this thread. |
| The side of the diff that the first line of the thread starts on (multi-line only). |
| The start line in the file to which this thread refers (multi-line only). |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
| Indicates whether the current viewer can reply to this thread. |
| Whether or not the viewer can resolve this thread. |
| Whether or not the viewer can unresolve this thread. |
PullRequestReviewThreadConnection
Review comment threads for a pull request review.
Fields for PullRequestReviewThreadConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestReviewThreadEdge
An edge in a connection.
Fields for PullRequestReviewThreadEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestRevisionMarker
Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
Fields for PullRequestRevisionMarker
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The last commit the viewer has seen. |
| The pull request to which the marker belongs. |
PullRequestTemplate
A repository pull request template.
Fields for PullRequestTemplate
Name | Description |
---|---|
| The body of the template. |
| The filename of the template. |
| The repository the template belongs to. |
PullRequestThread
A threaded list of comments for a given pull request.
PullRequestThread
Implements
Fields for PullRequestThread
Name | Description |
---|---|
| A list of pull request comments associated with the thread. Arguments for
|
| The side of the diff on which this thread was placed. |
| N/A |
| Whether or not the thread has been collapsed (resolved). |
| Indicates whether this thread was outdated by newer changes. |
| Whether this thread has been resolved. |
| The line in the file to which this thread refers. |
| Identifies the file path of this thread. |
| Identifies the pull request associated with this thread. |
| Identifies the repository associated with this thread. |
| The user who resolved this thread. |
| The side of the diff that the first line of the thread starts on (multi-line only). |
| The line of the first file diff in the thread. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
| Indicates whether the current viewer can reply to this thread. |
| Whether or not the viewer can resolve this thread. |
| Whether or not the viewer can unresolve this thread. |
PullRequestTimelineConnection
The connection type for PullRequestTimelineItem.
Fields for PullRequestTimelineConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestTimelineItemEdge
An edge in a connection.
Fields for PullRequestTimelineItemEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestTimelineItemsConnection
The connection type for PullRequestTimelineItems.
Fields for PullRequestTimelineItemsConnection
Name | Description |
---|---|
| A list of edges. |
| Identifies the count of items after applying |
| A list of nodes. |
| Identifies the count of items after applying |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the date and time when the timeline was last updated. |
PullRequestTimelineItemsEdge
An edge in a connection.
Fields for PullRequestTimelineItemsEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
Push
A Git push.
Push
Implements
Fields for Push
Name | Description |
---|---|
| N/A |
| The SHA after the push. |
| The permalink for this push. |
| The SHA before the push. |
| The actor who pushed. |
| The repository that was pushed to. |
PushAllowance
A team, user, or app who has the ability to push to a protected branch.
PushAllowance
Implements
Fields for PushAllowance
Name | Description |
---|---|
| The actor that can push. |
| Identifies the branch protection rule associated with the allowed user, team, or app. |
| N/A |
PushAllowanceConnection
The connection type for PushAllowance.
Fields for PushAllowanceConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PushAllowanceEdge
An edge in a connection.
Fields for PushAllowanceEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RateLimit
Represents the client's rate limit.
Fields for RateLimit
Name | Description |
---|---|
| The point cost for the current query counting against the rate limit. |
| The maximum number of points the client is permitted to consume in a 60 minute window. |
| The maximum number of nodes this query may return. |
| The number of points remaining in the current rate limit window. |
| The time at which the current rate limit window resets in UTC epoch seconds. |
| The number of points used in the current rate limit window. |
ReactingUserConnection
The connection type for User.
Fields for ReactingUserConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReactingUserEdge
Represents a user that's made a reaction.
Reaction
An emoji reaction to a particular piece of content.
Reaction
Implements
Fields for Reaction
Name | Description |
---|---|
| Identifies the emoji reaction. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| N/A |
| The reactable piece of content. |
| Identifies the user who created this reaction. |
ReactionConnection
A list of reactions that have been left on the subject.
Fields for ReactionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Whether or not the authenticated user has left a reaction on the subject. |
ReactionEdge
An edge in a connection.
ReactionGroup
A group of emoji reactions to a particular piece of content.
Fields for ReactionGroup
Name | Description |
---|---|
| Identifies the emoji reaction. |
| Identifies when the reaction was created. |
| Reactors to the reaction subject with the emotion represented by this reaction group. |
| The subject that was reacted to. |
| Users who have reacted to the reaction subject with the emotion represented by this reaction group. Warning
Reactors can now be mannequins, bots, and organizations. Use the |
| Whether or not the authenticated user has left a reaction on the subject. |
ReactorConnection
The connection type for Reactor.
Fields for ReactorConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReactorEdge
Represents an author of a reaction.
ReadyForReviewEvent
Represents aready_for_review
event on a given pull request.
ReadyForReviewEvent
Implements
Fields for ReadyForReviewEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| PullRequest referenced by event. |
| The HTTP path for this ready for review event. |
| The HTTP URL for this ready for review event. |
Ref
Represents a Git reference.
Ref
Implements
Fields for Ref
Name | Description |
---|---|
| A list of pull requests with this ref as the head ref. Arguments for
|
| Branch protection rules for this ref. |
| Compares the current ref as a base ref to another head ref, if the comparison can be made. Arguments for
|
| N/A |
| The ref name. |
| The ref's prefix, such as |
| Branch protection rules that are viewable by non-admins. |
| The repository the ref belongs to. |
| The object the ref points to. Returns null when object does not exist. |
RefConnection
The connection type for Ref.
RefEdge
An edge in a connection.
RefNameConditionTarget
Parameters to be used for the ref_name condition.
Fields for RefNameConditionTarget
Name | Description |
---|---|
| Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. |
| Array of ref names or patterns to include. One of these patterns must match
for the condition to pass. Also accepts |
RefUpdateRule
A ref update rules for a viewer.
Fields for RefUpdateRule
Name | Description |
---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| Can matching branches be created. |
| Identifies the protection rule pattern. |
| Number of approving reviews required to update matching branches. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are conversations required to be resolved before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are commits required to be signed. |
| Is the viewer allowed to dismiss reviews. |
| Can the viewer push to the branch. |
ReferencedEvent
Represents areferenced
event on a given ReferencedSubject
.
ReferencedEvent
Implements
Fields for ReferencedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the commit associated with the |
| Identifies the repository associated with the |
| Identifies the date and time when the object was created. |
| N/A |
| Reference originated in a different repository. |
| Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference. |
| Object referenced by event. |
Release
A release contains the content for a release.
Release
Implements
Fields for Release
Name | Description |
---|---|
| The author of the release. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the release. |
| The description of this release rendered to HTML. |
| N/A |
| Whether or not the release is a draft. |
| Whether or not the release is the latest releast. |
| Whether or not the release is a prerelease. |
| A list of users mentioned in the release description. |
| The title of the release. |
| Identifies the date and time when the release was created. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments for
|
| List of releases assets which are dependent on this release. Arguments for
|
| The repository that the release belongs to. |
| The HTTP path for this issue. |
| A description of the release, rendered to HTML without any links in it. Arguments for
|
| The Git tag the release points to. |
| The tag commit for this release. |
| The name of the release's Git tag. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this issue. |
| Can user react to this subject. |
ReleaseAsset
A release asset contains the content for a release asset.
ReleaseAsset
Implements
Fields for ReleaseAsset
Name | Description |
---|---|
| The asset's content-type. |
| Identifies the date and time when the object was created. |
| The number of times this asset was downloaded. |
| Identifies the URL where you can download the release asset via the browser. |
| N/A |
| Identifies the title of the release asset. |
| Release that the asset is associated with. |
| The size (in bytes) of the asset. |
| Identifies the date and time when the object was last updated. |
| The user that performed the upload. |
| Identifies the URL of the release asset. |
ReleaseAssetConnection
The connection type for ReleaseAsset.
Fields for ReleaseAssetConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReleaseAssetEdge
An edge in a connection.
Fields for ReleaseAssetEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ReleaseConnection
The connection type for Release.
Fields for ReleaseConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReleaseEdge
An edge in a connection.
RemovedFromProjectEvent
Represents aremoved_from_project
event on a given issue or pull request.
RemovedFromProjectEvent
Implements
Fields for RemovedFromProjectEvent
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. |
| N/A |
| Project referenced by event. Note
|
| Column name referenced by this project event. Note
|
RenamedTitleEvent
Represents arenamed
event on a given issue or pull request.
RenamedTitleEvent
Implements
Fields for RenamedTitleEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the current title of the issue or pull request. |
| N/A |
| Identifies the previous title of the issue or pull request. |
| Subject that was renamed. |
ReopenedEvent
Represents areopened
event on any Closable
.
ReopenedEvent
Implements
Fields for ReopenedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Object that was reopened. |
| Identifies the date and time when the object was created. |
| N/A |
| The reason the issue state was changed to open. |
RepoAccessAuditEntry
Audit log entry for a repo.access event.
RepoAccessAuditEntry
Implements
Fields for RepoAccessAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The visibility of the repository. |
RepoAddMemberAuditEntry
Audit log entry for a repo.add_member event.
RepoAddMemberAuditEntry
Implements
Fields for RepoAddMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The visibility of the repository. |
RepoAddTopicAuditEntry
Audit log entry for a repo.add_topic event.
RepoAddTopicAuditEntry
Implements
Fields for RepoAddTopicAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The name of the topic added to the repository. |
| The name of the topic added to the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoArchivedAuditEntry
Audit log entry for a repo.archived event.
RepoArchivedAuditEntry
Implements
Fields for RepoArchivedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The visibility of the repository. |
RepoChangeMergeSettingAuditEntry
Audit log entry for a repo.change_merge_setting event.
RepoChangeMergeSettingAuditEntry
Implements
Fields for RepoChangeMergeSettingAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| Whether the change was to enable (true) or disable (false) the merge type. |
| The merge method affected by the change. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigDisableAnonymousGitAccessAuditEntry
Audit log entry for a repo.config.disable_anonymous_git_access event.
RepoConfigDisableAnonymousGitAccessAuditEntry
Implements
Fields for RepoConfigDisableAnonymousGitAccessAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigDisableCollaboratorsOnlyAuditEntry
Audit log entry for a repo.config.disable_collaborators_only event.
RepoConfigDisableCollaboratorsOnlyAuditEntry
Implements
Fields for RepoConfigDisableCollaboratorsOnlyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigDisableContributorsOnlyAuditEntry
Audit log entry for a repo.config.disable_contributors_only event.
RepoConfigDisableContributorsOnlyAuditEntry
Implements
Fields for RepoConfigDisableContributorsOnlyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigDisableSockpuppetDisallowedAuditEntry
Audit log entry for a repo.config.disable_sockpuppet_disallowed event.
RepoConfigDisableSockpuppetDisallowedAuditEntry
Implements
Fields for RepoConfigDisableSockpuppetDisallowedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigEnableAnonymousGitAccessAuditEntry
Audit log entry for a repo.config.enable_anonymous_git_access event.
RepoConfigEnableAnonymousGitAccessAuditEntry
Implements
Fields for RepoConfigEnableAnonymousGitAccessAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigEnableCollaboratorsOnlyAuditEntry
Audit log entry for a repo.config.enable_collaborators_only event.
RepoConfigEnableCollaboratorsOnlyAuditEntry
Implements
Fields for RepoConfigEnableCollaboratorsOnlyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigEnableContributorsOnlyAuditEntry
Audit log entry for a repo.config.enable_contributors_only event.
RepoConfigEnableContributorsOnlyAuditEntry
Implements
Fields for RepoConfigEnableContributorsOnlyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigEnableSockpuppetDisallowedAuditEntry
Audit log entry for a repo.config.enable_sockpuppet_disallowed event.
RepoConfigEnableSockpuppetDisallowedAuditEntry
Implements
Fields for RepoConfigEnableSockpuppetDisallowedAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigLockAnonymousGitAccessAuditEntry
Audit log entry for a repo.config.lock_anonymous_git_access event.
RepoConfigLockAnonymousGitAccessAuditEntry
Implements
Fields for RepoConfigLockAnonymousGitAccessAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoConfigUnlockAnonymousGitAccessAuditEntry
Audit log entry for a repo.config.unlock_anonymous_git_access event.
RepoConfigUnlockAnonymousGitAccessAuditEntry
Implements
Fields for RepoConfigUnlockAnonymousGitAccessAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepoCreateAuditEntry
Audit log entry for a repo.create event.
RepoCreateAuditEntry
Implements
Fields for RepoCreateAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The name of the parent repository for this forked repository. |
| The name of the root repository for this network. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The visibility of the repository. |
RepoDestroyAuditEntry
Audit log entry for a repo.destroy event.
RepoDestroyAuditEntry
Implements
Fields for RepoDestroyAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The visibility of the repository. |
RepoRemoveMemberAuditEntry
Audit log entry for a repo.remove_member event.
RepoRemoveMemberAuditEntry
Implements
Fields for RepoRemoveMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
| The visibility of the repository. |
RepoRemoveTopicAuditEntry
Audit log entry for a repo.remove_topic event.
RepoRemoveTopicAuditEntry
Implements
Fields for RepoRemoveTopicAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The name of the topic added to the repository. |
| The name of the topic added to the repository. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
Repository
A repository contains the content for a project.
Repository
Implements
Node
PackageOwner
ProjectOwner
ProjectV2Recent
RepositoryInfo
Starrable
Subscribable
UniformResourceLocatable
Fields for Repository
Name | Description |
---|---|
| Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. |
| Identifies the date and time when the repository was archived. |
| A list of users that can be assigned to issues in this repository. Arguments for
|
| Whether or not Auto-merge can be enabled on pull requests in this repository. |
| A list of branch protection rules for this repository. Arguments for
|
| Returns the code of conduct for this repository. |
| Information extracted from the repository's Arguments for
|
| A list of collaborators associated with the repository. Arguments for
|
| A list of commit comments associated with the repository. Arguments for
|
| Returns a list of contact links associated to the repository. |
| Returns the contributing guidelines for this repository. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The Ref associated with the repository's default branch. |
| Whether or not branches are automatically deleted when merged in this repository. |
| A list of dependency manifests contained in the repository. Note
Arguments for
|
| A list of deploy keys that are on this repository. Arguments for
|
| Deployments associated with the repository. Arguments for
|
| The description of the repository. |
| The description of the repository rendered to HTML. |
| Returns a single discussion from the current repository by number. Arguments for
|
| A list of discussion categories that are available in the repository. Arguments for
|
| A discussion category by slug. Arguments for
|
| A list of discussions that have been opened in the repository. Arguments for
|
| The number of kilobytes this repository occupies on disk. |
| Returns a single active environment from the current repository by name. Arguments for
|
| A list of environments that are in this repository. Arguments for
|
| Returns how many forks there are of this repository in the whole network. |
| Whether this repository allows forks. |
| A list of direct forked repositories. Arguments for
|
| Indicates if the repository has anonymous Git read access feature enabled. |
| Indicates if the repository has the Discussions feature enabled. |
| Indicates if the repository has issues feature enabled. |
| Indicates if the repository has the Projects feature enabled. |
| Whether vulnerability alerts are enabled for the repository. |
| Indicates if the repository has wiki feature enabled. |
| The repository's URL. |
| N/A |
| Indicates if the repository is unmaintained. |
| Returns true if blank issue creation is allowed. |
| Returns whether or not this repository disabled. |
| Returns whether or not this repository is empty. |
| Identifies if the repository is a fork. |
| Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. |
| Indicates if the repository has been locked or not. |
| Identifies if the repository is a mirror. |
| Identifies if the repository is private or internal. |
| Returns true if this repository has a security policy. |
| Identifies if the repository is a template that can be used to generate new repositories. |
| Is this repository a user configuration repository?. |
| Returns a single issue from the current repository by number. Arguments for
|
| Returns a single issue-like object from the current repository by number. Arguments for
|
| Returns a list of issue templates associated to the repository. |
| A list of issues that have been opened in the repository. Arguments for
|
| Returns a single label by name. Arguments for
|
| A list of labels associated with the repository. Arguments for
|
| A list containing a breakdown of the language composition of the repository. Arguments for
|
| Get the latest release for the repository if one exists. |
| The license associated with the repository. |
| The reason the repository has been locked. |
| A list of Users that can be mentioned in the context of the repository. Arguments for
|
| Whether or not PRs are merged with a merge commit on this repository. |
| How the default commit message will be generated when merging a pull request. |
| How the default commit title will be generated when merging a pull request. |
| Returns a single milestone from the current repository by number. Arguments for
|
| A list of milestones associated with the repository. Arguments for
|
| The repository's original mirror URL. |
| The name of the repository. |
| The repository's name with owner. |
| A Git object in the repository. Arguments for
|
| The image used to represent this repository in Open Graph data. |
| The User owner of the repository. |
| A list of packages under the owner. Arguments for
|
| The repository parent, if this is a fork. |
| A list of discussions that have been pinned in this repository. Arguments for
|
| A list of pinned issues for this repository. Arguments for
|
| The primary language of the repository's code. |
| Find project by number. Arguments for
|
| A list of projects under the owner. Arguments for
|
| The HTTP path listing the repository's projects. |
| The HTTP URL listing the repository's projects. |
| Returns a single pull request from the current repository by number. Arguments for
|
| Returns a list of pull request templates associated to the repository. |
| A list of pull requests that have been opened in the repository. Arguments for
|
| Identifies the date and time when the repository was last pushed to. |
| Whether or not rebase-merging is enabled on this repository. |
| Recent projects that this user has modified in the context of the owner. Arguments for
|
| Fetch a given ref from the repository. Arguments for
|
| Fetch a list of refs from the repository. Arguments for
|
| Lookup a single release given various criteria. Arguments for
|
| List of releases which are dependent on this repository. Arguments for
|
| A list of applied repository-topic associations for this repository. Arguments for
|
| The HTTP path for this repository. |
| Returns a single ruleset from the current repository by ID. |
| A list of rulesets for this repository. Arguments for
|
| The security policy URL. |
| A description of the repository, rendered to HTML without any links in it. Arguments for
|
| Whether or not squash-merging is enabled on this repository. |
| How the default commit message will be generated when squash merging a pull request. |
| How the default commit title will be generated when squash merging a pull request. |
| Whether a squash merge commit can use the pull request title as default. Warning
|
| The SSH URL to clone this repository. |
| Returns a count of how many stargazers there are on this object. |
| A list of users who have starred this starrable. Arguments for
|
| Returns a list of all submodules in this repository parsed from the .gitmodules file as of the default branch's HEAD commit. Arguments for
|
| Temporary authentication token for cloning this repository. |
| The repository from which this repository was generated, if any. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this repository. |
| Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. |
| Indicates whether the viewer has admin permissions on this repository. |
| Can the current viewer create new projects on this owner. |
| Check if the viewer is able to change their subscription status for the repository. |
| Indicates whether the viewer can update the topics of this repository. |
| The last commit email for the viewer. |
| The last used merge method by the viewer or the default for the repository. |
| Returns a boolean indicating whether the viewing user has starred this starrable. |
| The users permission level on the repository. Will return null if authenticated as an GitHub App. |
| A list of emails this viewer can commit with. |
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
| Indicates the repository's visibility level. |
| Returns a single vulnerability alert from the current repository by number. Arguments for
|
| A list of vulnerability alerts that are on this repository. Arguments for
|
| A list of users watching the repository. |
| Whether contributors are required to sign off on web-based commits in this repository. |
RepositoryCodeowners
Information extracted from a repository's CODEOWNERS
file.
Fields for RepositoryCodeowners
Name | Description |
---|---|
| Any problems that were encountered while parsing the |
RepositoryCodeownersError
An error in a CODEOWNERS
file.
Fields for RepositoryCodeownersError
Name | Description |
---|---|
| The column number where the error occurs. |
| A short string describing the type of error. |
| The line number where the error occurs. |
| A complete description of the error, combining information from other fields. |
| The path to the file when the error occurs. |
| The content of the line where the error occurs. |
| A suggestion of how to fix the error. |
RepositoryCollaboratorConnection
The connection type for User.
Fields for RepositoryCollaboratorConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryCollaboratorEdge
Represents a user who is a collaborator of a repository.
Fields for RepositoryCollaboratorEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| N/A |
| The permission the user has on the repository. |
| A list of sources for the user's access to the repository. |
RepositoryConnection
A list of repositories owned by the subject.
Fields for RepositoryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| The total size in kilobytes of all repositories in the connection. |
RepositoryContactLink
A repository contact link.
RepositoryEdge
An edge in a connection.
Fields for RepositoryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryIdConditionTarget
Parameters to be used for the repository_id condition.
Fields for RepositoryIdConditionTarget
Name | Description |
---|---|
| One of these repo IDs must match the repo. |
RepositoryInvitation
An invitation for a user to be added to a repository.
RepositoryInvitation
Implements
Fields for RepositoryInvitation
Name | Description |
---|---|
| The email address that received the invitation. |
| N/A |
| The user who received the invitation. |
| The user who created the invitation. |
| The permalink for this repository invitation. |
| The permission granted on this repository by this invitation. |
| The Repository the user is invited to. |
RepositoryInvitationConnection
A list of repository invitations.
Fields for RepositoryInvitationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryInvitationEdge
An edge in a connection.
Fields for RepositoryInvitationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryMigration
A GitHub Enterprise Importer (GEI) repository migration.
RepositoryMigration
Implements
Fields for RepositoryMigration
Name | Description |
---|---|
| The migration flag to continue on error. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The reason the migration failed. |
| N/A |
| The URL for the migration log (expires 1 day after migration completes). |
| The migration source. |
| The target repository name. |
| The migration source URL, for example |
| The migration state. |
| The number of warnings encountered for this migration. To review the warnings, check the Migration Log. |
RepositoryMigrationConnection
The connection type for RepositoryMigration.
Fields for RepositoryMigrationConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryMigrationEdge
Represents a repository migration.
Fields for RepositoryMigrationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryNameConditionTarget
Parameters to be used for the repository_name condition.
Fields for RepositoryNameConditionTarget
Name | Description |
---|---|
| Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. |
| Array of repository names or patterns to include. One of these patterns must
match for the condition to pass. Also accepts |
| Target changes that match these patterns will be prevented except by those with bypass permissions. |
RepositoryRule
A repository rule.
RepositoryRule
Implements
Fields for RepositoryRule
Name | Description |
---|---|
| N/A |
| The parameters for this rule. |
| The repository ruleset associated with this rule configuration. |
| The type of rule. |
RepositoryRuleConditions
Set of conditions that determine if a ruleset will evaluate.
Fields for RepositoryRuleConditions
Name | Description |
---|---|
| Configuration for the ref_name condition. |
| Configuration for the repository_id condition. |
| Configuration for the repository_name condition. |
RepositoryRuleConnection
The connection type for RepositoryRule.
Fields for RepositoryRuleConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryRuleEdge
An edge in a connection.
Fields for RepositoryRuleEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryRuleset
A repository ruleset.
RepositoryRuleset
Implements
Fields for RepositoryRuleset
Name | Description |
---|---|
| The actors that can bypass this ruleset. Arguments for
|
| The set of conditions that must evaluate to true for this ruleset to apply. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The enforcement level of this ruleset. |
| N/A |
| Name of the ruleset. |
| List of rules. Arguments for
|
| Source of ruleset. |
| Target of the ruleset. |
| Identifies the date and time when the object was last updated. |
RepositoryRulesetBypassActor
A team or app that has the ability to bypass a rules defined on a ruleset.
RepositoryRulesetBypassActor
Implements
Fields for RepositoryRulesetBypassActor
Name | Description |
---|---|
| The actor that can bypass rules. |
| The mode for the bypass actor. |
| N/A |
| This actor represents the ability for an organization admin to bypass. |
| If the actor is a repository role, the repository role's ID that can bypass. |
| If the actor is a repository role, the repository role's name that can bypass. |
| Identifies the ruleset associated with the allowed actor. |
RepositoryRulesetBypassActorConnection
The connection type for RepositoryRulesetBypassActor.
Fields for RepositoryRulesetBypassActorConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryRulesetBypassActorEdge
An edge in a connection.
Fields for RepositoryRulesetBypassActorEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryRulesetConnection
The connection type for RepositoryRuleset.
Fields for RepositoryRulesetConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryRulesetEdge
An edge in a connection.
Fields for RepositoryRulesetEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryTopic
A repository-topic connects a repository to a topic.
RepositoryTopicConnection
The connection type for RepositoryTopic.
Fields for RepositoryTopicConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryTopicEdge
An edge in a connection.
Fields for RepositoryTopicEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RepositoryVisibilityChangeDisableAuditEntry
Audit log entry for a repository_visibility_change.disable event.
RepositoryVisibilityChangeDisableAuditEntry
Implements
Fields for RepositoryVisibilityChangeDisableAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepositoryVisibilityChangeEnableAuditEntry
Audit log entry for a repository_visibility_change.enable event.
RepositoryVisibilityChangeEnableAuditEntry
Implements
Fields for RepositoryVisibilityChangeEnableAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| N/A |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
RepositoryVulnerabilityAlert
A Dependabot alert for a repository with a dependency affected by a security vulnerability.
RepositoryVulnerabilityAlert
Implements
Fields for RepositoryVulnerabilityAlert
Name | Description |
---|---|
| When was the alert created?. |
| The associated Dependabot update. |
| The scope of an alert's dependency. |
| Comment explaining the reason the alert was dismissed. |
| The reason the alert was dismissed. |
| When was the alert dismissed?. |
| The user who dismissed the alert. |
| When was the alert fixed?. |
| N/A |
| Identifies the alert number. |
| The associated repository. |
| The associated security advisory. |
| The associated security vulnerability. |
Identifies the state of the alert. | |
| The vulnerable manifest filename. |
| The vulnerable manifest path. |
| The vulnerable requirements. |
RepositoryVulnerabilityAlertConnection
The connection type for RepositoryVulnerabilityAlert.
Fields for RepositoryVulnerabilityAlertConnection
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RepositoryVulnerabilityAlertEdge
An edge in a connection.
Fields for RepositoryVulnerabilityAlertEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RequestedReviewerConnection
The connection type for RequestedReviewer.
Fields for RequestedReviewerConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RequestedReviewerEdge
An edge in a connection.
Fields for RequestedReviewerEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RequiredDeploymentsParameters
Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
Fields for RequiredDeploymentsParameters
Name | Description |
---|---|
| The environments that must be successfully deployed to before branches can be merged. |
RequiredStatusCheckDescription
Represents a required status check for a protected branch, but not any specific run of that check.
RequiredStatusChecksParameters
Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
Fields for RequiredStatusChecksParameters
Name | Description |
---|---|
| Status checks that are required. |
| Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. |
RestrictedContribution
Represents a private contribution a user made on GitHub.
RestrictedContribution
Implements
Fields for RestrictedContribution
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 HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
ReviewDismissalAllowance
A user, team, or app who has the ability to dismiss a review on a protected branch.
ReviewDismissalAllowance
Implements
Fields for ReviewDismissalAllowance
Name | Description |
---|---|
| The actor that can dismiss. |
| Identifies the branch protection rule associated with the allowed user, team, or app. |
| N/A |
ReviewDismissalAllowanceConnection
The connection type for ReviewDismissalAllowance.
Fields for ReviewDismissalAllowanceConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReviewDismissalAllowanceEdge
An edge in a connection.
Fields for ReviewDismissalAllowanceEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ReviewDismissedEvent
Represents areview_dismissed
event on a given issue or pull request.
ReviewDismissedEvent
Implements
Fields for ReviewDismissedEvent
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. |
| Identifies the optional message associated with the |
| Identifies the optional message associated with the event, rendered to HTML. |
| N/A |
| Identifies the previous state of the review with the |
| PullRequest referenced by event. |
| Identifies the commit which caused the review to become stale. |
| The HTTP path for this review dismissed event. |
| Identifies the review associated with the |
| The HTTP URL for this review dismissed event. |
ReviewRequest
A request for a user to review a pull request.
ReviewRequest
Implements
Fields for ReviewRequest
Name | Description |
---|---|
| Whether this request was created for a code owner. |
| Identifies the primary key from the database. |
| N/A |
| Identifies the pull request associated with this review request. |
| The reviewer that is requested. |
ReviewRequestConnection
The connection type for ReviewRequest.
Fields for ReviewRequestConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReviewRequestEdge
An edge in a connection.
Fields for ReviewRequestEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ReviewRequestRemovedEvent
Represents anreview_request_removed
event on a given pull request.
ReviewRequestRemovedEvent
Implements
Fields for ReviewRequestRemovedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| PullRequest referenced by event. |
| Identifies the reviewer whose review request was removed. |
ReviewRequestedEvent
Represents anreview_requested
event on a given pull request.
ReviewRequestedEvent
Implements
Fields for ReviewRequestedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| PullRequest referenced by event. |
| Identifies the reviewer whose review was requested. |
ReviewStatusHovercardContext
A hovercard context with a message describing the current code review state of the pull request.
ReviewStatusHovercardContext
Implements
Fields for ReviewStatusHovercardContext
Name | Description |
---|---|
| A string describing this context. |
| An octicon to accompany this context. |
| The current status of the pull request with respect to code review. |
SavedReply
A Saved Reply is text a user can use to reply quickly.
SavedReply
Implements
Fields for SavedReply
Name | Description |
---|---|
| The body of the saved reply. |
| The saved reply body rendered to HTML. |
| Identifies the primary key from the database. |
| N/A |
| The title of the saved reply. |
| The user that saved this reply. |
SavedReplyConnection
The connection type for SavedReply.
Fields for SavedReplyConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SavedReplyEdge
An edge in a connection.
Fields for SavedReplyEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SearchResultItemConnection
A list of results that matched against a search query. Regardless of the number of matches, a maximum of 1,000 results will be available across all types, potentially split across many pages.
Fields for SearchResultItemConnection
Name | Description |
---|---|
| The total number of pieces of code that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| The total number of discussions that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| A list of edges. |
| The total number of issues that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| A list of nodes. |
| Information to aid in pagination. |
| The total number of repositories that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| The total number of users that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| The total number of wiki pages that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
SearchResultItemEdge
An edge in a connection.
Fields for SearchResultItemEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
| Text matches on the result found. |
SecurityAdvisory
A GitHub Security Advisory.
SecurityAdvisory
Implements
Fields for SecurityAdvisory
Name | Description |
---|---|
| The classification of the advisory. |
| The CVSS associated with this advisory. |
| CWEs associated with this Advisory. |
| Identifies the primary key from the database. |
| This is a long plaintext description of the advisory. |
| The GitHub Security Advisory ID. |
| N/A |
| A list of identifiers for this advisory. |
| The permalink for the advisory's dependabot alerts page. |
| The organization that originated the advisory. |
| The permalink for the advisory. |
| When the advisory was published. |
| A list of references for this advisory. |
| The severity of the advisory. |
| A short plaintext summary of the advisory. |
| When the advisory was last updated. |
| Vulnerabilities associated with this Advisory. Arguments for
|
| When the advisory was withdrawn, if it has been withdrawn. |
SecurityAdvisoryConnection
The connection type for SecurityAdvisory.
Fields for SecurityAdvisoryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SecurityAdvisoryEdge
An edge in a connection.
Fields for SecurityAdvisoryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SecurityAdvisoryIdentifier
A GitHub Security Advisory Identifier.
SecurityAdvisoryPackage
An individual package.
Fields for SecurityAdvisoryPackage
Name | Description |
---|---|
| The ecosystem the package belongs to, e.g. RUBYGEMS, NPM. |
| The package name. |
SecurityAdvisoryPackageVersion
An individual package version.
Fields for SecurityAdvisoryPackageVersion
Name | Description |
---|---|
| The package name or version. |
SecurityAdvisoryReference
A GitHub Security Advisory Reference.
Fields for SecurityAdvisoryReference
Name | Description |
---|---|
| A publicly accessible reference. |
SecurityVulnerability
An individual vulnerability within an Advisory.
Fields for SecurityVulnerability
Name | Description |
---|---|
| The Advisory associated with this Vulnerability. |
| The first version containing a fix for the vulnerability. |
| A description of the vulnerable package. |
| The severity of the vulnerability within this package. |
| When the vulnerability was last updated. |
| A string that describes the vulnerable package versions. This string follows a basic syntax with a few forms.
|
SecurityVulnerabilityConnection
The connection type for SecurityVulnerability.
Fields for SecurityVulnerabilityConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SecurityVulnerabilityEdge
An edge in a connection.
Fields for SecurityVulnerabilityEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SmimeSignature
Represents an S/MIME signature on a Commit or Tag.
SmimeSignature
Implements
Fields for SmimeSignature
Name | Description |
---|---|
| Email used to sign this object. |
| True if the signature is valid and verified by GitHub. |
| 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. |
SocialAccount
Social media profile associated with a user.
Fields for SocialAccount
Name | Description |
---|---|
| Name of the social media account as it appears on the profile. |
| Software or company that hosts the social media account. |
| URL of the social media account. |
SocialAccountConnection
The connection type for SocialAccount.
Fields for SocialAccountConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SocialAccountEdge
An edge in a connection.
Fields for SocialAccountEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SshSignature
Represents an SSH signature on a Commit or Tag.
SshSignature
Implements
Fields for SshSignature
Name | Description |
---|---|
| Email used to sign this object. |
| True if the signature is valid and verified by GitHub. |
| Hex-encoded fingerprint 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. |
StargazerConnection
The connection type for User.
Fields for StargazerConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
StargazerEdge
Represents a user that's starred a repository.
StarredRepositoryConnection
The connection type for Repository.
Fields for StarredRepositoryConnection
Name | Description |
---|---|
| A list of edges. |
| Is the list of stars for this user truncated? This is true for users that have many stars. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
StarredRepositoryEdge
Represents a starred repository.
Fields for StarredRepositoryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| N/A |
| Identifies when the item was starred. |
Status
Represents a commit status.
Status
Implements
Fields for Status
Name | Description |
---|---|
| A list of status contexts and check runs for this commit. Arguments for
|
| The commit this status is attached to. |
| Looks up an individual status context by context name. Arguments for
|
| The individual status contexts for this commit. |
| N/A |
| The combined commit status. |
StatusCheckConfiguration
Required status check.
StatusCheckRollup
Represents the rollup for both the check runs and status for a commit.
StatusCheckRollup
Implements
Fields for StatusCheckRollup
Name | Description |
---|---|
| The commit the status and check runs are attached to. |
| A list of status contexts and check runs for this commit. |
| N/A |
| The combined status for the commit. |
StatusCheckRollupContextConnection
The connection type for StatusCheckRollupContext.
Fields for StatusCheckRollupContextConnection
Name | Description |
---|---|
| The number of check runs in this rollup. |
| Counts of check runs by state. |
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| The number of status contexts in this rollup. |
| Counts of status contexts by state. |
| Identifies the total count of items in the connection. |
StatusCheckRollupContextEdge
An edge in a connection.
Fields for StatusCheckRollupContextEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
StatusContext
Represents an individual commit status context.
StatusContext
Implements
Fields for StatusContext
Name | Description |
---|---|
| The avatar of the OAuth application or the user that created the status. Arguments for
|
| This commit this status context is attached to. |
| The name of this status context. |
| Identifies the date and time when the object was created. |
| The actor who created this status context. |
| The description for this status context. |
| N/A |
| Whether this is required to pass before merging for a specific pull request. |
| The state of this status context. |
| The URL for this status context. |
StatusContextStateCount
Represents a count of the state of a status context.
Fields for StatusContextStateCount
Name | Description |
---|---|
| The number of statuses with this state. |
| The state of a status context. |
Submodule
A pointer to a repository at a specific revision embedded inside another repository.
Fields for Submodule
Name | Description |
---|---|
| The branch of the upstream submodule for tracking updates. |
| The git URL of the submodule repository. |
| The name of the submodule in .gitmodules. |
| The name of the submodule in .gitmodules (Base64-encoded). |
| The path in the superproject that this submodule is located in. |
| The path in the superproject that this submodule is located in (Base64-encoded). |
| The commit revision of the subproject repository being tracked by the submodule. |
SubmoduleConnection
The connection type for Submodule.
Fields for SubmoduleConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SubmoduleEdge
An edge in a connection.
SubscribedEvent
Represents asubscribed
event on a given Subscribable
.
SubscribedEvent
Implements
Fields for SubscribedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| Object referenced by event. |
SuggestedReviewer
A suggestion to review a pull request based on a user's commit history and review comments.
Tag
Represents a Git tag.
Tag
Implements
Fields for Tag
Name | Description |
---|---|
| An abbreviated version of the Git object ID. |
| The HTTP path for this Git object. |
| The HTTP URL for this Git object. |
| N/A |
| The Git tag message. |
| The Git tag name. |
| The Git object ID. |
| The Repository the Git object belongs to. |
| Details about the tag author. |
| The Git object the tag points to. |
TagNamePatternParameters
Parameters to be used for the tag_name_pattern rule.
Team
A team of users in an organization.
Team
Implements
Fields for Team
Name | Description |
---|---|
| A list of teams that are ancestors of this team. |
| A URL pointing to the team's avatar. Arguments for
|
| List of child teams belonging to this team. Arguments for
|
| The slug corresponding to the organization and team. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the team. |
| Find a team discussion by its number. Arguments for
|
| A list of team discussions. Arguments for
|
| The HTTP path for team discussions. |
| The HTTP URL for team discussions. |
| The HTTP path for editing this team. |
| The HTTP URL for editing this team. |
| N/A |
| A list of pending invitations for users to this team. Arguments for
|
| Get the status messages members of this entity have set that are either public or visible only to the organization. Arguments for
|
| A list of users who are members of this team. Arguments for
|
| The HTTP path for the team' members. |
| The HTTP URL for the team' members. |
| The name of the team. |
| The HTTP path creating a new team. |
| The HTTP URL creating a new team. |
| The notification setting that the team has set. |
| The organization that owns this team. |
| The parent team of the team. |
| The level of privacy the team has. |
| A list of repositories this team has access to. Arguments for
|
| The HTTP path for this team's repositories. |
| The HTTP URL for this team's repositories. |
| The HTTP path for this team. |
| What algorithm is used for review assignment for this team. Note
|
| True if review assignment is enabled for this team. Note
|
| How many team members are required for review assignment for this team. Note
|
| When assigning team members via delegation, whether the entire team should be notified as well. Note
|
| The slug corresponding to the team. |
| The HTTP path for this team's teams. |
| The HTTP URL for this team's teams. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this team. |
| Team is adminable by the viewer. |
| 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. |
TeamAddMemberAuditEntry
Audit log entry for a team.add_member event.
TeamAddMemberAuditEntry
Implements
Fields for TeamAddMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| Whether the team was mapped to an LDAP Group. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The team associated with the action. |
| The name of the team. |
| The HTTP path for this team. |
| The HTTP URL for this team. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
TeamAddRepositoryAuditEntry
Audit log entry for a team.add_repository event.
TeamAddRepositoryAuditEntry
Implements
Fields for TeamAddRepositoryAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| Whether the team was mapped to an LDAP Group. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The team associated with the action. |
| The name of the team. |
| The HTTP path for this team. |
| The HTTP URL for this team. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
TeamChangeParentTeamAuditEntry
Audit log entry for a team.change_parent_team event.
TeamChangeParentTeamAuditEntry
Implements
Fields for TeamChangeParentTeamAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| Whether the team was mapped to an LDAP Group. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The new parent team. |
| The name of the new parent team. |
| The name of the former parent team. |
| The HTTP path for the parent team. |
| The HTTP URL for the parent team. |
| The former parent team. |
| The HTTP path for the previous parent team. |
| The HTTP URL for the previous parent team. |
| The team associated with the action. |
| The name of the team. |
| The HTTP path for this team. |
| The HTTP URL for this team. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
TeamConnection
The connection type for Team.
Fields for TeamConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
TeamDiscussion
A team discussion.
TeamDiscussion
Implements
Fields for TeamDiscussion
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the discussion's team. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The body as Markdown. |
| The body rendered to HTML. |
| The body rendered to text. |
| Identifies the discussion body hash. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| A list of comments on this discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. Arguments for
|
| The HTTP path for discussion comments. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The HTTP URL for discussion comments. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| 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. |
| N/A |
| Check if this comment was edited and includes an edit with the creation data. |
| Whether or not the discussion is pinned. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| Whether or not the discussion is only visible to team members and org admins. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The moment the editor made the last edit. |
| Identifies the discussion within its team. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| 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 HTTP path for this discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The team that defines the context of this discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The title of the discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| A list of edits to this content. Arguments for
|
| Check if the current viewer can delete this object. |
| Whether or not the current viewer can pin this discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| Can user react to this subject. |
| 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. |
TeamDiscussionComment
A comment on a team discussion.
TeamDiscussionComment
Implements
Fields for TeamDiscussionComment
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the comment's team. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The body as Markdown. |
| The body rendered to HTML. |
| The body rendered to text. |
| The current version of the body content. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| 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 discussion this comment is about. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| The actor who edited the comment. |
| N/A |
| Check if this comment was edited and includes an edit with the creation data. |
| The moment the editor made the last edit. |
| Identifies the comment number. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| 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 HTTP path for this comment. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this comment. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC. |
| A list of edits to this content. Arguments for
|
| Check if the current viewer can delete 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. |
TeamDiscussionCommentConnection
The connection type for TeamDiscussionComment.
Fields for TeamDiscussionCommentConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
TeamDiscussionCommentEdge
An edge in a connection.
Fields for TeamDiscussionCommentEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
TeamDiscussionConnection
The connection type for TeamDiscussion.
Fields for TeamDiscussionConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
TeamDiscussionEdge
An edge in a connection.
Fields for TeamDiscussionEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
TeamEdge
An edge in a connection.
TeamMemberConnection
The connection type for User.
Fields for TeamMemberConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
TeamMemberEdge
Represents a user who is a member of a team.
Fields for TeamMemberEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The HTTP path to the organization's member access page. |
| The HTTP URL to the organization's member access page. |
| N/A |
| The role the member has on the team. |
TeamRemoveMemberAuditEntry
Audit log entry for a team.remove_member event.
TeamRemoveMemberAuditEntry
Implements
Fields for TeamRemoveMemberAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| Whether the team was mapped to an LDAP Group. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The team associated with the action. |
| The name of the team. |
| The HTTP path for this team. |
| The HTTP URL for this team. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
TeamRemoveRepositoryAuditEntry
Audit log entry for a team.remove_repository event.
TeamRemoveRepositoryAuditEntry
Implements
Fields for TeamRemoveRepositoryAuditEntry
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| N/A |
| Whether the team was mapped to an LDAP Group. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
| The team associated with the action. |
| The name of the team. |
| The HTTP path for this team. |
| The HTTP URL for this team. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
TeamRepositoryConnection
The connection type for Repository.
Fields for TeamRepositoryConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
TeamRepositoryEdge
Represents a team repository.
Fields for TeamRepositoryEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| N/A |
| The permission level the team has on the repository. |
TextMatch
A text match within a search result.
Fields for TextMatch
Name | Description |
---|---|
| The specific text fragment within the property matched on. |
| Highlights within the matched fragment. |
| The property matched on. |
TextMatchHighlight
Represents a single highlight in a search result match.
Topic
A topic aggregates entities that are related to a subject.
Topic
Implements
Fields for Topic
Name | Description |
---|---|
| N/A |
| The topic's name. |
| A list of related topics, including aliases of this topic, sorted with the most relevant first. Returns up to 10 Topics. Arguments for
|
| A list of repositories. Arguments for
|
| Returns a count of how many stargazers there are on this object. |
| A list of users who have starred this starrable. Arguments for
|
| Returns a boolean indicating whether the viewing user has starred this starrable. |
TransferredEvent
Represents atransferred
event on a given issue or pull request.
TransferredEvent
Implements
Fields for TransferredEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The repository this came from. |
| N/A |
| Identifies the issue associated with the event. |
Tree
Represents a Git tree.
Tree
Implements
Fields for Tree
Name | Description |
---|---|
| An abbreviated version of the Git object ID. |
| The HTTP path for this Git object. |
| The HTTP URL for this Git object. |
| A list of tree entries. |
| N/A |
| The Git object ID. |
| The Repository the Git object belongs to. |
TreeEntry
Represents a Git tree entry.
Fields for TreeEntry
Name | Description |
---|---|
| The extension of the file. |
| Whether or not this tree entry is generated. |
| The programming language this file is written in. |
| Number of lines in the file. |
| Entry file mode. |
| Entry file name. |
| Entry file name. (Base64-encoded). |
| Entry file object. |
| Entry file Git object ID. |
| The full path of the file. |
| The full path of the file. (Base64-encoded). |
| The Repository the tree entry belongs to. |
| Entry byte size. |
| If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule. |
| Entry file type. |
UnassignedEvent
Represents anunassigned
event on any assignable object.
UnassignedEvent
Implements
Fields for UnassignedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the assignable associated with the event. |
| Identifies the user or mannequin that was unassigned. |
| Identifies the date and time when the object was created. |
| N/A |
| Identifies the subject (user) who was unassigned. Warning
Assignees can now be mannequins. Use the |
UnknownSignature
Represents an unknown signature on a Commit or Tag.
UnknownSignature
Implements
Fields for UnknownSignature
Name | Description |
---|---|
| Email used to sign this object. |
| True if the signature is valid and verified by GitHub. |
| 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. |
UnlabeledEvent
Represents anunlabeled
event on a given issue or pull request.
UnlabeledEvent
Implements
Fields for UnlabeledEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| Identifies the label associated with the |
| Identifies the |
UnlockedEvent
Represents anunlocked
event on a given issue or pull request.
UnmarkedAsDuplicateEvent
Represents anunmarked_as_duplicate
event on a given issue or pull request.
UnmarkedAsDuplicateEvent
Implements
Fields for UnmarkedAsDuplicateEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| The authoritative issue or pull request which has been duplicated by another. |
| Identifies the date and time when the object was created. |
| The issue or pull request which has been marked as a duplicate of another. |
| N/A |
| Canonical and duplicate belong to different repositories. |
UnpinnedEvent
Represents anunpinned
event on a given issue or pull request.
UnsubscribedEvent
Represents anunsubscribed
event on a given Subscribable
.
UnsubscribedEvent
Implements
Fields for UnsubscribedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| N/A |
| Object referenced by event. |
UpdateParameters
Only allow users with bypass permission to update matching refs.
Fields for UpdateParameters
Name | Description |
---|---|
| Branch can pull changes from its upstream repository. |
User
A user is an individual's account on GitHub that owns repositories and can make new content.
User
Implements
Actor
Node
PackageOwner
ProfileOwner
ProjectOwner
ProjectV2Owner
ProjectV2Recent
RepositoryDiscussionAuthor
RepositoryDiscussionCommentAuthor
RepositoryOwner
UniformResourceLocatable
Fields for User
Name | Description |
---|---|
| Determine if this repository owner has any items that can be pinned to their profile. Arguments for
|
| A URL pointing to the user's public avatar. Arguments for
|
| The user's public profile bio. |
| The user's public profile bio as HTML. |
| Could this user receive email notifications, if the organization had notification restrictions enabled?. Arguments for
|
| A list of commit comments made by this user. Arguments for
|
| The user's public profile company. |
| The user's public profile company as HTML. |
| The collection of contributions this user has made to different repositories. Arguments for
|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The user's publicly visible profile email. |
| A list of enterprises that the user belongs to. Arguments for
|
| A list of users the given user is followed by. |
| A list of users the given user is following. |
| Find gist by repo name. Arguments for
|
| A list of gist comments made by this user. Arguments for
|
| A list of the Gists the user has created. Arguments for
|
| The hovercard information for this user in a given context. Arguments for
|
| N/A |
| Whether or not this user is a participant in the GitHub Security Bug Bounty. |
| Whether or not this user is a participant in the GitHub Campus Experts Program. |
| Whether or not this user is a GitHub Developer Program member. |
| Whether or not this user is a GitHub employee. |
| Whether or not this user is following the viewer. Inverse of viewerIsFollowing. |
| Whether or not this user is a member of the GitHub Stars Program. |
| Whether or not the user has marked themselves as for hire. |
| Whether or not this user is a site administrator. |
| Whether or not this user is the viewing user. |
| A list of issue comments made by this user. Arguments for
|
| A list of issues associated with this user. Arguments for
|
| Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity. |
| The user's public profile location. |
| The username used to login. |
| The user's public profile name. |
| Find an organization by its login that the user belongs to. Arguments for
|
| Verified email addresses that match verified domains for a specified organization the user is a member of. Arguments for
|
| A list of organizations the user belongs to. Arguments for
|
| A list of packages under the owner. Arguments for
|
| A list of repositories and gists this profile owner can pin to their profile. Arguments for
|
| A list of repositories and gists this profile owner has pinned to their profile. Arguments for
|
| Returns how many more items this profile owner can pin to their profile. |
| Find project by number. Arguments for
|
| Find a project by number. Arguments for
|
| A list of projects under the owner. Arguments for
|
| The HTTP path listing user's projects. |
| The HTTP URL listing user's projects. |
| A list of projects under the owner. Arguments for
|
| The user's profile pronouns. |
| A list of public keys associated with this user. Arguments for
|
| A list of pull requests associated with this user. Arguments for
|
| Recent projects that this user has modified in the context of the owner. Arguments for
|
| A list of repositories that the user owns. Arguments for
|
| A list of repositories that the user recently contributed to. Arguments for
|
| Find Repository. |
| Discussion comments this user has authored. Arguments for
|
| Discussions this user has started. Arguments for
|
| The HTTP path for this user. |
| Replies this user has saved. Arguments for
|
| The user's social media accounts, ordered as they appear on the user's profile. Arguments for
|
| Repositories the user has starred. Arguments for
|
| The user's description of what they're currently doing. |
| Identifies the date and time when the user was suspended. |
| Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created. Arguments for
|
| The user's Twitter username. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this user. |
| Can the viewer pin repositories and gists to the profile?. |
| Can the current viewer create new projects on this owner. |
| Whether or not the viewer is able to follow the user. |
| Whether or not this user is followed by the viewer. Inverse of isFollowingViewer. |
| A list of repositories the given user is watching. Arguments for
|
| A URL pointing to the user's public website/blog. |
UserBlockedEvent
Represents auser_blocked
event on a given user.
UserBlockedEvent
Implements
Fields for UserBlockedEvent
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Number of days that the user was blocked for. |
| Identifies the date and time when the object was created. |
| N/A |
| The user who was blocked. |
UserConnection
The connection type for User.
Fields for UserConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
UserContentEdit
An edit on user content.
UserContentEdit
Implements
Fields for UserContentEdit
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the date and time when the object was deleted. |
| The actor who deleted this content. |
| A summary of the changes for this edit. |
| When this content was edited. |
| The actor who edited this content. |
| N/A |
| Identifies the date and time when the object was last updated. |
UserContentEditConnection
A list of edits to content.
Fields for UserContentEditConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
UserContentEditEdge
An edge in a connection.
Fields for UserContentEditEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
UserEdge
Represents a user.
UserEmailMetadata
Email attributes from External Identity.
UserStatus
The user's description of what they're currently doing.
UserStatus
Implements
Fields for UserStatus
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| An emoji summarizing the user's status. |
| The status emoji as HTML. |
| If set, the status will not be shown after this date. |
| N/A |
| Whether this status indicates the user is not fully available on GitHub. |
| A brief message describing what the user is doing. |
| The organization whose members can see this status. If null, this status is publicly visible. |
| Identifies the date and time when the object was last updated. |
| The user who has this status. |
UserStatusConnection
The connection type for UserStatus.
Fields for UserStatusConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
UserStatusEdge
An edge in a connection.
Fields for UserStatusEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
VerifiableDomain
A domain that can be verified or approved for an organization or an enterprise.
VerifiableDomain
Implements
Fields for VerifiableDomain
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The DNS host name that should be used for verification. |
| The unicode encoded domain. |
| Whether a TXT record for verification with the expected host name was found. |
| Whether a TXT record for verification with the expected verification token was found. |
| N/A |
| Whether or not the domain is approved. |
| Whether this domain is required to exist for an organization or enterprise policy to be enforced. |
| Whether or not the domain is verified. |
| The owner of the domain. |
| The punycode encoded domain. |
| The time that the current verification token will expire. |
| Identifies the date and time when the object was last updated. |
| The current verification token for the domain. |
VerifiableDomainConnection
The connection type for VerifiableDomain.
Fields for VerifiableDomainConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
VerifiableDomainEdge
An edge in a connection.
Fields for VerifiableDomainEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ViewerHovercardContext
A hovercard context with a message describing how the viewer is related.
Workflow
A workflow contains meta information about an Actions workflow file.
Workflow
Implements
Fields for Workflow
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| N/A |
| The name of the workflow. |
| The HTTP path for this workflow. |
| The runs of the workflow. Arguments for
|
| The state of the workflow. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this workflow. |
WorkflowRun
A workflow run.
WorkflowRun
Implements
Fields for WorkflowRun
Name | Description |
---|---|
| The check suite this workflow run belongs to. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The log of deployment reviews. Arguments for
|
| The event that triggered the workflow run. |
| The workflow file. |
| N/A |
| The pending deployment requests of all check runs in this workflow run. Arguments for
|
| The HTTP path for this workflow run. |
| A number that uniquely identifies this workflow run in its parent workflow. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this workflow run. |
| The workflow executed in this workflow run. |
WorkflowRunConnection
The connection type for WorkflowRun.
Fields for WorkflowRunConnection
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
WorkflowRunEdge
An edge in a connection.
Fields for WorkflowRunEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
WorkflowRunFile
An executed workflow file for a workflow run.
WorkflowRunFile
Implements
Fields for WorkflowRunFile
Name | Description |
---|---|
| N/A |
| The path of the workflow file relative to its repository. |
| The direct link to the file in the repository which stores the workflow file. |
| The repository name and owner which stores the workflow file. |
| The HTTP path for this workflow run file. |
| The parent workflow run execution for this file. |
| The HTTP URL for this workflow run file. |
| If the viewer has permissions to push to the repository which stores the workflow. |
| If the viewer has permissions to read the repository which stores the workflow. |