Object GitHub::Query

The query root of GitHub's GraphQL interface.

Fields

`codeOfConduct(key: String!): CodeOfConduct`

Look up a code of conduct by its key

Args

`key: String!`

The code of conduct's key

`codesOfConduct: [CodeOfConduct]`

Look up a code of conduct by its key

`enterprise(slug: String!, invitationToken: String): Enterprise`

Look up an enterprise by URL slug.

Args

`slug: String!`

The enterprise URL slug.

`invitationToken: String`

The enterprise invitation token.

`enterpriseAdministratorInvitation(userLogin: String!, enterpriseSlug: String!, role: EnterpriseAdministratorRole!): EnterpriseAdministratorInvitation`

Look up a pending enterprise administrator invitation by invitee, enterprise and role.

Args

`userLogin: String!`

The login of the user invited to join the business.

`enterpriseSlug: String!`

The slug of the enterprise the user was invited to join.

`role: EnterpriseAdministratorRole!`

The role for the business member invitation.

`enterpriseAdministratorInvitationByToken(invitationToken: String!): EnterpriseAdministratorInvitation`

Look up a pending enterprise administrator invitation by invitation token.

Args

`invitationToken: String!`

The invitation token sent with the invitation email.

`license(key: String!): License`

Look up an open source license by its key

Args

`key: String!`

The license's downcased SPDX ID

`licenses: [License]!`

Return a list of known open source licenses

`marketplaceCategories(includeCategories: [String!], excludeEmpty: Boolean, excludeSubcategories: Boolean): [MarketplaceCategory!]!`

Get alphabetically sorted list of Marketplace categories

Args

`includeCategories: [String!]`

Return only the specified categories.

`excludeEmpty: Boolean`

Exclude categories with no listings.

`excludeSubcategories: Boolean`

Returns top level categories only, excluding any subcategories.

`marketplaceCategory(slug: String!, useTopicAliases: Boolean): MarketplaceCategory`

Look up a Marketplace category by its slug.

Args

`slug: String!`

The URL slug of the category.

`useTopicAliases: Boolean`

Also check topic aliases for the category slug

`marketplaceListing(slug: String!): MarketplaceListing`

Look up a single Marketplace listing

Args

`slug: String!`

Select the listing that matches this slug. It's the short name of the listing used in its URL.

`marketplaceListings(after: String, before: String, first: Int, last: Int, categorySlug: String, useTopicAliases: Boolean, viewerCanAdmin: Boolean, adminId: ID, organizationId: ID, allStates: Boolean, slugs: [String], primaryCategoryOnly: Boolean = false, withFreeTrialsOnly: Boolean = false): MarketplaceListingConnection!`

Look up Marketplace listings

Args

`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.

`categorySlug: String`

Select only listings with the given category.

`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.

`adminId: ID`

Select listings that can be administered by the specified user.

`organizationId: ID`

Select listings for products owned by the specified organization.

`allStates: Boolean`

Select listings visible to the viewer even if they are not approved. If omitted or false, only approved listings will be returned.

`slugs: [String]`

Select the listings with these slugs, if they are visible to the viewer.

`primaryCategoryOnly: Boolean = false`

Select only listings where the primary category matches the given category slug.

`withFreeTrialsOnly: Boolean = false`

Select only listings that offer a free trial.

`meta: GitHubMetadata!`

Return information about the GitHub instance

`node(id: ID!): Node`

Fetches an object given its ID.

Args

`id: ID!`

ID of the object.

`nodes(ids: [ID!]!): [Node]!`

Lookup nodes by a list of IDs.

Args

`ids: [ID!]!`

The list of node IDs.

`organization(login: String!): Organization`

Lookup a organization by login.

Args

`rateLimit(dryRun: Boolean = false): RateLimit`

The client's rate limit information.

Args

`dryRun: Boolean = false`

If true, calculate the cost for the query without evaluating it

`relay: Query!`

Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object

`repository(owner: String!, name: String!): Repository`

Lookup a given repository by the owner and repository name.

Args

`owner: String!`

The login field of a user or organization

`name: String!`

The name of the repository

`repositoryOwner(login: String!): RepositoryOwner`

Lookup a repository owner (ie. either a User or an Organization) by login.

Args

`resource(url: URI!): UniformResourceLocatable`

Lookup resource by a URL.

Args

`url: URI!`

The URL.

`search(after: String, before: String, first: Int, last: Int, query: String!, type: SearchType!): SearchResultItemConnection!`

Perform a search across resources.

Args

`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.

`securityAdvisories(orderBy: SecurityAdvisoryOrder = {field: UPDATED_AT, direction: DESC}, identifier: SecurityAdvisoryIdentifierFilter, publishedSince: DateTime, updatedSince: DateTime, after: String, before: String, first: Int, last: Int): SecurityAdvisoryConnection!`

GitHub Security Advisories

Args

`orderBy: SecurityAdvisoryOrder = {field: UPDATED_AT, direction: DESC}`

Ordering options for the returned topics.

`identifier: SecurityAdvisoryIdentifierFilter`

Filter advisories by identifier, e.g. GHSA or CVE.

`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.

`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.

`securityAdvisory(ghsaId: String!): SecurityAdvisory`

Fetch a Security Advisory by its GHSA ID

Args

`ghsaId: String!`

GitHub Security Advisory ID.

`securityVulnerabilities(orderBy: SecurityVulnerabilityOrder = {field: UPDATED_AT, direction: DESC}, ecosystem: SecurityAdvisoryEcosystem, package: String, severities: [SecurityAdvisorySeverity!], after: String, before: String, first: Int, last: Int): SecurityVulnerabilityConnection!`

Software Vulnerabilities documented by GitHub Security Advisories

Args

`orderBy: SecurityVulnerabilityOrder = {field: UPDATED_AT, direction: DESC}`

Ordering options for the returned topics.

`ecosystem: SecurityAdvisoryEcosystem`

An ecosystem to filter vulnerabilities by.

`package: String`

A package name to filter vulnerabilities by.

`severities: [SecurityAdvisorySeverity!]`

A list of severities to filter vulnerabilities by.

`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.

`sponsorsListing(slug: String!): SponsorsListing`

👎 Deprecated:

`Query.sponsorsListing` will be removed. Use `Sponsorable.sponsorsListing` instead. Removal on 2020-04-01 UTC.

Look up a single Sponsors Listing

Args

`slug: String!`

Select the Sponsors listing which matches this slug

`topic(name: String!): Topic`

Look up a topic by name.

Args

`name: String!`

The topic's name.

`user(login: String!): User`

Lookup a user by login.

Args

`viewer: User!`

The currently authenticated user.