The query root of GitHub's GraphQL interface.
Type: CodeOfConduct
Look up a code of conduct by its key
| Name | Description |
|---|---|
| key (String!) | The code of conduct’s key |
Type: [CodeOfConduct]
Look up a code of conduct by its key
Type: Enterprise
Look up an enterprise by URL slug.
| Name | Description |
|---|---|
| invitationToken (String) | The enterprise invitation token. |
| slug (String!) | The enterprise URL slug. |
Look up a pending enterprise administrator invitation by invitee, enterprise and role.
| Name | Description |
|---|---|
| enterpriseSlug (String!) | The slug of the enterprise the user was invited to join. |
| role (EnterpriseAdministratorRole!) | The role for the business member invitation. |
| userLogin (String!) | The login of the user invited to join the business. |
Look up a pending enterprise administrator invitation by invitation token.
| Name | Description |
|---|---|
| invitationToken (String!) | The invitation token sent with the invitation email. |
Type: License
Look up an open source license by its key
| Name | Description |
|---|---|
| key (String!) | The license’s downcased SPDX ID |
Type: [License]!
Return a list of known open source licenses
Type: [MarketplaceCategory!]!
Get alphabetically sorted list of Marketplace categories
| Name | Description |
|---|---|
| excludeEmpty (Boolean) | Exclude categories with no listings. |
| excludeSubcategories (Boolean) | Returns top level categories only, excluding any subcategories. |
| includeCategories ([String!]) | Return only the specified categories. |
Type: MarketplaceCategory
Look up a Marketplace category by its slug.
| Name | Description |
|---|---|
| slug (String!) | The URL slug of the category. |
| useTopicAliases (Boolean) | Also check topic aliases for the category slug |
Type: MarketplaceListing
Look up a single Marketplace listing
| Name | Description |
|---|---|
| slug (String!) | Select the listing that matches this slug. It’s the short name of the listing used in its URL. |
Look up Marketplace listings
| Name | Description |
|---|---|
| adminId (ID) | Select listings that can be administered by the specified user. |
| after (String) | Returns the elements in the list that come after the specified cursor. |
| allStates (Boolean) | Select listings visible to the viewer even if they are not approved. If omitted or |
| false, only approved listings will be returned. | |
| before (String) | Returns the elements in the list that come before the specified cursor. |
| categorySlug (String) | Select only listings with the given category. |
| first (Int) | Returns the first n elements from the list. |
| last (Int) | Returns the last n elements from the list. |
| organizationId (ID) | Select listings for products owned by the specified organization. |
| primaryCategoryOnly (Boolean) | Select only listings where the primary category matches the given category slug. |
| slugs ([String]) | Select the listings with these slugs, if they are visible to the viewer. |
| useTopicAliases (Boolean) | Also check topic aliases for the category slug |
| viewerCanAdmin (Boolean) | Select listings to which user has admin access. If omitted, listings visible to the |
| viewer are returned. | |
| withFreeTrialsOnly (Boolean) | Select only listings that offer a free trial. |
Type: GitHubMetadata!
Return information about the GitHub instance
Type: Node
Fetches an object given its ID.
| Name | Description |
|---|---|
| id (ID!) | ID of the object. |
Type: [Node]!
Lookup nodes by a list of IDs.
| Name | Description |
|---|---|
| ids ([ID!]!) | The list of node IDs. |
Type: Organization
Lookup a organization by login.
| Name | Description |
|---|---|
| login (String!) | The organization’s login. |
Type: RateLimit
The client's rate limit information.
| Name | Description |
|---|---|
| dryRun (Boolean) | If true, calculate the cost for the query without evaluating it |
Type: Query!
Hack to workaround facebook/relay#112 re-exposing the root query object
Type: Repository
Lookup a given repository by the owner and repository name.
| Name | Description |
|---|---|
| followRenames (Boolean) | Follow repository renames. If disabled, a repository referenced by its old name will return an error. |
| name (String!) | The name of the repository |
| owner (String!) | The login field of a user or organization |
Type: RepositoryOwner
Lookup a repository owner (ie. either a User or an Organization) by login.
| Name | Description |
|---|---|
| login (String!) | The username to lookup the owner by. |
Type: UniformResourceLocatable
Lookup resource by a URL.
| Name | Description |
|---|---|
| url (URI!) | The URL. |
Perform a search across resources.
| Name | Description |
|---|---|
| after (String) | Returns the elements in the list that come after the specified cursor. |
| before (String) | Returns the elements in the list that come before the specified cursor. |
| first (Int) | Returns the first n elements from the list. |
| last (Int) | Returns the last n elements from the list. |
| query (String!) | The search string to look for. |
| type (SearchType!) | The types of search items to search within. |
GitHub Security Advisories
| Name | Description |
|---|---|
| after (String) | Returns the elements in the list that come after the specified cursor. |
| before (String) | Returns the elements in the list that come before the specified cursor. |
| first (Int) | Returns the first n elements from the list. |
| identifier (SecurityAdvisoryIdentifierFilter) | Filter advisories by identifier, e.g. GHSA or CVE. |
| last (Int) | Returns the last n elements from the list. |
| orderBy (SecurityAdvisoryOrder) | Ordering options for the returned topics. |
| publishedSince (DateTime) | Filter advisories to those published since a time in the past. |
| updatedSince (DateTime) | Filter advisories to those updated since a time in the past. |
Type: SecurityAdvisory
Fetch a Security Advisory by its GHSA ID
| Name | Description |
|---|---|
| ghsaId (String!) | GitHub Security Advisory ID. |
Software Vulnerabilities documented by GitHub Security Advisories
| Name | Description |
|---|---|
| after (String) | Returns the elements in the list that come after the specified cursor. |
| before (String) | Returns the elements in the list that come before the specified cursor. |
| ecosystem (SecurityAdvisoryEcosystem) | An ecosystem to filter vulnerabilities by. |
| first (Int) | Returns the first n elements from the list. |
| last (Int) | Returns the last n elements from the list. |
| orderBy (SecurityVulnerabilityOrder) | Ordering options for the returned topics. |
| package (String) | A package name to filter vulnerabilities by. |
| severities ([SecurityAdvisorySeverity!]) | A list of severities to filter vulnerabilities by. |
Users and organizations who can be sponsored via GitHub Sponsors.
| Name | Description |
|---|---|
| after (String) | Returns the elements in the list that come after the specified cursor. |
| before (String) | Returns the elements in the list that come before the specified cursor. |
| dependencyEcosystem (SecurityAdvisoryEcosystem) | Optional filter for which dependencies should be checked for sponsorable |
| owners. Only sponsorable owners of dependencies in this ecosystem will be | |
| included. Used when onlyDependencies = true. |
Upcoming Change on 2022-07-01 UTC
Description: dependencyEcosystem will be removed. Use the ecosystem argument instead.
Reason: The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.
Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true.
| | first ([Int](scalars.md#int)) |Returns the first n elements from the list.
| | last ([Int](scalars.md#int)) |Returns the last n elements from the list.
| | onlyDependencies ([Boolean](scalars.md#boolean)) |Whether only sponsorables who own the viewer’s dependencies will be returned. Must be authenticated to use. Can check an organization instead for their dependencies owned by sponsorables by passing orgLoginForDependencies.
| | orderBy ([SponsorableOrder](input_objects.md#sponsorableorder)) |Ordering options for users and organizations returned from the connection.
| | orgLoginForDependencies ([String](scalars.md#string)) |Optional organization username for whose dependencies should be checked. Used when onlyDependencies = true. Omit to check your own dependencies. If you are not an administrator of the organization, only dependencies from its public repositories will be considered.
|Type: Topic
Look up a topic by name.
| Name | Description |
|---|---|
| name (String!) | The topic’s name. |
Type: User
Lookup a user by login.
| Name | Description |
|---|---|
| login (String!) | The user’s login. |
Type: User!
The currently authenticated user.