跳至主要内容

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

关于查询

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

欲了解更多信息,请参阅使用 GraphQL 进行调用的方式

注意

对于使用用户访问令牌的 GitHub App 请求,您应分别对 issue 和 pull request 使用独立的查询。例如,使用 is:issueis:pull-request 过滤器及其等价形式。使用 search 连接在单个查询中返回 issue 和 pull request 的组合将导致节点集合为空。

codeOfConduct

通过其键查找行为准则。

codeOfConduct 的参数

名称描述

key (String!)

行为准则的键。

codesOfConduct

通过其键查找行为准则。

enterprise

通过 URL slug 查找企业。

enterprise 的参数

名称描述

invitationToken (String)

企业邀请令牌。

slug (String!)

企业的 URL slug。

enterpriseAdministratorInvitation

通过受邀者、企业和角色查找待处理的企业管理员邀请。

enterpriseAdministratorInvitation 的参数

名称描述

enterpriseSlug (String!)

用户被邀请加入的企业的 slug。

role (EnterpriseAdministratorRole!)

企业成员邀请的角色。

userLogin (String!)

被邀请加入企业的用户的登录名。

enterpriseAdministratorInvitationByToken

通过邀请令牌查找待处理的企业管理员邀请。

enterpriseAdministratorInvitationByToken 的参数

名称描述

invitationToken (String!)

随邀请电子邮件发送的邀请令牌。

enterpriseMemberInvitation

通过受邀者和企业查找待处理的企业非关联成员邀请。

enterpriseMemberInvitation 的参数

名称描述

enterpriseSlug (String!)

用户被邀请加入的企业的 slug。

userLogin (String!)

被邀请加入企业的用户的登录名。

enterpriseMemberInvitationByToken

通过邀请令牌查找待处理的企业非关联成员邀请。

enterpriseMemberInvitationByToken 的参数

名称描述

invitationToken (String!)

随邀请电子邮件发送的邀请令牌。

id

对象的 ID。

Type: ID!

license

通过其键查找开源许可证。

Type: License

license 的参数

名称描述

key (String!)

许可证的小写 SPDX 标识符。

licenses

返回已知开源许可证的列表。

marketplaceCategories

获取按字母顺序排序的 Marketplace 类别列表。

marketplaceCategories 的参数

名称描述

excludeEmpty (Boolean)

排除没有列表的类别。

excludeSubcategories (Boolean)

仅返回顶层类别,排除所有子类别。

includeCategories ([String!])

仅返回指定的类别。

marketplaceCategory

通过 slug 查找 Marketplace 类别。

marketplaceCategory 的参数

名称描述

slug (String!)

类别的 URL slug。

useTopicAliases (Boolean)

同时检查类别 slug 的主题别名。

marketplaceListing

查找单个 Marketplace 列表。

marketplaceListing 的参数

名称描述

slug (String!)

选择与此 slug 匹配的列表。它是列表在 URL 中使用的短名称。

marketplaceListings

查找 Marketplace 列表。

marketplaceListings 的参数

名称描述

adminId (ID)

选择可以由指定用户管理的列表。

after (String)

返回列表中位于指定光标之后的元素。

allStates (Boolean)

选择即使未获批准,仍对查看者可见的列表。如果省略或为 false,则仅返回已批准的列表。

before (String)

返回列表中位于指定光标之前的元素。

categorySlug (String)

仅选择具有给定类别的列表。

first (Int)

返回列表中的前 *n* 个元素。

last (Int)

返回列表中的后 *n* 个元素。

organizationId (ID)

选择指定组织拥有的产品的列表。

primaryCategoryOnly (Boolean)

仅选择主类别与给定类别 slug 匹配的列表。

默认值为 false

slugs ([String])

如果对查看者可见,则选择具有这些 slug 的列表。

useTopicAliases (Boolean)

同时检查类别 slug 的主题别名。

viewerCanAdmin (Boolean)

选择用户具有管理员权限的列表。如果省略,则返回对查看者可见的列表。

withFreeTrialsOnly (Boolean)

仅选择提供免费试用的列表。

默认值为 false

meta

返回关于 GitHub 实例的信息。

node

根据其 ID 获取对象。

Type: Node

node 的参数

名称描述

id (ID!)

对象的 ID。

nodes

通过 ID 列表查找节点。

Type: [Node]!

nodes 的参数

名称描述

ids ([ID!]!)

节点 ID 的列表。

organization

通过登录名查找组织。

organization 的参数

名称描述

login (String!)

组织的登录名。

rateLimit

客户端的速率限制信息。

Type: RateLimit

rateLimit 的参数

名称描述

dryRun (Boolean)

如果为 true,则在不实际执行查询的情况下计算查询的成本。

默认值为 false

relay

重新公开根查询对象的变通方法。(有关更多信息,请参阅 https://github.com/facebook/relay/issues/112)。

Type: Query!

repository

通过所有者和仓库名称查找指定的仓库。

repository 的参数

名称描述

followRenames (Boolean)

跟随仓库重命名。如果禁用,则使用旧名称引用的仓库将返回错误。

默认值为 true

name (String!)

仓库名称。

owner (String!)

用户或组织的登录字段。

repositoryOwner

通过登录名查找仓库所有者(即用户或组织)。

repositoryOwner 的参数

名称描述

login (String!)

用于查找所有者的用户名。

resource

通过 URL 查找资源。

resource 的参数

名称描述

url (URI!)

URL。

在资源中执行搜索,最多返回 1,000 条结果。

search 的参数

名称描述

after (String)

返回列表中位于指定光标之后的元素。

before (String)

返回列表中位于指定光标之前的元素。

first (Int)

返回列表中的前 *n* 个元素。

last (Int)

返回列表中的后 *n* 个元素。

query (String!)

要搜索的字符串。支持 GitHub 搜索语法。欲了解更多信息,请参阅 “在 GitHub 上搜索”、 “了解搜索语法” 以及 “对搜索结果进行排序”。

type (SearchType!)

要搜索的项目类型。

securityAdvisories

GitHub 安全建议。

securityAdvisories 的参数

名称描述

after (String)

返回列表中位于指定光标之后的元素。

before (String)

返回列表中位于指定光标之前的元素。

classifications ([SecurityAdvisoryClassification!])

用于按分类筛选建议的分类列表。

epssPercentage (Float)

用于筛选建议的 EPSS 百分比。

epssPercentile (Float)

用于筛选建议的 EPSS 百分位。

first (Int)

返回列表中的前 *n* 个元素。

identifier (SecurityAdvisoryIdentifierFilter)

按标识符(如 GHSA 或 CVE)筛选建议。

last (Int)

返回列表中的后 *n* 个元素。

orderBy (SecurityAdvisoryOrder)

返回主题的排序选项。

publishedSince (DateTime)

筛选自过去某时间点发布的建议。

updatedSince (DateTime)

筛选自过去某时间点更新的建议。

securityAdvisory

通过 GHSA ID 获取安全建议。

securityAdvisory 的参数

名称描述

ghsaId (String!)

GitHub 安全建议 ID。

securityVulnerabilities

由 GitHub 安全建议记录的软件漏洞。

securityVulnerabilities 的参数

名称描述

after (String)

返回列表中位于指定光标之后的元素。

before (String)

返回列表中位于指定光标之前的元素。

classifications ([SecurityAdvisoryClassification!])

用于按建议分类筛选漏洞的分类列表。

ecosystem (SecurityAdvisoryEcosystem)

用于筛选漏洞的生态系统。

first (Int)

返回列表中的前 *n* 个元素。

last (Int)

返回列表中的后 *n* 个元素。

orderBy (SecurityVulnerabilityOrder)

返回主题的排序选项。

package (String)

用于筛选漏洞的包名。

severities ([SecurityAdvisorySeverity!])

用于筛选漏洞的严重程度列表。

sponsorables

可通过 GitHub Sponsors 赞助的用户和组织。

sponsorables 的参数

名称描述

after (String)

返回列表中位于指定光标之后的元素。

before (String)

返回列表中位于指定光标之前的元素。

dependencyEcosystem (SecurityAdvisoryEcosystem)

可选过滤器,用于确定应检查哪些依赖项以获取可赞助的所有者。仅包含该生态系统中依赖项的可赞助所有者。当 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)

可选过滤器,用于确定应检查哪些依赖项以获取可赞助的所有者。仅包含该生态系统中依赖项的可赞助所有者。当 onlyDependencies = true 时使用。

first (Int)

返回列表中的前 *n* 个元素。

last (Int)

返回列表中的后 *n* 个元素。

onlyDependencies (Boolean)

是否仅返回拥有查看者依赖项的可赞助对象。使用此参数必须已认证。可通过传入 orgLoginForDependencies 检查组织的依赖项所有者。

默认值为 false

orderBy (SponsorableOrder)

返回的用户和组织的排序选项。

orgLoginForDependencies (String)

可选的组织用户名,用于检查其依赖项。当 onlyDependencies = true 时使用。省略则检查您自己的依赖项。如果您不是该组织的管理员,则仅会考虑其公共仓库中的依赖项。

topic

通过名称查找主题。

Type: Topic

topic 的参数

名称描述

name (String!)

主题的名称。

user

通过登录名查找用户。

Type: User

user 的参数

名称描述

login (String!)

用户的登录名。

viewer

当前已认证的用户。

Type: User!

© . This site is unofficial and not affiliated with GitHub, Inc.