Enterprise Server 3.15 目前作为候选发布提供。

查询

查询类型定义从服务器中检索数据的 GraphQL 操作。

本文内容

关于查询

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

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

Note

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

codeOfConduct

Look up a code of conduct by its key.

codeOfConduct 的参数

名称说明

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.

enterprise 的参数

名称说明

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

license

Look up an open source license by its key.

Type: License

license 的参数

名称说明

key (String!)

The license's downcased SPDX ID.

licenses

Return a list of known open source licenses.

meta

Return information about the GitHub instance.

node

Fetches an object given its ID.

Type: Node

node 的参数

名称说明

id (ID!)

ID of the object.

nodes

Lookup nodes by a list of IDs.

Type: [Node]!

nodes 的参数

名称说明

ids ([ID!]!)

The list of node IDs.

organization

Lookup a organization by login.

organization 的参数

名称说明

login (String!)

The organization's login.

organizations

A list of organizations.

organizations 的参数

名称说明

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.

orderBy (OrganizationOrder)

Ordering options for the User's organizations.

rateLimit

The client's rate limit information.

Type: RateLimit

rateLimit 的参数

名称说明

dryRun (Boolean)

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

The default value is false.

relay

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

Type: Query!

repository

Lookup a given repository by the owner and repository name.

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.

repositoryOwner

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

repositoryOwner 的参数

名称说明

login (String!)

The username to lookup the owner by.

resource

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

type (SearchType!)

The types of search items to search within.

securityAdvisories

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

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

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.

securityAdvisory 的参数

名称说明

ghsaId (String!)

GitHub Security Advisory ID.

securityVulnerabilities

Software Vulnerabilities documented by GitHub 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.

package (String)

A package name to filter vulnerabilities by.

severities ([SecurityAdvisorySeverity!])

A list of severities to filter vulnerabilities by.

topic

Look up a topic by name.

Type: Topic

topic 的参数

名称说明

name (String!)

The topic's name.

user

Lookup a user by login.

Type: User

user 的参数

名称说明

login (String!)

The user's login.

users

A list of users.

users 的参数

名称说明

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.

viewer

The currently authenticated user.

Type: User!