查询

本文内容

每个 GraphQL 架构的查询和突变都有根类型。 查询类型定义从服务器中检索数据的 GraphQL 操作。

有关详细信息，请参阅“使用 GraphQL 建立调用”。

注意

对于使用用户访问令牌发出的 App 请求，你应该为问题和拉取请求使用单独的查询。 例如，使用 is:issue 或 is:pull-request 筛选器及其等效项。 使用 search 连接在单一查询中返回问题和拉取请求的组合将产生一组空节点。

Look up a code of conduct by its key.

codeOfConduct 的参数

名称说明

key (String!)

The code of conduct's key.

Look up a code of conduct by its key.

Look up an enterprise by URL slug.

类型: Enterprise

enterprise 的参数

名称说明

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

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

enterpriseAdministratorInvitation 的参数

名称说明

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.

Look up a pending enterprise administrator invitation by invitation token.

enterpriseAdministratorInvitationByToken 的参数

名称说明

invitationToken (String!)

The invitation token sent with the invitation email.

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

enterpriseMemberInvitation 的参数

名称说明

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.

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

enterpriseMemberInvitationByToken 的参数

名称说明

invitationToken (String!)

The invitation token sent with the invitation email.

ID of the object.

类型: ID!

Look up an open source license by its key.

类型: License

license 的参数

名称说明

key (String!)

The license's downcased SPDX ID.

Return a list of known open source licenses.

类型: [License]!

Get alphabetically sorted list of Marketplace categories.

marketplaceCategories 的参数

名称说明

excludeEmpty (Boolean)

Exclude categories with no listings.

excludeSubcategories (Boolean)

Returns top level categories only, excluding any subcategories.

includeCategories ([String!])

Return only the specified categories.

Look up a Marketplace category by its slug.

marketplaceCategory 的参数

名称说明

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.

Look up a single Marketplace listing.

marketplaceListing 的参数

名称说明

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.

marketplaceListings 的参数

名称说明

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.

The default value is false.

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.

The default value is false.

Return information about the instance.

类型: Metadata!

Fetches an object given its ID.

类型: Node

node 的参数

名称说明

id (ID!)

ID of the object.

Lookup nodes by a list of IDs.

类型: [Node]!

nodes 的参数

名称说明

ids ([ID!]!)

The list of node IDs.

Lookup a organization by login.

类型: Organization

organization 的参数

名称说明

login (String!)

The organization's login.

The client's rate limit information.

类型: RateLimit

rateLimit 的参数

名称说明

dryRun (Boolean)

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

The default value is false.

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

类型: Query!

Lookup a given repository by the owner and repository name.

类型: Repository

repository 的参数

名称说明

followRenames (Boolean)

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

The default value is true.

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.

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

repositoryOwner 的参数

名称说明

login (String!)

The username to lookup the owner by.

Lookup resource by a URL.

resource 的参数

名称说明

url (URI!)

The URL.

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

search 的参数

名称说明

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. search syntax is supported. For more information, see "Searching on ," "Understanding the search syntax," and "Sorting search results.".

type (SearchType!)

The types of search items to search within.

Security Advisories.

securityAdvisories 的参数

名称说明

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

Fetch a Security Advisory by its GHSA ID.

securityAdvisory 的参数

名称说明

ghsaId (String!)

Security Advisory ID.

Software Vulnerabilities documented by Security Advisories.

securityVulnerabilities 的参数

名称说明

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

sponsorables 的参数

名称说明

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.

ecosystem (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)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

onlyDependencies (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.

The default value is false.

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. If you are not an administrator of the organization, only dependencies from its public repositories will be considered.

Look up a topic by name.

类型: Topic

topic 的参数

名称说明

name (String!)

The topic's name.

Lookup a user by login.

类型: User

user 的参数

名称说明

login (String!)

The user's login.

The currently authenticated user.

类型: User!