Github API - Test Config

ReferencedEvent [object]

Represents a 'referenced' event on a given ReferencedSubject.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Attributes
actor Actor

Actor [interface]

Represents an object which can take actions on GitHub. Typically a User or Bot.

Attributes
avatarUrl URI

A URL pointing to the actor's public avatar.

login String

The username of the actor.

resourcePath URI

The HTTP path for this actor.

url URI

The HTTP URL for this actor.

API:
Github GraphQL API

Identifies the actor who performed the event.

commit Commit

Commit [object]

Represents a Git commit.

Implements
GitObjectNodeSubscribableUniformResourceLocatable
Attributes
abbreviatedOid String

An abbreviated version of the Git object ID

additions Int

The number of additions in this commit.

associatedPullRequests PullRequestConnection

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

author GitActor

Authorship details of the commit.

authoredByCommitter Boolean

Check if the committer and the author match.

authoredDate DateTime

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.

blame Blame

Fetches git blame information.

changedFiles Int

We recommend using the changedFilesIfAvailable field instead of
changedFiles, as changedFiles will cause your request to return an error
if GitHub is unable to calculate the number of changed files.

Deprecated: `changedFiles` will be removed. Use `changedFilesIfAvailable` instead. Removal on 2023-01-01 UTC.
changedFilesIfAvailable Int

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
null. We recommend using this field instead of changedFiles.

checkSuites CheckSuiteConnection

The check suites associated with a commit.

Comments made on the commit.

commitResourcePath URI

The HTTP path for this Git object

commitUrl URI

The HTTP URL for this Git object

committedDate DateTime

The datetime when this commit was committed.

committedViaWeb Boolean

Check if committed via GitHub web UI.

committer GitActor

Committer details of the commit.

deletions Int

The number of deletions in this commit.

deployments DeploymentConnection

The deployments associated with a commit.

file TreeEntry

The tree entry representing the file located at the given path.

The linear commit history starting from (and including) this commit, in the same order as git log.

id ID

The Node ID of the Commit object

message String

The Git commit message

messageBody String

The Git commit message body

messageBodyHTML HTML

The commit message body rendered to HTML.

messageHeadline String

The Git commit message headline

messageHeadlineHTML HTML

The commit message headline rendered to HTML.

The Git object ID

onBehalfOf Organization

The organization this commit was made on behalf of.

The parents of a commit.

pushedDate DateTime

The datetime when this commit was pushed.

Deprecated: `pushedDate` is no longer supported. Removal on 2023-07-01 UTC.
repository Repository

The Repository this commit belongs to

resourcePath URI

The HTTP path for this commit

signature GitSignature

Commit signing information, if present.

status Status

Status information for this commit

statusCheckRollup StatusCheckRollup

Check and Status rollup information for this commit.

submodules SubmoduleConnection

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

tarballUrl URI

Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.

tree Tree

Commit's root Tree

treeResourcePath URI

The HTTP path for the tree of this commit

treeUrl URI

The HTTP URL for the tree of this commit

url URI

The HTTP URL for this commit

viewerCanSubscribe Boolean

Check if the viewer is able to change their subscription status for the repository.

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

zipballUrl URI

Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.

API:
Github GraphQL API

Identifies the commit associated with the 'referenced' event.

commitRepository Repository

Repository [object]

A repository contains the content for a project.

Implements
NodePackageOwnerProjectOwnerProjectV2RecentRepositoryInfoStarrableSubscribableUniformResourceLocatable
Attributes
allowUpdateBranch Boolean

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.

archivedAt DateTime

Identifies the date and time when the repository was archived.

assignableUsers UserConnection

A list of users that can be assigned to issues in this repository.

autoMergeAllowed Boolean

Whether or not Auto-merge can be enabled on pull requests in this repository.

branchProtectionRules BranchProtectionRuleConnection

A list of branch protection rules for this repository.

codeOfConduct CodeOfConduct

Returns the code of conduct for this repository

Information extracted from the repository's CODEOWNERS file.

A list of collaborators associated with the repository.

commitComments CommitCommentConnection

A list of commit comments associated with the repository.

contactLinks RepositoryContactLink []

Returns a list of contact links associated to the repository

contributingGuidelines ContributingGuidelines

Returns the contributing guidelines for this repository.

createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

defaultBranchRef Ref

The Ref associated with the repository's default branch.

deleteBranchOnMerge Boolean

Whether or not branches are automatically deleted when merged in this repository.

dependencyGraphManifests DependencyGraphManifestConnection

A list of dependency manifests contained in the repository

deployKeys DeployKeyConnection

A list of deploy keys that are on this repository.

deployments DeploymentConnection

Deployments associated with the repository

description String

The description of the repository.

descriptionHTML HTML

The description of the repository rendered to HTML.

discussion Discussion

Returns a single discussion from the current repository by number.

discussionCategories DiscussionCategoryConnection

A list of discussion categories that are available in the repository.

discussionCategory DiscussionCategory

A discussion category by slug.

discussions DiscussionConnection

A list of discussions that have been opened in the repository.

diskUsage Int

The number of kilobytes this repository occupies on disk.

environment Environment

Returns a single active environment from the current repository by name.

environments EnvironmentConnection

A list of environments that are in this repository.

forkCount Int

Returns how many forks there are of this repository in the whole network.

forkingAllowed Boolean

Whether this repository allows forks.

A list of direct forked repositories.

fundingLinks FundingLink []

The funding links for this repository

hasDiscussionsEnabled Boolean

Indicates if the repository has the Discussions feature enabled.

hasIssuesEnabled Boolean

Indicates if the repository has issues feature enabled.

hasProjectsEnabled Boolean

Indicates if the repository has the Projects feature enabled.

hasSponsorshipsEnabled Boolean

Indicates if the repository displays a Sponsor button for financial contributions.

hasVulnerabilityAlertsEnabled Boolean

Whether vulnerability alerts are enabled for the repository.

hasWikiEnabled Boolean

Indicates if the repository has wiki feature enabled.

homepageUrl URI

The repository's URL.

id ID

The Node ID of the Repository object

interactionAbility RepositoryInteractionAbility

The interaction ability settings for this repository.

isArchived Boolean

Indicates if the repository is unmaintained.

isBlankIssuesEnabled Boolean

Returns true if blank issue creation is allowed

isDisabled Boolean

Returns whether or not this repository disabled.

isEmpty Boolean

Returns whether or not this repository is empty.

isFork Boolean

Identifies if the repository is a fork.

isInOrganization Boolean

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

isLocked Boolean

Indicates if the repository has been locked or not.

isMirror Boolean

Identifies if the repository is a mirror.

isPrivate Boolean

Identifies if the repository is private or internal.

isSecurityPolicyEnabled Boolean

Returns true if this repository has a security policy

isTemplate Boolean

Identifies if the repository is a template that can be used to generate new repositories.

isUserConfigurationRepository Boolean

Is this repository a user configuration repository?

issue Issue

Returns a single issue from the current repository by number.

issueOrPullRequest IssueOrPullRequest

Returns a single issue-like object from the current repository by number.

issueTemplates IssueTemplate []

Returns a list of issue templates associated to the repository

A list of issues that have been opened in the repository.

label Label

Returns a single label by name

A list of labels associated with the repository.

languages LanguageConnection

A list containing a breakdown of the language composition of the repository.

latestRelease Release

Get the latest release for the repository if one exists.

licenseInfo License

The license associated with the repository

The reason the repository has been locked.

mentionableUsers UserConnection

A list of Users that can be mentioned in the context of the repository.

mergeCommitAllowed Boolean

Whether or not PRs are merged with a merge commit on this repository.

mergeCommitMessage MergeCommitMessage

How the default commit message will be generated when merging a pull request.

mergeCommitTitle MergeCommitTitle

How the default commit title will be generated when merging a pull request.

mergeQueue MergeQueue

The merge queue for a specified branch, otherwise the default branch if not provided.

milestone Milestone

Returns a single milestone from the current repository by number.

milestones MilestoneConnection

A list of milestones associated with the repository.

mirrorUrl URI

The repository's original mirror URL.

name String

The name of the repository.

nameWithOwner String

The repository's name with owner.

object GitObject

A Git object in the repository

openGraphImageUrl URI

The image used to represent this repository in Open Graph data.

The User owner of the repository.

A list of packages under the owner.

parent Repository

The repository parent, if this is a fork.

pinnedDiscussions PinnedDiscussionConnection

A list of discussions that have been pinned in this repository.

pinnedIssues PinnedIssueConnection

A list of pinned issues for this repository.

primaryLanguage Language

The primary language of the repository's code.

project Project

Find project by number.

projectV2 ProjectV2

Finds and returns the Project according to the provided Project number.

A list of projects under the owner.

projectsResourcePath URI

The HTTP path listing the repository's projects

projectsUrl URI

The HTTP URL listing the repository's projects

projectsV2 ProjectV2Connection

List of projects linked to this repository.

pullRequest PullRequest

Returns a single pull request from the current repository by number.

pullRequestTemplates PullRequestTemplate []

Returns a list of pull request templates associated to the repository

pullRequests PullRequestConnection

A list of pull requests that have been opened in the repository.

pushedAt DateTime

Identifies the date and time when the repository was last pushed to.

rebaseMergeAllowed Boolean

Whether or not rebase-merging is enabled on this repository.

recentProjects ProjectV2Connection

Recent projects that this user has modified in the context of the owner.

ref Ref

Fetch a given ref from the repository

Fetch a list of refs from the repository

release Release

Lookup a single release given various criteria.

List of releases which are dependent on this repository.

repositoryTopics RepositoryTopicConnection

A list of applied repository-topic associations for this repository.

resourcePath URI

The HTTP path for this repository

Returns a single ruleset from the current repository by ID.

A list of rulesets for this repository.

securityPolicyUrl URI

The security policy URL.

shortDescriptionHTML HTML

A description of the repository, rendered to HTML without any links in it.

squashMergeAllowed Boolean

Whether or not squash-merging is enabled on this repository.

squashMergeCommitMessage SquashMergeCommitMessage

How the default commit message will be generated when squash merging a pull request.

squashMergeCommitTitle SquashMergeCommitTitle

How the default commit title will be generated when squash merging a pull request.

squashPrTitleUsedAsDefault Boolean

Whether a squash merge commit can use the pull request title as default.

Deprecated: `squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle` instead. Removal on 2023-04-01 UTC.
sshUrl GitSSHRemote

The SSH URL to clone this repository

stargazerCount Int

Returns a count of how many stargazers there are on this object

stargazers StargazerConnection

A list of users who have starred this starrable.

submodules SubmoduleConnection

Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.

tempCloneToken String

Temporary authentication token for cloning this repository.

templateRepository Repository

The repository from which this repository was generated, if any.

updatedAt DateTime

Identifies the date and time when the object was last updated.

url URI

The HTTP URL for this repository

usesCustomOpenGraphImage Boolean

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

viewerCanAdminister Boolean

Indicates whether the viewer has admin permissions on this repository.

viewerCanCreateProjects Boolean

Can the current viewer create new projects on this owner.

viewerCanSubscribe Boolean

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdateTopics Boolean

Indicates whether the viewer can update the topics of this repository.

viewerDefaultCommitEmail String

The last commit email for the viewer.

viewerDefaultMergeMethod PullRequestMergeMethod

The last used merge method by the viewer or the default for the repository.

viewerHasStarred Boolean

Returns a boolean indicating whether the viewing user has starred this starrable.

viewerPermission RepositoryPermission

The users permission level on the repository. Will return null if authenticated as an GitHub App.

viewerPossibleCommitEmails String []

A list of emails this viewer can commit with.

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

Indicates the repository's visibility level.

vulnerabilityAlert RepositoryVulnerabilityAlert

Returns a single vulnerability alert from the current repository by number.

A list of vulnerability alerts that are on this repository.

watchers UserConnection

A list of users watching the repository.

webCommitSignoffRequired Boolean

Whether contributors are required to sign off on web-based commits in this repository.

API:
Github GraphQL API

Identifies the repository associated with the 'referenced' event.

createdAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was created.

id ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The Node ID of the ReferencedEvent object

isCrossRepository Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Reference originated in a different repository.

isDirectReference Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

subject ReferencedSubject

ReferencedSubject [union]

Any referencable object

Union
IssuePullRequest
API:
Github GraphQL API

Object referenced by event.

API:
Github GraphQL API