Github API - Test Config

RepositoryVulnerabilityAlert [object]

A Dependabot alert for a repository with a dependency affected by a security vulnerability.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
RepositoryNode

RepositoryNode [interface]

Represents a object that belongs to a repository.

Attributes
repository Repository

The repository associated with this node.

API:
Github GraphQL API
Attributes
autoDismissedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

When was the alert auto-dismissed?

createdAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

When was the alert created?

dependabotUpdate DependabotUpdate

DependabotUpdate [object]

A Dependabot Update for a dependency in a repository

Implements
RepositoryNode
Attributes

The error from a dependency update

pullRequest PullRequest

The associated pull request

repository Repository

The repository associated with this node.

API:
Github GraphQL API

The associated Dependabot update

dependencyScope RepositoryVulnerabilityAlertDependencyScope

RepositoryVulnerabilityAlertDependencyScope [enum]

The possible scopes of an alert's dependency.

Possible values
DEVELOPMENT

A dependency that is only used in development

RUNTIME

A dependency that is leveraged during application runtime

API:
Github GraphQL API

The scope of an alert's dependency

dismissComment String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

Comment explaining the reason the alert was dismissed

dismissReason String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The reason the alert was dismissed

dismissedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

When was the alert dismissed?

dismisser User

User [object]

A user is an individual's account on GitHub that owns repositories and can make new content.

Implements
ActorNodePackageOwnerProfileOwnerProjectOwnerProjectV2OwnerProjectV2RecentRepositoryDiscussionAuthorRepositoryDiscussionCommentAuthorRepositoryOwnerSponsorableUniformResourceLocatable
Attributes
anyPinnableItems Boolean

Determine if this repository owner has any items that can be pinned to their profile.

avatarUrl URI

A URL pointing to the user's public avatar.

bio String

The user's public profile bio.

bioHTML HTML

The user's public profile bio as HTML.

canReceiveOrganizationEmailsWhenNotificationsRestricted Boolean

Could this user receive email notifications, if the organization had notification restrictions enabled?

commitComments CommitCommentConnection

A list of commit comments made by this user.

company String

The user's public profile company.

companyHTML HTML

The user's public profile company as HTML.

contributionsCollection ContributionsCollection

The collection of contributions this user has made to different repositories.

createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

email String

The user's publicly visible profile email.

enterprises EnterpriseConnection

A list of enterprises that the user belongs to.

estimatedNextSponsorsPayoutInCents Int

The estimated next GitHub Sponsors payout for this user/organization in cents (USD).

followers FollowerConnection

A list of users the given user is followed by.

A list of users the given user is following.

gist Gist

Find gist by repo name.

gistComments GistCommentConnection

A list of gist comments made by this user.

A list of the Gists the user has created.

hasSponsorsListing Boolean

True if this user/organization has a GitHub Sponsors listing.

hovercard Hovercard

The hovercard information for this user in a given context

id ID

The Node ID of the User object

interactionAbility RepositoryInteractionAbility

The interaction ability settings for this user.

isBountyHunter Boolean

Whether or not this user is a participant in the GitHub Security Bug Bounty.

isCampusExpert Boolean

Whether or not this user is a participant in the GitHub Campus Experts Program.

isDeveloperProgramMember Boolean

Whether or not this user is a GitHub Developer Program member.

isEmployee Boolean

Whether or not this user is a GitHub employee.

isFollowingViewer Boolean

Whether or not this user is following the viewer. Inverse of viewerIsFollowing

isGitHubStar Boolean

Whether or not this user is a member of the GitHub Stars Program.

isHireable Boolean

Whether or not the user has marked themselves as for hire.

isSiteAdmin Boolean

Whether or not this user is a site administrator.

isSponsoredBy Boolean

Whether the given account is sponsoring this user/organization.

isSponsoringViewer Boolean

True if the viewer is sponsored by this user/organization.

isViewer Boolean

Whether or not this user is the viewing user.

issueComments IssueCommentConnection

A list of issue comments made by this user.

A list of issues associated with this user.

itemShowcase ProfileItemShowcase

Showcases a selection of repositories and gists that the profile owner has
either curated or that have been selected automatically based on popularity.

lifetimeReceivedSponsorshipValues SponsorAndLifetimeValueConnection

Calculate how much each sponsor has ever paid total to this maintainer via
GitHub Sponsors. Does not include sponsorships paid via Patreon.

A user-curated list of repositories

location String

The user's public profile location.

login String

The username used to login.

monthlyEstimatedSponsorsIncomeInCents Int

The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).

name String

The user's public profile name.

organization Organization

Find an organization by its login that the user belongs to.

organizationVerifiedDomainEmails String []

Verified email addresses that match verified domains for a specified organization the user is a member of.

organizations OrganizationConnection

A list of organizations the user belongs to.

A list of packages under the owner.

pinnableItems PinnableItemConnection

A list of repositories and gists this profile owner can pin to their profile.

A list of repositories and gists this profile owner has pinned to their profile

pinnedItemsRemaining Int

Returns how many more items this profile owner can pin to their profile.

project Project

Find project by number.

projectV2 ProjectV2

Find a project by number.

A list of projects under the owner.

projectsResourcePath URI

The HTTP path listing user's projects

projectsUrl URI

The HTTP URL listing user's projects

projectsV2 ProjectV2Connection

A list of projects under the owner.

pronouns String

The user's profile pronouns

publicKeys PublicKeyConnection

A list of public keys associated with this user.

pullRequests PullRequestConnection

A list of pull requests associated with this user.

recentProjects ProjectV2Connection

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

repositories RepositoryConnection

A list of repositories that the user owns.

repositoriesContributedTo RepositoryConnection

A list of repositories that the user recently contributed to.

repository Repository

Find Repository.

repositoryDiscussionComments DiscussionCommentConnection

Discussion comments this user has authored.

repositoryDiscussions DiscussionConnection

Discussions this user has started.

resourcePath URI

The HTTP path for this user

savedReplies SavedReplyConnection

Replies this user has saved

socialAccounts SocialAccountConnection

The user's social media accounts, ordered as they appear on the user's profile.

sponsoring SponsorConnection

List of users and organizations this entity is sponsoring.

List of sponsors for this user or organization.

sponsorsActivities SponsorsActivityConnection

Events involving this sponsorable, such as new sponsorships.

sponsorsListing SponsorsListing

The GitHub Sponsors listing for this user or organization.

sponsorshipForViewerAsSponsor Sponsorship

The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.

sponsorshipForViewerAsSponsorable Sponsorship

The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.

sponsorshipNewsletters SponsorshipNewsletterConnection

List of sponsorship updates sent from this sponsorable to sponsors.

sponsorshipsAsMaintainer SponsorshipConnection

The sponsorships where this user or organization is the maintainer receiving the funds.

sponsorshipsAsSponsor SponsorshipConnection

The sponsorships where this user or organization is the funder.

starredRepositories StarredRepositoryConnection

Repositories the user has starred.

status UserStatus

The user's description of what they're currently doing.

suggestedListNames UserListSuggestion []

Suggested names for user lists

topRepositories RepositoryConnection

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created

totalSponsorshipAmountAsSponsorInCents Int

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.

twitterUsername String

The user's Twitter username.

updatedAt DateTime

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

url URI

The HTTP URL for this user

viewerCanChangePinnedItems Boolean

Can the viewer pin repositories and gists to the profile?

viewerCanCreateProjects Boolean

Can the current viewer create new projects on this owner.

viewerCanFollow Boolean

Whether or not the viewer is able to follow the user.

viewerCanSponsor Boolean

Whether or not the viewer is able to sponsor this user/organization.

viewerIsFollowing Boolean

Whether or not this user is followed by the viewer. Inverse of isFollowingViewer.

viewerIsSponsoring Boolean

True if the viewer is sponsoring this user/organization.

A list of repositories the given user is watching.

websiteUrl URI

A URL pointing to the user's public website/blog.

API:
Github GraphQL API

The user who dismissed the alert

fixedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

When was the alert fixed?

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 RepositoryVulnerabilityAlert object

number Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Identifies the alert number.

repository 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

The associated repository

securityAdvisory SecurityAdvisory

SecurityAdvisory [object]

A GitHub Security Advisory

Implements
Node
Attributes

The classification of the advisory

cvss CVSS

The CVSS associated with this advisory

CWEs associated with this Advisory

databaseId Int

Identifies the primary key from the database.

description String

This is a long plaintext description of the advisory

ghsaId String

The GitHub Security Advisory ID

id ID

The Node ID of the SecurityAdvisory object

A list of identifiers for this advisory

notificationsPermalink URI

The permalink for the advisory's dependabot alerts page

origin String

The organization that originated the advisory

permalink URI

The permalink for the advisory

publishedAt DateTime

When the advisory was published

A list of references for this advisory

The severity of the advisory

summary String

A short plaintext summary of the advisory

updatedAt DateTime

When the advisory was last updated

Vulnerabilities associated with this Advisory

withdrawnAt DateTime

When the advisory was withdrawn, if it has been withdrawn

API:
Github GraphQL API

The associated security advisory

securityVulnerability SecurityVulnerability

SecurityVulnerability [object]

An individual vulnerability within an Advisory

Attributes
advisory SecurityAdvisory

The Advisory associated with this Vulnerability

firstPatchedVersion SecurityAdvisoryPackageVersion

The first version containing a fix for the vulnerability

A description of the vulnerable package

The severity of the vulnerability within this package

updatedAt DateTime

When the vulnerability was last updated

vulnerableVersionRange String

A string that describes the vulnerable package versions.
This string follows a basic syntax with a few forms.

  • = 0.2.0 denotes a single vulnerable version.
  • <= 1.0.8 denotes a version range up to and including the specified version
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum

API:
Github GraphQL API

The associated security vulnerability

state RepositoryVulnerabilityAlertState

RepositoryVulnerabilityAlertState [enum]

The possible states of an alert

Possible values
AUTO_DISMISSED

An alert that has been automatically closed by Dependabot.

DISMISSED

An alert that has been manually closed by a user.

FIXED

An alert that has been resolved by a code change.

OPEN

An alert that is still open.

API:
Github GraphQL API

Identifies the state of the alert.

vulnerableManifestFilename String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The vulnerable manifest filename

vulnerableManifestPath String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The vulnerable manifest path

vulnerableRequirements String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The vulnerable requirements

API:
Github GraphQL API