About interfaces
Interfaces serve as parent objects from which other objects can inherit.
For example, Lockable
is an interface because both Issue
and PullRequest
objects can be locked. An interface has its own list of named fields that are shared by implementing objects.
For more information, see "Introduction to GraphQL."
Actor
Represents an object which can take actions on GitHub. Typically a User or Bot.
Actor
is implemented by
Fields for Actor
Name | Description |
---|---|
| A URL pointing to the actor's public avatar. Arguments for
|
| The username of the actor. |
| The HTTP path for this actor. |
| The HTTP URL for this actor. |
AnnouncementBannerI
Represents an announcement banner.
AnnouncementBannerI
is implemented by
Fields for AnnouncementBannerI
Name | Description |
---|---|
| The text of the announcement. |
| The date the announcement was created. |
| The expiration date of the announcement, if any. |
| Whether the announcement can be dismissed by the user. |
Assignable
An object that can have users assigned to it.
Assignable
is implemented by
Fields for Assignable
Name | Description |
---|---|
| A list of Users assigned to this object. |
AuditEntry
An entry in the audit log.
AuditEntry
is implemented by
MembersCanDeleteReposClearAuditEntry
MembersCanDeleteReposDisableAuditEntry
MembersCanDeleteReposEnableAuditEntry
OauthApplicationCreateAuditEntry
OrgAddBillingManagerAuditEntry
OrgAddMemberAuditEntry
OrgBlockUserAuditEntry
OrgConfigDisableCollaboratorsOnlyAuditEntry
OrgConfigEnableCollaboratorsOnlyAuditEntry
OrgCreateAuditEntry
OrgDisableOauthAppRestrictionsAuditEntry
OrgDisableSamlAuditEntry
OrgDisableTwoFactorRequirementAuditEntry
OrgEnableOauthAppRestrictionsAuditEntry
OrgEnableSamlAuditEntry
OrgEnableTwoFactorRequirementAuditEntry
OrgInviteMemberAuditEntry
OrgInviteToBusinessAuditEntry
OrgOauthAppAccessApprovedAuditEntry
OrgOauthAppAccessBlockedAuditEntry
OrgOauthAppAccessDeniedAuditEntry
OrgOauthAppAccessRequestedAuditEntry
OrgOauthAppAccessUnblockedAuditEntry
OrgRemoveBillingManagerAuditEntry
OrgRemoveMemberAuditEntry
OrgRemoveOutsideCollaboratorAuditEntry
OrgRestoreMemberAuditEntry
OrgUnblockUserAuditEntry
OrgUpdateDefaultRepositoryPermissionAuditEntry
OrgUpdateMemberAuditEntry
OrgUpdateMemberRepositoryCreationPermissionAuditEntry
OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
PrivateRepositoryForkingDisableAuditEntry
PrivateRepositoryForkingEnableAuditEntry
RepoAccessAuditEntry
RepoAddMemberAuditEntry
RepoAddTopicAuditEntry
RepoArchivedAuditEntry
RepoChangeMergeSettingAuditEntry
RepoConfigDisableAnonymousGitAccessAuditEntry
RepoConfigDisableCollaboratorsOnlyAuditEntry
RepoConfigDisableContributorsOnlyAuditEntry
RepoConfigDisableSockpuppetDisallowedAuditEntry
RepoConfigEnableAnonymousGitAccessAuditEntry
RepoConfigEnableCollaboratorsOnlyAuditEntry
RepoConfigEnableContributorsOnlyAuditEntry
RepoConfigEnableSockpuppetDisallowedAuditEntry
RepoConfigLockAnonymousGitAccessAuditEntry
RepoConfigUnlockAnonymousGitAccessAuditEntry
RepoCreateAuditEntry
RepoDestroyAuditEntry
RepoRemoveMemberAuditEntry
RepoRemoveTopicAuditEntry
RepositoryVisibilityChangeDisableAuditEntry
RepositoryVisibilityChangeEnableAuditEntry
TeamAddMemberAuditEntry
TeamAddRepositoryAuditEntry
TeamChangeParentTeamAuditEntry
TeamRemoveMemberAuditEntry
TeamRemoveRepositoryAuditEntry
Fields for AuditEntry
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 corresponding operation type for the action. |
| 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. |
Closable
An object that can be closed.
Closable
is implemented by
Fields for Closable
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. |
| Indicates if the object can be closed by the viewer. |
| Indicates if the object can be reopened by the viewer. |
Comment
Represents a comment.
Comment
is implemented by
CommitComment
Discussion
DiscussionComment
GistComment
Issue
IssueComment
PullRequest
PullRequestReview
PullRequestReviewComment
TeamDiscussion
TeamDiscussionComment
Fields for Comment
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. |
| The actor who edited the comment. |
| The Node ID of the Comment object. |
| Check if this comment was edited and includes an edit with the creation data. |
| The moment the editor made the last edit. |
| Identifies when the comment was published at. |
| Identifies the date and time when the object was last updated. |
| A list of edits to this content. Arguments for
|
| Did the viewer author this comment. |
Contribution
Represents a contribution a user made on GitHub, such as opening an issue.
Contribution
is implemented by
CreatedCommitContribution
CreatedIssueContribution
CreatedPullRequestContribution
CreatedPullRequestReviewContribution
CreatedRepositoryContribution
JoinedGitHubContribution
RestrictedContribution
Fields for Contribution
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. |
Deletable
Entities that can be deleted.
Deletable
is implemented by
CommitComment
Discussion
DiscussionComment
GistComment
Issue
IssueComment
PullRequestReview
PullRequestReviewComment
TeamDiscussion
TeamDiscussionComment
Fields for Deletable
Name | Description |
---|---|
| Check if the current viewer can delete this object. |
EnterpriseAuditEntryData
Metadata for an audit entry containing enterprise account information.
EnterpriseAuditEntryData
is implemented by
MembersCanDeleteReposClearAuditEntry
MembersCanDeleteReposDisableAuditEntry
MembersCanDeleteReposEnableAuditEntry
OrgInviteToBusinessAuditEntry
PrivateRepositoryForkingDisableAuditEntry
PrivateRepositoryForkingEnableAuditEntry
RepositoryVisibilityChangeDisableAuditEntry
RepositoryVisibilityChangeEnableAuditEntry
Fields for EnterpriseAuditEntryData
Name | Description |
---|---|
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
GitObject
Represents a Git object.
GitObject
is implemented by
Fields for GitObject
Name | Description |
---|---|
| An abbreviated version of the Git object ID. |
| The HTTP path for this Git object. |
| The HTTP URL for this Git object. |
| The Node ID of the GitObject object. |
| The Git object ID. |
| The Repository the Git object belongs to. |
GitSignature
Information about a signature (GPG or S/MIME) on a Commit or Tag.
GitSignature
is implemented by
Fields for GitSignature
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. |
| The date the signature was verified, if valid. |
| True if the signature was made with GitHub's signing key. |
HovercardContext
An individual line of a hovercard.
HovercardContext
is implemented by
GenericHovercardContext
OrganizationTeamsHovercardContext
OrganizationsHovercardContext
ReviewStatusHovercardContext
ViewerHovercardContext
Fields for HovercardContext
Name | Description |
---|---|
| A string describing this context. |
| An octicon to accompany this context. |
Labelable
An object that can have labels assigned to it.
Labelable
is implemented by
Fields for Labelable
Name | Description |
---|---|
| A list of labels associated with the object. Arguments for
|
| Indicates if the viewer can edit labels for this object. |
Lockable
An object that can be locked.
Lockable
is implemented by
Fields for Lockable
Name | Description |
---|---|
| Reason that the conversation was locked. |
|
|
MemberStatusable
Entities that have members who can set status messages.
MemberStatusable
is implemented by
Fields for MemberStatusable
Name | Description |
---|---|
| Get the status messages members of this entity have set that are either public or visible only to the organization. Arguments for
|
Migration
Represents a GitHub Enterprise Importer (GEI) migration.
Migration
is implemented by
Fields for Migration
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. |
| The Node ID of the Migration object. |
| 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. |
Minimizable
Entities that can be minimized.
Minimizable
is implemented by
Fields for Minimizable
Name | Description |
---|---|
| Returns whether or not a comment has been minimized. |
| Returns why the comment was minimized. One of |
| Check if the current viewer can minimize this object. |
Node
An object with an ID.
Node
is implemented by
AddedToMergeQueueEvent
AddedToProjectEvent
App
AssignedEvent
AutoMergeDisabledEvent
AutoMergeEnabledEvent
AutoRebaseEnabledEvent
AutoSquashEnabledEvent
AutomaticBaseChangeFailedEvent
AutomaticBaseChangeSucceededEvent
BaseRefChangedEvent
BaseRefDeletedEvent
BaseRefForcePushedEvent
Blob
Bot
BranchProtectionRule
BypassForcePushAllowance
BypassPullRequestAllowance
CWE
CheckRun
CheckSuite
ClosedEvent
CodeOfConduct
CommentDeletedEvent
Commit
CommitComment
CommitCommentThread
Comparison
ConnectedEvent
ConvertToDraftEvent
ConvertedNoteToIssueEvent
ConvertedToDiscussionEvent
CrossReferencedEvent
DemilestonedEvent
DependencyGraphManifest
DeployKey
DeployedEvent
Deployment
DeploymentEnvironmentChangedEvent
DeploymentReview
DeploymentStatus
DisconnectedEvent
Discussion
DiscussionCategory
DiscussionComment
DiscussionPoll
DiscussionPollOption
DraftIssue
Enterprise
EnterpriseAdministratorInvitation
EnterpriseIdentityProvider
EnterpriseMemberInvitation
EnterpriseRepositoryInfo
EnterpriseServerInstallation
EnterpriseServerUserAccount
EnterpriseServerUserAccountEmail
EnterpriseServerUserAccountsUpload
EnterpriseUserAccount
Environment
ExternalIdentity
Gist
GistComment
HeadRefDeletedEvent
HeadRefForcePushedEvent
HeadRefRestoredEvent
IpAllowListEntry
Issue
IssueComment
Label
LabeledEvent
Language
License
LinkedBranch
LockedEvent
Mannequin
MarkedAsDuplicateEvent
MarketplaceCategory
MarketplaceListing
MemberFeatureRequestNotification
MembersCanDeleteReposClearAuditEntry
MembersCanDeleteReposDisableAuditEntry
MembersCanDeleteReposEnableAuditEntry
MentionedEvent
MergeQueue
MergeQueueEntry
MergedEvent
MigrationSource
Milestone
MilestonedEvent
MovedColumnsInProjectEvent
OIDCProvider
OauthApplicationCreateAuditEntry
OrgAddBillingManagerAuditEntry
OrgAddMemberAuditEntry
OrgBlockUserAuditEntry
OrgConfigDisableCollaboratorsOnlyAuditEntry
OrgConfigEnableCollaboratorsOnlyAuditEntry
OrgCreateAuditEntry
OrgDisableOauthAppRestrictionsAuditEntry
OrgDisableSamlAuditEntry
OrgDisableTwoFactorRequirementAuditEntry
OrgEnableOauthAppRestrictionsAuditEntry
OrgEnableSamlAuditEntry
OrgEnableTwoFactorRequirementAuditEntry
OrgInviteMemberAuditEntry
OrgInviteToBusinessAuditEntry
OrgOauthAppAccessApprovedAuditEntry
OrgOauthAppAccessBlockedAuditEntry
OrgOauthAppAccessDeniedAuditEntry
OrgOauthAppAccessRequestedAuditEntry
OrgOauthAppAccessUnblockedAuditEntry
OrgRemoveBillingManagerAuditEntry
OrgRemoveMemberAuditEntry
OrgRemoveOutsideCollaboratorAuditEntry
OrgRestoreMemberAuditEntry
OrgUnblockUserAuditEntry
OrgUpdateDefaultRepositoryPermissionAuditEntry
OrgUpdateMemberAuditEntry
OrgUpdateMemberRepositoryCreationPermissionAuditEntry
OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
Organization
OrganizationIdentityProvider
OrganizationInvitation
OrganizationMigration
Package
PackageFile
PackageTag
PackageVersion
PinnedDiscussion
PinnedEnvironment
PinnedEvent
PinnedIssue
PrivateRepositoryForkingDisableAuditEntry
PrivateRepositoryForkingEnableAuditEntry
Project
ProjectCard
ProjectColumn
ProjectV2
ProjectV2Field
ProjectV2Item
ProjectV2ItemFieldDateValue
ProjectV2ItemFieldIterationValue
ProjectV2ItemFieldNumberValue
ProjectV2ItemFieldSingleSelectValue
ProjectV2ItemFieldTextValue
ProjectV2IterationField
ProjectV2SingleSelectField
ProjectV2StatusUpdate
ProjectV2View
ProjectV2Workflow
PublicKey
PullRequest
PullRequestCommit
PullRequestCommitCommentThread
PullRequestReview
PullRequestReviewComment
PullRequestReviewThread
PullRequestThread
Push
PushAllowance
Reaction
ReadyForReviewEvent
Ref
ReferencedEvent
Release
ReleaseAsset
RemovedFromMergeQueueEvent
RemovedFromProjectEvent
RenamedTitleEvent
ReopenedEvent
RepoAccessAuditEntry
RepoAddMemberAuditEntry
RepoAddTopicAuditEntry
RepoArchivedAuditEntry
RepoChangeMergeSettingAuditEntry
RepoConfigDisableAnonymousGitAccessAuditEntry
RepoConfigDisableCollaboratorsOnlyAuditEntry
RepoConfigDisableContributorsOnlyAuditEntry
RepoConfigDisableSockpuppetDisallowedAuditEntry
RepoConfigEnableAnonymousGitAccessAuditEntry
RepoConfigEnableCollaboratorsOnlyAuditEntry
RepoConfigEnableContributorsOnlyAuditEntry
RepoConfigEnableSockpuppetDisallowedAuditEntry
RepoConfigLockAnonymousGitAccessAuditEntry
RepoConfigUnlockAnonymousGitAccessAuditEntry
RepoCreateAuditEntry
RepoDestroyAuditEntry
RepoRemoveMemberAuditEntry
RepoRemoveTopicAuditEntry
Repository
RepositoryInvitation
RepositoryMigration
RepositoryRule
RepositoryRuleset
RepositoryRulesetBypassActor
RepositoryTopic
RepositoryVisibilityChangeDisableAuditEntry
RepositoryVisibilityChangeEnableAuditEntry
RepositoryVulnerabilityAlert
ReviewDismissalAllowance
ReviewDismissedEvent
ReviewRequest
ReviewRequestRemovedEvent
ReviewRequestedEvent
SavedReply
SecurityAdvisory
SponsorsActivity
SponsorsListing
SponsorsListingFeaturedItem
SponsorsTier
Sponsorship
SponsorshipNewsletter
Status
StatusCheckRollup
StatusContext
SubscribedEvent
Tag
Team
TeamAddMemberAuditEntry
TeamAddRepositoryAuditEntry
TeamChangeParentTeamAuditEntry
TeamDiscussion
TeamDiscussionComment
TeamRemoveMemberAuditEntry
TeamRemoveRepositoryAuditEntry
Topic
TransferredEvent
Tree
UnassignedEvent
UnlabeledEvent
UnlockedEvent
UnmarkedAsDuplicateEvent
UnpinnedEvent
UnsubscribedEvent
User
UserBlockedEvent
UserContentEdit
UserList
UserStatus
VerifiableDomain
Workflow
WorkflowRun
WorkflowRunFile
Fields for Node
Name | Description |
---|---|
| ID of the object. |
OauthApplicationAuditEntryData
Metadata for an audit entry with action oauth_application.*.
OauthApplicationAuditEntryData
is implemented by
OauthApplicationCreateAuditEntry
OrgOauthAppAccessApprovedAuditEntry
OrgOauthAppAccessBlockedAuditEntry
OrgOauthAppAccessDeniedAuditEntry
OrgOauthAppAccessRequestedAuditEntry
OrgOauthAppAccessUnblockedAuditEntry
Fields for OauthApplicationAuditEntryData
Name | Description |
---|---|
| The name of the OAuth application. |
| The HTTP path for the OAuth application. |
| The HTTP URL for the OAuth application. |
OrganizationAuditEntryData
Metadata for an audit entry with action org.*.
OrganizationAuditEntryData
is implemented by
MembersCanDeleteReposClearAuditEntry
MembersCanDeleteReposDisableAuditEntry
MembersCanDeleteReposEnableAuditEntry
OauthApplicationCreateAuditEntry
OrgAddBillingManagerAuditEntry
OrgAddMemberAuditEntry
OrgBlockUserAuditEntry
OrgConfigDisableCollaboratorsOnlyAuditEntry
OrgConfigEnableCollaboratorsOnlyAuditEntry
OrgCreateAuditEntry
OrgDisableOauthAppRestrictionsAuditEntry
OrgDisableSamlAuditEntry
OrgDisableTwoFactorRequirementAuditEntry
OrgEnableOauthAppRestrictionsAuditEntry
OrgEnableSamlAuditEntry
OrgEnableTwoFactorRequirementAuditEntry
OrgInviteMemberAuditEntry
OrgInviteToBusinessAuditEntry
OrgOauthAppAccessApprovedAuditEntry
OrgOauthAppAccessBlockedAuditEntry
OrgOauthAppAccessDeniedAuditEntry
OrgOauthAppAccessRequestedAuditEntry
OrgOauthAppAccessUnblockedAuditEntry
OrgRemoveBillingManagerAuditEntry
OrgRemoveMemberAuditEntry
OrgRemoveOutsideCollaboratorAuditEntry
OrgRestoreMemberAuditEntry
OrgRestoreMemberMembershipOrganizationAuditEntryData
OrgUnblockUserAuditEntry
OrgUpdateDefaultRepositoryPermissionAuditEntry
OrgUpdateMemberAuditEntry
OrgUpdateMemberRepositoryCreationPermissionAuditEntry
OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
PrivateRepositoryForkingDisableAuditEntry
PrivateRepositoryForkingEnableAuditEntry
RepoAccessAuditEntry
RepoAddMemberAuditEntry
RepoAddTopicAuditEntry
RepoArchivedAuditEntry
RepoChangeMergeSettingAuditEntry
RepoConfigDisableAnonymousGitAccessAuditEntry
RepoConfigDisableCollaboratorsOnlyAuditEntry
RepoConfigDisableContributorsOnlyAuditEntry
RepoConfigDisableSockpuppetDisallowedAuditEntry
RepoConfigEnableAnonymousGitAccessAuditEntry
RepoConfigEnableCollaboratorsOnlyAuditEntry
RepoConfigEnableContributorsOnlyAuditEntry
RepoConfigEnableSockpuppetDisallowedAuditEntry
RepoConfigLockAnonymousGitAccessAuditEntry
RepoConfigUnlockAnonymousGitAccessAuditEntry
RepoCreateAuditEntry
RepoDestroyAuditEntry
RepoRemoveMemberAuditEntry
RepoRemoveTopicAuditEntry
RepositoryVisibilityChangeDisableAuditEntry
RepositoryVisibilityChangeEnableAuditEntry
TeamAddMemberAuditEntry
TeamAddRepositoryAuditEntry
TeamChangeParentTeamAuditEntry
TeamRemoveMemberAuditEntry
TeamRemoveRepositoryAuditEntry
Fields for OrganizationAuditEntryData
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. |
PackageOwner
Represents an owner of a package.
PackageOwner
is implemented by
Fields for PackageOwner
Name | Description |
---|---|
| The Node ID of the PackageOwner object. |
| A list of packages under the owner. Arguments for
|
ProfileOwner
Represents any entity on GitHub that has a profile page.
ProfileOwner
is implemented by
Fields for ProfileOwner
Name | Description |
---|---|
| Determine if this repository owner has any items that can be pinned to their profile. Arguments for
|
| The public profile email. |
| The Node ID of the ProfileOwner object. |
| Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity. |
| The public profile location. |
| The username used to login. |
| The public profile name. |
| 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. |
| Can the viewer pin repositories and gists to the profile?. |
| The public profile website URL. |
ProjectOwner
Represents an owner of a Project.
ProjectOwner
is implemented by
Fields for ProjectOwner
Name | Description |
---|---|
| The Node ID of the ProjectOwner object. |
| Find project by number. Arguments for
|
| A list of projects under the owner. Arguments for
|
| The HTTP path listing owners projects. |
| The HTTP URL listing owners projects. |
| Can the current viewer create new projects on this owner. |
ProjectV2FieldCommon
Common fields across different project field types.
ProjectV2FieldCommon
is implemented by
Fields for ProjectV2FieldCommon
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The field's type. |
| Identifies the primary key from the database. |
| The Node ID of the ProjectV2FieldCommon object. |
| The project field's name. |
| The project that contains this field. |
| Identifies the date and time when the object was last updated. |
ProjectV2ItemFieldValueCommon
Common fields across different project field value types.
ProjectV2ItemFieldValueCommon
is implemented by
ProjectV2ItemFieldDateValue
ProjectV2ItemFieldIterationValue
ProjectV2ItemFieldNumberValue
ProjectV2ItemFieldSingleSelectValue
ProjectV2ItemFieldTextValue
Fields for ProjectV2ItemFieldValueCommon
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. |
| The Node ID of the ProjectV2ItemFieldValueCommon object. |
| The project item that contains this value. |
| Identifies the date and time when the object was last updated. |
ProjectV2Owner
Represents an owner of a project.
ProjectV2Owner
is implemented by
Fields for ProjectV2Owner
Name | Description |
---|---|
| The Node ID of the ProjectV2Owner object. |
| Find a project by number. Arguments for
|
| A list of projects under the owner. Arguments for
|
ProjectV2Recent
Recent projects for the owner.
ProjectV2Recent
is implemented by
Fields for ProjectV2Recent
Name | Description |
---|---|
| Recent projects that this user has modified in the context of the owner. Arguments for
|
Reactable
Represents a subject that can be reacted on.
Reactable
is implemented by
CommitComment
Discussion
DiscussionComment
Issue
IssueComment
PullRequest
PullRequestReview
PullRequestReviewComment
Release
TeamDiscussion
TeamDiscussionComment
Fields for Reactable
Name | Description |
---|---|
| Identifies the primary key from the database. |
| The Node ID of the Reactable object. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments for
|
| Can user react to this subject. |
RepositoryAuditEntryData
Metadata for an audit entry with action repo.*.
RepositoryAuditEntryData
is implemented by
OrgRestoreMemberMembershipRepositoryAuditEntryData
PrivateRepositoryForkingDisableAuditEntry
PrivateRepositoryForkingEnableAuditEntry
RepoAccessAuditEntry
RepoAddMemberAuditEntry
RepoAddTopicAuditEntry
RepoArchivedAuditEntry
RepoChangeMergeSettingAuditEntry
RepoConfigDisableAnonymousGitAccessAuditEntry
RepoConfigDisableCollaboratorsOnlyAuditEntry
RepoConfigDisableContributorsOnlyAuditEntry
RepoConfigDisableSockpuppetDisallowedAuditEntry
RepoConfigEnableAnonymousGitAccessAuditEntry
RepoConfigEnableCollaboratorsOnlyAuditEntry
RepoConfigEnableContributorsOnlyAuditEntry
RepoConfigEnableSockpuppetDisallowedAuditEntry
RepoConfigLockAnonymousGitAccessAuditEntry
RepoConfigUnlockAnonymousGitAccessAuditEntry
RepoCreateAuditEntry
RepoDestroyAuditEntry
RepoRemoveMemberAuditEntry
RepoRemoveTopicAuditEntry
TeamAddRepositoryAuditEntry
TeamRemoveRepositoryAuditEntry
Fields for RepositoryAuditEntryData
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. |
RepositoryDiscussionAuthor
Represents an author of discussions in repositories.
RepositoryDiscussionAuthor
is implemented by
Fields for RepositoryDiscussionAuthor
Name | Description |
---|---|
| Discussions this user has started. Arguments for
|
RepositoryDiscussionCommentAuthor
Represents an author of discussion comments in repositories.
RepositoryDiscussionCommentAuthor
is implemented by
Fields for RepositoryDiscussionCommentAuthor
Name | Description |
---|---|
| Discussion comments this user has authored. Arguments for
|
RepositoryInfo
A subset of repository info.
RepositoryInfo
is implemented by
Fields for RepositoryInfo
Name | Description |
---|---|
| Identifies the date and time when the repository was archived. |
| Identifies the date and time when the object was created. |
| The description of the repository. |
| The description of the repository rendered to HTML. |
| Returns how many forks there are of this repository in the whole network. |
| Indicates if the repository has the Discussions feature enabled. |
| Indicates if the repository has issues feature enabled. |
| Indicates if the repository has the Projects feature enabled. |
| Indicates if the repository displays a Sponsor button for financial contributions. |
| Indicates if the repository has wiki feature enabled. |
| The repository's URL. |
| Indicates if the repository is unmaintained. |
| Identifies if the repository is a fork. |
| Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. |
| Indicates if the repository has been locked or not. |
| Identifies if the repository is a mirror. |
| Identifies if the repository is private or internal. |
| Identifies if the repository is a template that can be used to generate new repositories. |
| The license associated with the repository. |
| The reason the repository has been locked. |
| The repository's original mirror URL. |
| The name of the repository. |
| The repository's name with owner. |
| The image used to represent this repository in Open Graph data. |
| The User owner of the repository. |
| Identifies the date and time when the repository was last pushed to. |
| The HTTP path for this repository. |
| A description of the repository, rendered to HTML without any links in it. Arguments for
|
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this repository. |
| Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. |
| Indicates the repository's visibility level. |
RepositoryNode
Represents a object that belongs to a repository.
RepositoryNode
is implemented by
CommitComment
CommitCommentThread
DependabotUpdate
Discussion
DiscussionCategory
Issue
IssueComment
PinnedDiscussion
PullRequest
PullRequestCommitCommentThread
PullRequestReview
PullRequestReviewComment
RepositoryVulnerabilityAlert
Fields for RepositoryNode
Name | Description |
---|---|
| The repository associated with this node. |
RepositoryOwner
Represents an owner of a Repository.
RepositoryOwner
is implemented by
Fields for RepositoryOwner
Name | Description |
---|---|
| A URL pointing to the owner's public avatar. Arguments for
|
| The Node ID of the RepositoryOwner object. |
| The username used to login. |
| A list of repositories that the user owns. Arguments for
|
| Find Repository. |
| The HTTP URL for the owner. |
| The HTTP URL for the owner. |
RequirableByPullRequest
Represents a type that can be required by a pull request for merging.
RequirableByPullRequest
is implemented by
Fields for RequirableByPullRequest
Name | Description |
---|---|
| Whether this is required to pass before merging for a specific pull request. |
Sponsorable
Entities that can sponsor or be sponsored through GitHub Sponsors.
Sponsorable
is implemented by
Fields for Sponsorable
Name | Description |
---|---|
| The estimated next GitHub Sponsors payout for this user/organization in cents (USD). |
| True if this user/organization has a GitHub Sponsors listing. |
| Whether the given account is sponsoring this user/organization. Arguments for
|
| True if the viewer is sponsored by this user/organization. |
| Calculate how much each sponsor has ever paid total to this maintainer via GitHub Sponsors. Does not include sponsorships paid via Patreon. Arguments for
|
| The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). |
| List of users and organizations this entity is sponsoring. Arguments for
|
| List of sponsors for this user or organization. Arguments for
|
| Events involving this sponsorable, such as new sponsorships. Arguments for
|
| The GitHub Sponsors listing for this user or organization. |
| The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor. Arguments for
|
| The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving. Arguments for
|
| List of sponsorship updates sent from this sponsorable to sponsors. Arguments for
|
| The sponsorships where this user or organization is the maintainer receiving the funds. Arguments for
|
| The sponsorships where this user or organization is the funder. Arguments for
|
| The amount in United States cents (e.g., 500 = $5.00 USD) that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. Arguments for
|
| Whether or not the viewer is able to sponsor this user/organization. |
| True if the viewer is sponsoring this user/organization. |
Starrable
Things that can be starred.
Starrable
is implemented by
Fields for Starrable
Name | Description |
---|---|
| The Node ID of the Starrable object. |
| Returns a count of how many stargazers there are on this object. |
| A list of users who have starred this starrable. Arguments for
|
| Returns a boolean indicating whether the viewing user has starred this starrable. |
Subscribable
Entities that can be subscribed to for web and email notifications.
Subscribable
is implemented by
Fields for Subscribable
Name | Description |
---|---|
| The Node ID of the Subscribable object. |
| Check if the viewer is able to change their subscription status for the repository. |
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
SubscribableThread
Entities that can be subscribed to for web and email notifications.
SubscribableThread
is implemented by
Fields for SubscribableThread
Name | Description |
---|---|
| The Node ID of the SubscribableThread object. |
| Identifies the viewer's thread subscription form action. |
| Identifies the viewer's thread subscription status. |
TeamAuditEntryData
Metadata for an audit entry with action team.*.
TeamAuditEntryData
is implemented by
OrgRestoreMemberMembershipTeamAuditEntryData
TeamAddMemberAuditEntry
TeamAddRepositoryAuditEntry
TeamChangeParentTeamAuditEntry
TeamRemoveMemberAuditEntry
TeamRemoveRepositoryAuditEntry
Fields for TeamAuditEntryData
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. |
TopicAuditEntryData
Metadata for an audit entry with a topic.
UniformResourceLocatable
Represents a type that can be retrieved by a URL.
UniformResourceLocatable
is implemented by
Bot
CheckRun
ClosedEvent
Commit
ConvertToDraftEvent
CrossReferencedEvent
Gist
Issue
Mannequin
MergedEvent
Milestone
Organization
PullRequest
PullRequestCommit
ReadyForReviewEvent
Release
Repository
RepositoryTopic
ReviewDismissedEvent
TeamDiscussion
TeamDiscussionComment
User
Workflow
WorkflowRun
WorkflowRunFile
Fields for UniformResourceLocatable
Name | Description |
---|---|
| The HTML path to this resource. |
| The URL to this resource. |
Updatable
Entities that can be updated.
Updatable
is implemented by
CommitComment
Discussion
DiscussionComment
GistComment
Issue
IssueComment
Project
ProjectV2
PullRequest
PullRequestReview
PullRequestReviewComment
TeamDiscussion
TeamDiscussionComment
Fields for Updatable
Name | Description |
---|---|
| Check if the current viewer can update this object. |
UpdatableComment
Comments that can be updated.
UpdatableComment
is implemented by
CommitComment
DiscussionComment
GistComment
Issue
IssueComment
PullRequest
PullRequestReview
PullRequestReviewComment
TeamDiscussion
TeamDiscussionComment
Fields for UpdatableComment
Name | Description |
---|---|
| Reasons why the current viewer can not update this comment. |
Votable
A subject that may be upvoted.
Votable
is implemented by
Fields for Votable
Name | Description |
---|---|
| Number of upvotes that this subject has received. |
| Whether or not the current user can add or remove an upvote on this subject. |
| Whether or not the current user has already upvoted this subject. |