Movatterモバイル変換

[0]ホーム
URL:

Skip to main content
GitHub Docs

The query type defines GraphQL operations that retrieve data from the server.

About queries

Every GraphQL schema has a root type for both queries and mutations. Thequery type defines GraphQL operations that retrieve data from the server.

For more information, seeForming calls with GraphQL.

Note

For GitHub App requests made with user access tokens, you should use separate queries for issues and pull requests. For example, use theis:issue oris:pull-request filters and their equivalents. Using thesearch connection to return a combination of issues and pull requests in a single query will result in an empty set of nodes.

codeOfConduct

Look up a code of conduct by its key.

Arguments forcodeOfConduct

NameDescription

key (String!)

The code of conduct's key.

codesOfConduct

Look up a code of conduct by its key.

enterprise

Look up an enterprise by URL slug.

Arguments forenterprise

NameDescription

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

enterpriseAdministratorInvitation

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

Arguments forenterpriseAdministratorInvitation

NameDescription

enterpriseSlug (String!)

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

role (EnterpriseAdministratorRole!)

The role for the enterprise member invitation.

userLogin (String!)

The login of the user invited to join the enterprise.

enterpriseAdministratorInvitationByToken

Look up a pending enterprise administrator invitation by invitation token.

Arguments forenterpriseAdministratorInvitationByToken

NameDescription

invitationToken (String!)

The invitation token sent with the invitation email.

enterpriseMemberInvitation

Look up a pending enterprise unaffiliated member invitation by invitee and enterprise.

Arguments forenterpriseMemberInvitation

NameDescription

enterpriseSlug (String!)

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

userLogin (String!)

The login of the user invited to join the enterprise.

enterpriseMemberInvitationByToken

Look up a pending enterprise unaffiliated member invitation by invitation token.

Arguments forenterpriseMemberInvitationByToken

NameDescription

invitationToken (String!)

The invitation token sent with the invitation email.

id

ID of the object.

Type:ID!

license

Look up an open source license by its key.

Type:License

Arguments forlicense

NameDescription

key (String!)

The license's downcased SPDX ID.

licenses

Return a list of known open source licenses.

marketplaceCategories

Get alphabetically sorted list of Marketplace categories.

Arguments formarketplaceCategories

NameDescription

excludeEmpty (Boolean)

Exclude categories with no listings.

excludeSubcategories (Boolean)

Returns top level categories only, excluding any subcategories.

includeCategories ([String!])

Return only the specified categories.

marketplaceCategory

Look up a Marketplace category by its slug.

Arguments formarketplaceCategory

NameDescription

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.

marketplaceListing

Look up a single Marketplace listing.

Arguments formarketplaceListing

NameDescription

slug (String!)

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

marketplaceListings

Look up Marketplace listings.

Arguments formarketplaceListings

NameDescription

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 orfalse, 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 firstn elements from the list.

last (Int)

Returns the lastn 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.

The default value isfalse.

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 theviewer are returned.

withFreeTrialsOnly (Boolean)

Select only listings that offer a free trial.

The default value isfalse.

meta

Return information about the GitHub instance.

node

Fetches an object given its ID.

Type:Node

Arguments fornode

NameDescription

id (ID!)

ID of the object.

nodes

Lookup nodes by a list of IDs.

Type:[Node]!

Arguments fornodes

NameDescription

ids ([ID!]!)

The list of node IDs.

organization

Lookup a organization by login.

Arguments fororganization

NameDescription

login (String!)

The organization's login.

rateLimit

The client's rate limit information.

Arguments forrateLimit

NameDescription

dryRun (Boolean)

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

The default value isfalse.

relay

Workaround for re-exposing the root query object. (Refer tohttps://github.com/facebook/relay/issues/112 for more information.).

Type:Query!

repository

Lookup a given repository by the owner and repository name.

Arguments forrepository

NameDescription

followRenames (Boolean)

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

The default value istrue.

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.

repositoryOwner

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

Arguments forrepositoryOwner

NameDescription

login (String!)

The username to lookup the owner by.

resource

Lookup resource by a URL.

Arguments forresource

NameDescription

url (URI!)

The URL.

search

Perform a search across resources, returning a maximum of 1,000 results.

Arguments forsearch

NameDescription

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 firstn elements from the list.

last (Int)

Returns the lastn elements from the list.

query (String!)

The search string to look for. GitHub search syntax is supported. For moreinformation, see "Searching onGitHub,""Understanding the search syntax,"and "Sorting search results.".

type (SearchType!)

The types of search items to search within.

securityAdvisories

GitHub Security Advisories.

Arguments forsecurityAdvisories

NameDescription

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.

classifications ([SecurityAdvisoryClassification!])

A list of classifications to filter advisories by.

epssPercentage (Float)

The EPSS percentage to filter advisories by.

epssPercentile (Float)

The EPSS percentile to filter advisories by.

first (Int)

Returns the firstn elements from the list.

identifier (SecurityAdvisoryIdentifierFilter)

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

last (Int)

Returns the lastn 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.

securityAdvisory

Fetch a Security Advisory by its GHSA ID.

Arguments forsecurityAdvisory

NameDescription

ghsaId (String!)

GitHub Security Advisory ID.

securityVulnerabilities

Software Vulnerabilities documented by GitHub Security Advisories.

Arguments forsecurityVulnerabilities

NameDescription

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.

classifications ([SecurityAdvisoryClassification!])

A list of advisory classifications to filter vulnerabilities by.

ecosystem (SecurityAdvisoryEcosystem)

An ecosystem to filter vulnerabilities by.

first (Int)

Returns the firstn elements from the list.

last (Int)

Returns the lastn 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.

sponsorables

Users and organizations who can be sponsored via GitHub Sponsors.

Arguments forsponsorables

NameDescription

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 sponsorableowners. Only sponsorable owners of dependencies in this ecosystem will beincluded. Used when onlyDependencies = true.

Upcoming Change on 2022-07-01 UTCDescription:dependencyEcosystem will be removed. Use the ecosystem argument instead.Reason: The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

ecosystem (DependencyGraphEcosystem)

Optional filter for which dependencies should be checked for sponsorableowners. Only sponsorable owners of dependencies in this ecosystem will beincluded. Used when onlyDependencies = true.

first (Int)

Returns the firstn elements from the list.

last (Int)

Returns the lastn elements from the list.

onlyDependencies (Boolean)

Whether only sponsorables who own the viewer's dependencies will bereturned. Must be authenticated to use. Can check an organization insteadfor their dependencies owned by sponsorables by passingorgLoginForDependencies.

The default value isfalse.

orderBy (SponsorableOrder)

Ordering options for users and organizations returned from the connection.

orgLoginForDependencies (String)

Optional organization username for whose dependencies should be checked.Used when onlyDependencies = true. Omit to check your own dependencies. Ifyou are not an administrator of the organization, only dependencies from itspublic repositories will be considered.

topic

Look up a topic by name.

Type:Topic

Arguments fortopic

NameDescription

name (String!)

The topic's name.

user

Lookup a user by login.

Type:User

Arguments foruser

NameDescription

login (String!)

The user's login.

viewer

The currently authenticated user.

Type:User!

[8]ページ先頭
©2009-2025 Movatter.jp