跳至主要内容

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

关于查询

每个 GraphQL 模式都具有查询和变异的根类型。 查询类型 定义从服务器检索数据的 GraphQL 操作。

更多信息,请参见“使用 GraphQL 进行表单调用”。

注意

对于使用用户访问令牌发出的 GitHub 应用请求,应为问题和拉取请求使用单独的查询。例如,使用`is:issue`或`is:pull-request`过滤器及其等效项。使用`search`连接在单个查询中返回问题和拉取请求的组合将导致空节点集。

行为准则

按其键查找行为准则。

类型:CodeOfConduct

codeOfConduct 的参数

名称描述

key (String!)

行为准则的键。

行为准则

按其键查找行为准则。

企业

按 URL 标识查找企业。

类型:Enterprise

enterprise 的参数

名称描述

invitationToken (String)

企业邀请令牌。

slug (String!)

企业 URL 标识。

企业管理员邀请

按被邀请人、企业和角色查找待处理的企业管理员邀请。

enterpriseAdministratorInvitation 的参数

名称描述

enterpriseSlug (String!)

邀请用户加入的企业的标识。

role (EnterpriseAdministratorRole!)

企业成员邀请的角色。

userLogin (String!)

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

按令牌邀请企业管理员

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

enterpriseAdministratorInvitationByToken 的参数

名称描述

invitationToken (String!)

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

企业成员邀请

按被邀请人和企业查找待处理的企业非关联成员邀请。

enterpriseMemberInvitation 的参数

名称描述

enterpriseSlug (String!)

邀请用户加入的企业的标识。

userLogin (String!)

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

按令牌邀请企业成员

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

enterpriseMemberInvitationByToken 的参数

名称描述

invitationToken (String!)

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

ID

对象的 ID。

类型:ID!

许可证

按其键查找开源许可证。

类型:License

license 的参数

名称描述

key (String!)

许可证的小写 SPDX ID。

许可证

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

类型:[License]!

市场类别

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

marketplaceCategories 的参数

名称描述

excludeEmpty (Boolean)

排除没有列表的类别。

excludeSubcategories (Boolean)

仅返回顶级类别,不包括任何子类别。

includeCategories ([String!])

仅返回指定的类别。

市场类别

按其标识查找市场类别。

marketplaceCategory 的参数

名称描述

slug (String!)

类别的 URL 标识。

useTopicAliases (Boolean)

也检查类别的标识别名。

市场列表

查找单个市场列表。

marketplaceListing 的参数

名称描述

slug (String!)

选择与该标识匹配的列表。它是列表在其 URL 中使用的短名称。

市场列表

查找市场列表。

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)

也检查类别的标识别名。

viewerCanAdmin (Boolean)

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

withFreeTrialsOnly (Boolean)

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

默认值为false

meta

返回有关GitHub实例的信息。

node

根据其ID获取对象。

类型:Node

node的参数

名称描述

id (ID!)

对象的 ID。

nodes

通过ID列表查找节点。

类型:[Node]!

nodes的参数

名称描述

ids ([ID!]!)

节点ID列表。

organization

按登录名查找组织。

类型:Organization

organization的参数

名称描述

login (String!)

组织的登录名。

rateLimit

客户端的速率限制信息。

类型:RateLimit

rateLimit的参数

名称描述

dryRun (Boolean)

如果为true,则计算查询的成本而不进行评估。

默认值为false

relay

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

类型:Query!

repository

按所有者和存储库名称查找给定的存储库。

类型: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时使用。

2022年7月1日UTC即将进行的更改 说明:dependencyEcosystem 将被删除。请改用ecosystem参数。 原因:类型将从SecurityAdvisoryEcosystem更改为DependencyGraphEcosystem。

ecosystem (DependencyGraphEcosystem)

用于筛选应检查其可赞助所有者的依赖项的可选过滤器。仅包含此生态系统中依赖项的可赞助所有者。仅在onlyDependencies = true时使用。

first (Int)

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

last (Int)

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

onlyDependencies (Boolean)

是否只返回拥有查看者依赖项的可赞助者。必须经过身份验证才能使用。可以通过传递orgLoginForDependencies来检查组织的依赖项,这些依赖项由可赞助者拥有。如果您不是组织的管理员,则只考虑其公共存储库中的依赖项。

默认值为false

orderBy (SponsorableOrder)

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

orgLoginForDependencies (String)

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

topic

按名称查找主题。

类型:Topic

topic的参数

名称描述

name (String!)

主题的名称。

user

按登录名查找用户。

类型:User

user的参数

名称描述

login (String!)

用户的登录名。

viewer

当前已认证的用户。

类型:User!