接口充当其他对象可以继承的父对象。

本文内容

关于接口

接口 充当其他对象可以继承的父对象。

例如，Lockable 是一个接口，因为 Issue 和 PullRequest 对象都可以被锁定。接口拥有自己的命名字段列表，这些字段在实现它的对象之间共享。

更多信息请参阅 GraphQL 介绍。

Actor（行为者）

表示可以在 GitHub 上执行操作的对象。通常是用户或机器人。

Actor 的实现对象包括

Actor 的字段

名称描述

avatarUrl (URI!)

指向行为者公开头像的 URL。

avatarUrl 的参数

  • size (Int)

    生成的正方形图像的尺寸。

login (String!)

参与者的用户名。

resourcePath (URI!)

此行为者的 HTTP 路径。

url (URI!)

此行为者的 HTTP URL。

Agentic（代理）

Copilot Agentic 字段，针对当前查看者的上下文。

Agentic 的实现对象包括

Agentic 的字段

名称描述

viewerCopilotAgentCreatesChannel (String)

用于订阅会话创建实时更新的频道值。

viewerCopilotAgentLogUpdatesChannel (String)

用于订阅会话日志更新实时更新的频道值。

viewerCopilotAgentTaskUpdatesChannel (String)

用于订阅任务更新实时更新的频道值。

viewerCopilotAgentUpdatesChannel (String)

用于订阅会话更新实时更新的频道值。

Assignable（可指派）

可以为其指派用户的对象。

Assignable 的实现对象包括

Assignable 的字段

名称描述

assignedActors (AssigneeConnection!)

指派给此对象的行为者列表。

assignedActors 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

assignees (UserConnection!)

指派给此对象的用户列表。

assignees 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

suggestedActors (AssigneeConnection!)

建议指派给此对象的行为者列表。

suggestedActors 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • query (String)

    如果提供，将按登录名或个人资料名称搜索用户。

AuditEntry（审计条目）

审计日志中的一条记录。

AuditEntry 的实现对象包括

AuditEntry 的字段

名称描述

action (String!)

操作名称。

警告

action 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

actor (AuditEntryActor)

发起该操作的用户。

警告

actor 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

actorIp (String)

行为者的 IP 地址。

警告

actorIp 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

actorLocation (ActorLocation)

对行为者位置的可读表示。

警告

actorLocation 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

actorLogin (String)

发起该操作的用户的用户名。

警告

actorLogin 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

actorResourcePath (URI)

行为者的 HTTP 路径。

警告

actorResourcePath 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

actorUrl (URI)

行为者的 HTTP URL。

警告

actorUrl 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

createdAt (PreciseDateTime!)

操作发起的时间。

警告

createdAt 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

operationType (OperationType)

对应于该操作的操作类型。

警告

operationType 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

user (User)

受该操作影响的用户。

警告

user 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

userLogin (String)

当涉及两个用户时，actor 为发起者，user 为受影响的用户。

警告

userLogin 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

userResourcePath (URI)

用户的 HTTP 路径。

警告

userResourcePath 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

userUrl (URI)

用户的 HTTP URL。

警告

userUrl 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

Closable（可关闭）

可以被关闭的对象。

Closable 的实现对象包括

Closable 的字段

名称描述

closed (Boolean!)

指示对象是否已关闭（具体含义取决于对象类型）。

closedAt (DateTime)

标识对象关闭的日期和时间。

viewerCanClose (Boolean!)

指示当前查看者是否可以关闭该对象。

viewerCanReopen (Boolean!)

指示当前查看者是否可以重新打开该对象。

Comment（评论）

表示一条评论。

Comment 的实现对象包括

Comment 的字段

名称描述

author (Actor)

撰写该评论的行为者。

authorAssociation (CommentAuthorAssociation!)

作者与评论主题之间的关联。

body (String!)

正文以 Markdown 形式呈现。

bodyHTML (HTML!)

渲染为 HTML 的正文。

bodyText (String!)

渲染为纯文本的正文。

createdAt (DateTime!)

标识对象创建的日期和时间。

createdViaEmail (Boolean!)

检查此评论是否通过电子邮件回复创建。

editor (Actor)

编辑该评论的行为者。

id (ID!)

Comment 对象的 Node ID。

includesCreatedEdit (Boolean!)

检查此评论是否已被编辑且包含创建编辑的数据。

lastEditedAt (DateTime)

编辑者进行最后一次编辑的时间点。

publishedAt (DateTime)

标识评论何时被发布。

updatedAt (DateTime!)

标识对象最后一次更新的日期和时间。

userContentEdits (UserContentEditConnection)

此内容的编辑列表。

userContentEdits 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

viewerDidAuthor (Boolean!)

查看者是否为该评论的作者。

Contribution（贡献）

表示用户在 GitHub 上的贡献，例如创建 issue。

Contribution 的实现对象包括

Contribution 的字段

名称描述

isRestricted (Boolean!)

该贡献是否关联到您无权访问的记录。例如，您的“首次 issue”贡献可能出现在已无法访问的仓库中。

occurredAt (DateTime!)

该贡献发生的时间。

resourcePath (URI!)

此贡献的 HTTP 路径。

url (URI!)

此贡献的 HTTP URL。

user (User!)

进行该贡献的用户。

Deletable（可删除）

可以被删除的实体。

Deletable 的实现对象包括

Deletable 的字段

名称描述

viewerCanDelete (Boolean!)

检查当前查看者是否可以删除此对象。

EnterpriseAuditEntryData（企业审计条目数据）

包含企业账户信息的审计条目的元数据。

EnterpriseAuditEntryData 的实现对象包括

EnterpriseAuditEntryData 的字段

名称描述

enterpriseResourcePath (URI)

此企业的 HTTP 路径。

enterpriseSlug (String)

企业的 slug（短标识）

enterpriseUrl (URI)

此企业的 HTTP URL。

GitObject（Git 对象）

表示一个 Git 对象。

GitObject 的实现对象包括

GitObject 的字段

名称描述

abbreviatedOid (String!)

Git 对象 ID 的缩写形式。

commitResourcePath (URI!)

此 Git 对象的 HTTP 路径。

commitUrl (URI!)

此 Git 对象的 HTTP URL。

id (ID!)

GitObject 对象的 Node ID。

oid (GitObjectID!)

Git 对象的 ID。

repository (Repository!)

该 Git 对象所属的仓库。

GitSignature（Git 签名）

关于提交或标签上签名（GPG 或 S/MIME）的信息。

GitSignature 的实现对象包括

GitSignature 的字段

名称描述

email (String!)

用于签署此对象的电子邮件。

isValid (Boolean!)

若签名有效且已被 GitHub 验证，则为 true。

payload (String!)

GPG 签名对象的有效负载。原始 ODB 对象，不含签名头部。

signature (String!)

对象中的 ASCII 装甲签名头部。

signer (User)

提交签名所用电子邮件对应的 GitHub 用户。

state (GitSignatureState!)

此签名的状态。若为 VALID 则表示签名有效且已被 GitHub 验证，否则说明签名无效的原因。

verifiedAt (DateTime)

签名被验证（若有效）的日期。

wasSignedByGitHub (Boolean!)

若签名使用 GitHub 的签名密钥，则为 true。

HovercardContext（悬停卡上下文）

悬停卡中的一行信息。

HovercardContext 的实现对象包括

HovercardContext 的字段

名称描述

message (String!)

描述此上下文的字符串。

octicon (String!)

伴随此上下文的 Octicon 图标。

IssueFieldCommon（问题字段公共属性）

不同问题字段类型的公共字段。

IssueFieldCommon 的实现对象包括

IssueFieldCommon 的字段

名称描述

createdAt (DateTime!)

问题字段的创建时间戳。

dataType (IssueFieldDataType!)

问题字段的数据类型。

description (String)

问题字段的描述。

name (String!)

问题字段的名称。

visibility (IssueFieldVisibility!)

问题字段的可见性。

IssueFieldValueCommon（问题字段值公共属性）

不同问题字段值类型的公共字段。

IssueFieldValueCommon 的实现对象包括

IssueFieldValueCommon 的字段

名称描述

field (IssueFields)

包含此值的问题字段。

Labelable（可贴标签）

可以为其分配标签的对象。

Labelable 的实现对象包括

Labelable 的字段

名称描述

labels (LabelConnection)

与该对象关联的标签列表。

labels 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • orderBy (LabelOrder)

    返回的标签连接的排序选项。

viewerCanLabel (Boolean!)

指示查看者是否可以编辑此对象的标签。

Lockable（可锁定）

可以被锁定的对象。

Lockable 的实现对象包括

Lockable 的字段

名称描述

activeLockReason (LockReason)

对话被锁定的原因。

locked (Boolean!)

true 表示对象已锁定。

MemberStatusable（成员状态可设置）

拥有成员可以设置状态信息的实体。

MemberStatusable 的实现对象包括

MemberStatusable 的字段

名称描述

memberStatuses (UserStatusConnection!)

获取此实体成员已设置的、公开或仅对组织可见的状态消息。

memberStatuses 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

Migration（迁移）

表示 GitHub Enterprise Importer（GEI）迁移。

Migration 的实现对象包括

Migration 的字段

名称描述

continueOnError (Boolean!)

在出错时继续迁移的标志。

createdAt (DateTime!)

标识对象创建的日期和时间。

databaseId (String)

数据库中的主键标识。

failureReason (String)

迁移失败的原因。

id (ID!)

迁移对象的 Node ID。

migrationLogUrl (URI)

迁移日志的 URL（迁移完成后 1 天失效）。

migrationSource (MigrationSource!)

迁移来源。

repositoryName (String!)

目标仓库名称。

sourceUrl (URI!)

迁移源 URL，例如 https://github.com 或 https://monalisa.ghe.com。

state (MigrationState!)

迁移状态。

warningsCount (Int!)

此迁移遇到的警告数量。要查看警告，请检查 迁移日志。

Minimizable（可最小化）

可以被最小化的实体。

Minimizable 的实现对象包括

Minimizable 的字段

名称描述

isMinimized (Boolean!)

返回评论是否已被最小化。

minimizedReason (String)

返回评论被最小化的原因。可能的值为 abuse、off-topic、outdated、resolved、duplicate、spam 和 low-quality。请注意，这些值的大小写和格式与 MinimizeComment 变更中的输入不同。

viewerCanMinimize (Boolean!)

检查当前查看者是否可以最小化此对象。

viewerCanUnminimize (Boolean!)

检查当前查看者是否可以取消最小化此对象。

Node

具有 ID 的对象。

Node 的实现包括

针对 Node 的字段

名称描述

id (ID!)

对象的 ID。

OauthApplicationAuditEntryData

带有 oauth_application.* 操作的审计条目的元数据。

OauthApplicationAuditEntryData 的实现包括

针对 OauthApplicationAuditEntryData 的字段

名称描述

oauthApplicationName (String)

OAuth 应用的名称。

oauthApplicationResourcePath (URI)

OAuth 应用的 HTTP 路径。

oauthApplicationUrl (URI)

OAuth 应用的 HTTP URL。

OrganizationAuditEntryData

带有 org.* 操作的审计条目的元数据。

OrganizationAuditEntryData 的实现包括

针对 OrganizationAuditEntryData 的字段

名称描述

organization (Organization)

与此审计条目关联的组织。

警告

organization 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

organizationName (String)

组织的名称。

警告

organizationName 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

organizationResourcePath (URI)

组织的 HTTP 路径。

警告

organizationResourcePath 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

organizationUrl (URI)

组织的 HTTP URL。

警告

organizationUrl 已弃用。

GraphQL 审计日志已弃用，请改用 REST API。将在 2026‑04‑01 UTC 移除。

PackageOwner

表示软件包的拥有者。

PackageOwner 的实现包括

针对 PackageOwner 的字段

名称描述

id (ID!)

PackageOwner 对象的 Node ID。

packages (PackageConnection!)

此拥有者下的所有软件包列表。

packages 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • names ([String])

    按名称查找软件包。

  • packageType (PackageType)

    按类型过滤注册表中的软件包。

  • repositoryId (ID)

    按 ID 在仓库中查找软件包。

Pinnable

可以被置顶的实体。

Pinnable 的实现包括

针对 Pinnable 的字段

名称描述

isPinned (Boolean)

指示此实体当前是否已被置顶。

pinnedAt (DateTime)

标识此实体被置顶的日期和时间。

pinnedBy (User)

置顶此实体的用户。

viewerCanPin (Boolean!)

检查当前查看者是否可以置顶此实体。

viewerCanUnpin (Boolean!)

检查当前查看者是否可以取消置顶此实体。

ProfileOwner

表示在 GitHub 上拥有个人资料页面的任何实体。

ProfileOwner 的实现包括

针对 ProfileOwner 的字段

名称描述

anyPinnableItems (Boolean!)

确定此仓库拥有者是否拥有可以固定到其个人资料的任何项目。

anyPinnableItems 的参数

email (String)

公开的个人资料电子邮件。

id (ID!)

ProfileOwner 对象的 Node ID。

itemShowcase (ProfileItemShowcase!)

展示该个人资料拥有者挑选或基于流行度自动选择的一组仓库和 gist。

location (String)

公开的个人资料位置。

login (String!)

用于登录的用户名。

name (String)

公开的个人资料名称。

pinnableItems (PinnableItemConnection!)

此个人资料拥有者可以固定到其个人资料的仓库和 gist 列表。

pinnableItems 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

pinnedItems (PinnableItemConnection!)

此个人资料拥有者已固定到个人资料的仓库和 gist 列表。

pinnedItems 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

pinnedItemsRemaining (Int!)

返回此个人资料拥有者还能再固定多少项目。

viewerCanChangePinnedItems (Boolean!)

查看者是否可以将仓库和 gist 固定到个人资料？

websiteUrl (URI)

公开的个人资料网站 URL。

ProjectOwner

表示项目的所有者。

ProjectOwner 的实现包括

针对 ProjectOwner 的字段

名称描述

id (ID!)

ProjectOwner 对象的 Node ID。

警告

id 已弃用。

项目 (经典) 正被弃用，转而使用新的项目体验，请参阅：https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/。将于 2025-04-01 UTC 移除。

project (Project)

按编号查找项目。

警告

project 已弃用。

项目 (经典) 正被弃用，转而使用新的项目体验，请参阅：https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/。将于 2025-04-01 UTC 移除。

project 的参数

  • number (Int!)

    要查找的项目编号。

projects (ProjectConnection!)

此所有者下的项目列表。

警告

projects 已弃用。

项目 (经典) 正被弃用，转而使用新的项目体验，请参阅：https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/。将于 2025-04-01 UTC 移除。

projects 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • search (String)

    查询用于搜索项目，目前仅支持按名称搜索。

projectsResourcePath (URI!)

列出所有者项目的 HTTP 路径。

警告

projectsResourcePath 已弃用。

项目 (经典) 正被弃用，转而使用新的项目体验，请参阅：https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/。将于 2025-04-01 UTC 移除。

projectsUrl (URI!)

列出所有者项目的 HTTP URL。

警告

projectsUrl 已弃用。

项目 (经典) 正被弃用，转而使用新的项目体验，请参阅：https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/。将于 2025-04-01 UTC 移除。

viewerCanCreateProjects (Boolean!)

当前查看者是否可以在此所有者上创建新项目。

警告

viewerCanCreateProjects 已弃用。

项目 (经典) 正被弃用，转而使用新的项目体验，请参阅：https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/。将于 2025-04-01 UTC 移除。

ProjectV2Event

表示与项目相关的、位于议题或拉取请求时间轴上的事件。

ProjectV2Event 的实现包括

针对 ProjectV2Event 的字段

名称描述

project (ProjectV2)

事件引用的项目。

wasAutomated (Boolean!)

此事件是否由工作流自动化触发？

ProjectV2FieldCommon

不同项目字段类型的通用字段。

ProjectV2FieldCommon 的实现包括

针对 ProjectV2FieldCommon 的字段

名称描述

createdAt (DateTime!)

标识对象创建的日期和时间。

dataType (ProjectV2FieldType!)

字段的类型。

databaseId (Int)

数据库中的主键标识。

id (ID!)

ProjectV2FieldCommon 对象的 Node ID。

name (String!)

项目字段的名称。

project (ProjectV2!)

包含此字段的项目。

updatedAt (DateTime!)

标识对象最后一次更新的日期和时间。

ProjectV2ItemFieldValueCommon

不同项目字段值类型的通用字段。

ProjectV2ItemFieldValueCommon 的实现包括

针对 ProjectV2ItemFieldValueCommon 的字段

名称描述

createdAt (DateTime!)

标识对象创建的日期和时间。

creator (Actor)

创建该条目的行为者。

databaseId (Int)

数据库中的主键标识。

field (ProjectV2FieldConfiguration!)

包含此值的项目字段。

id (ID!)

ProjectV2ItemFieldValueCommon 对象的 Node ID。

item (ProjectV2Item!)

包含此值的项目条目。

updatedAt (DateTime!)

标识对象最后一次更新的日期和时间。

ProjectV2Owner

表示项目的所有者。

ProjectV2Owner 的实现包括

针对 ProjectV2Owner 的字段

名称描述

id (ID!)

ProjectV2Owner 对象的 Node ID。

projectV2 (ProjectV2)

按编号查找项目。

projectV2 的参数

  • number (Int!)

    项目编号。

projectsV2 (ProjectV2Connection!)

此所有者下的项目列表。

projectsV2 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • query (String)

    在所有者下搜索的项目。

ProjectV2Recent

所有者的近期项目。

ProjectV2Recent 的实现包括

针对 ProjectV2Recent 的字段

名称描述

recentProjects (ProjectV2Connection!)

此用户在该所有者上下文中最近修改的项目。

recentProjects 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

Reactable

表示可以被添加表情反应的主体。

Reactable 的实现包括

针对 Reactable 的字段

名称描述

databaseId (Int)

数据库中的主键标识。

id (ID!)

Reactable 对象的 Node ID。

reactionGroups ([ReactionGroup!])

按内容分组的表情反应列表。

reactions (ReactionConnection!)

在议题上留下的表情反应列表。

reactions 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • orderBy (ReactionOrder)

    指定返回表情反应的排序方式。

viewerCanReact (Boolean!)

用户是否可以对该主体表情反应。

RepositoryAuditEntryData

带有 repo.* 操作的审计条目的元数据。

RepositoryAuditEntryData 的实现包括

针对 RepositoryAuditEntryData 的字段

名称描述

repository (Repository)

与此操作关联的仓库。

repositoryName (String)

仓库名称。

repositoryResourcePath (URI)

仓库的 HTTP 路径。

repositoryUrl (URI)

仓库的 HTTP URL。

RepositoryDiscussionAuthor

表示仓库中讨论的作者。

RepositoryDiscussionAuthor 的实现包括

针对 RepositoryDiscussionAuthor 的字段

名称描述

repositoryDiscussions (DiscussionConnection!)

此用户发起的讨论。

repositoryDiscussions 的参数

  • after (String)

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

  • answered (Boolean)

    仅筛选已回答或未回答的讨论。默认包括已回答和未回答的讨论。

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • repositoryId (ID)

    仅筛选特定仓库中的讨论。

RepositoryDiscussionCommentAuthor

表示仓库中讨论评论的作者。

RepositoryDiscussionCommentAuthor 的实现包括

针对 RepositoryDiscussionCommentAuthor 的字段

名称描述

repositoryDiscussionComments (DiscussionCommentConnection!)

此用户撰写的讨论评论。

repositoryDiscussionComments 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • onlyAnswers (Boolean)

    仅筛选标记为答案的讨论评论。

    默认值为 false。

  • repositoryId (ID)

    仅筛选特定仓库中的讨论评论。

RepositoryInfo

仓库信息的子集。

RepositoryInfo 的实现包括

针对 RepositoryInfo 的字段

名称描述

archivedAt (DateTime)

标识仓库被归档的日期和时间。

createdAt (DateTime!)

标识对象创建的日期和时间。

description (String)

仓库的描述。

descriptionHTML (HTML!)

渲染为 HTML 的仓库描述。

forkCount (Int!)

返回整个网络中此仓库的 fork 数量。

hasDiscussionsEnabled (Boolean!)

指示仓库是否启用了 Discussions 功能。

hasIssuesEnabled (Boolean!)

指示仓库是否启用了 Issue 功能。

hasProjectsEnabled (Boolean!)

指示仓库是否启用了 Projects 功能。

hasPullRequestsEnabled (Boolean!)

指示仓库是否启用了 Pull Request 功能。

hasSponsorshipsEnabled (Boolean!)

指示仓库是否显示用于资金捐助的“赞助 (Sponsor)”按钮。

hasWikiEnabled (Boolean!)

指示仓库是否启用了 Wiki 功能。

homepageUrl (URI)

仓库的 URL。

isArchived (Boolean!)

指示仓库是否已归档且不再维护。

isFork (Boolean!)

标识仓库是否为 fork。

isInOrganization (Boolean!)

指示仓库是否属于组织，或是组织仓库的私有 fork。

isLocked (Boolean!)

指示仓库是否已被锁定。

isMirror (Boolean!)

标识仓库是否为镜像。

isPrivate (Boolean!)

标识仓库是私有还是内部的。

isTemplate (Boolean!)

标识仓库是否为可用于生成新仓库的模板。

licenseInfo (License)

与仓库关联的许可证信息。

lockReason (RepositoryLockReason)

仓库被锁定的原因。

mirrorUrl (URI)

仓库的原始镜像 URL。

name (String!)

仓库名称。

nameWithOwner (String!)

仓库的完整名称（含所有者）。

openGraphImageUrl (URI!)

用于在 Open Graph 数据中表示此仓库的图片 URL。

owner (RepositoryOwner!)

仓库的用户所有者。

pullRequestCreationPolicy (PullRequestCreationPolicy)

控制谁可以在此仓库中创建拉取请求的策略。

pushedAt (DateTime)

标识仓库最近一次推送的日期和时间。

resourcePath (URI!)

此仓库的 HTTP 路径。

shortDescriptionHTML (HTML!)

不含任何链接的、渲染为 HTML 的简短仓库描述。

shortDescriptionHTML 的参数

  • limit (Int)

    返回的字符数上限。

    默认值为 200。

updatedAt (DateTime!)

标识对象最后一次更新的日期和时间。

url (URI!)

此仓库的 HTTP URL。

usesCustomOpenGraphImage (Boolean!)

该仓库是否使用自定义 Open Graph 图片（而不是所有者的头像）。

visibility (RepositoryVisibility!)

指示仓库的可见性级别。

RepositoryOwner

表示仓库的所有者。

RepositoryOwner 的实现包括

针对 RepositoryOwner 的字段

名称描述

avatarUrl (URI!)

指向所有者公开头像的 URL。

avatarUrl 的参数

  • size (Int)

    生成的正方形图像的尺寸。

id (ID!)

RepositoryOwner 对象的 Node ID。

login (String!)

用于登录的用户名。

repositories (RepositoryConnection!)

用户拥有的仓库列表。

repositories 的参数

  • affiliations ([RepositoryAffiliation])

    返回的仓库的查看者关联选项数组。例如，OWNER 将仅包含当前查看者拥有的仓库。

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • hasIssuesEnabled (Boolean)

    若非空，则根据仓库是否启用 Issue 功能进行过滤。

  • isArchived (Boolean)

    若非空，则根据仓库是否已归档且不再维护进行过滤。

  • isFork (Boolean)

    若非空，则根据仓库是否为其他仓库的 fork 进行过滤。

  • isLocked (Boolean)

    若非空，则根据仓库是否已被锁定进行过滤。

  • last (Int)

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

  • ownerAffiliations ([RepositoryAffiliation])

    返回仓库的所有者关联选项数组。例如，OWNER 将仅包含组织或用户拥有的仓库。

  • privacy (RepositoryPrivacy)

    若非空，则根据仓库的隐私性进行过滤。内部仓库视为私有；若仅需内部仓库，请使用 visibility 参数。该参数不能与 visibility 同时使用。

  • visibility (RepositoryVisibility)

    若非空，则根据仓库的可见性进行过滤。不能与 privacy 参数同时使用。

repository (Repository)

查找仓库。

repository 的参数

  • followRenames (Boolean)

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

    默认值为 true。

  • name (String!)

    要查找的仓库名称。

resourcePath (URI!)

所有者的 HTTP URL。

url (URI!)

所有者的 HTTP URL。

RequirableByPullRequest

表示可被拉取请求在合并前要求满足的类型。

RequirableByPullRequest 的实现包括

针对 RequirableByPullRequest 的字段

名称描述

isRequired (Boolean!)

针对特定拉取请求，在合并前是否必须满足此条件。

isRequired 的参数

  • pullRequestId (ID)

    此条件所适用的拉取请求 ID。

  • pullRequestNumber (Int)

    此条件所适用的拉取请求编号。

Sponsorable

可以通过 GitHub Sponsors 发起或接受赞助的实体。

Sponsorable 的实现包括

针对 Sponsorable 的字段

名称描述

estimatedNextSponsorsPayoutInCents (Int!)

此用户/组织的下一个 GitHub Sponsors 支付金额（以美分计，USD）。

hasSponsorsListing (Boolean!)

若此用户/组织拥有 GitHub Sponsors 列表，则为 true。

isSponsoredBy (Boolean!)

给定账户是否正在赞助此用户/组织。

isSponsoredBy 的参数

  • accountLogin (String!)

    目标账户的登录名。

isSponsoringViewer (Boolean!)

若查看者正在被此用户/组织赞助，则为 true。

lifetimeReceivedSponsorshipValues (SponsorAndLifetimeValueConnection!)

计算每位赞助者通过 GitHub Sponsors 向该维护者累计支付的总额（不包括 via Patreon 支付的赞助）。

lifetimeReceivedSponsorshipValues 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

monthlyEstimatedSponsorsIncomeInCents (Int!)

此用户/组织的 GitHub Sponsors 预计月收入（以美分计，USD）。

sponsoring (SponsorConnection!)

该实体正在赞助的用户和组织列表。

sponsoring 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • orderBy (SponsorOrder)

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

sponsors (SponsorConnection!)

此用户或组织的赞助者列表。

sponsors 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • orderBy (SponsorOrder)

    对从连接返回的赞助者进行排序的选项。

  • tierId (ID)

    如果提供，将根据指定的等级过滤赞助者。仅返回查看者有权查看其等级的赞助者。

sponsorsActivities (SponsorsActivityConnection!)

涉及此可赞助对象的事件，例如新的赞助。

sponsorsActivities 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • includeAsSponsor (Boolean)

    是否包括该可赞助对象作为赞助者的事件。默认仅包括该对象作为赞助接受者的事件。

    默认值为 false。

  • includePrivate (Boolean)

    是否在结果集中包含私有活动。默认包括公开和私有活动。

    默认值为 true。

  • last (Int)

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

  • period (SponsorsActivityPeriod)

    仅过滤为最近指定时间段内发生的活动。设置为 ALL 可避免按活动发生时间进行过滤。如果提供了 since 或 until，此参数将被忽略。

    默认值为 MONTH。

  • since (DateTime)

    仅过滤在此时间或之后发生的活动。

  • until (DateTime)

    仅过滤在此时间之前发生的活动。

sponsorsListing (SponsorsListing)

此用户或组织的 GitHub Sponsors 列表。

sponsorshipForViewerAsSponsor (Sponsorship)

查看者对该用户/组织的赞助，即您作为赞助者的赞助关系。

sponsorshipForViewerAsSponsor 的参数

  • activeOnly (Boolean)

    是否仅在赞助仍然有效时返回。传入 false 可在赞助已取消后仍返回查看者的赞助信息。

    默认值为 true。

sponsorshipForViewerAsSponsorable (Sponsorship)

该用户/组织对查看者的赞助，即您收到的赞助关系。

sponsorshipForViewerAsSponsorable 的参数

  • activeOnly (Boolean)

    是否仅在赞助仍然有效时返回。传入 false 可在赞助已取消后仍返回赞助信息。

    默认值为 true。

sponsorshipNewsletters (SponsorshipNewsletterConnection!)

此可赞助对象发送给赞助者的赞助更新列表。

sponsorshipNewsletters 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

sponsorshipsAsMaintainer (SponsorshipConnection!)

该用户或组织作为维护者接收资金的赞助。

sponsorshipsAsMaintainer 的参数

  • activeOnly (Boolean)

    是否仅包含当前活跃的赞助，而非该维护者曾经收到的所有赞助。

    默认值为 true。

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • includePrivate (Boolean)

    是否在结果集中包含私有赞助。

    默认值为 false。

  • last (Int)

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

  • orderBy (SponsorshipOrder)

    对从此连接返回的赞助进行排序的选项。如果留空，赞助将按与查看者的相关性排序。

sponsorshipsAsSponsor (SponsorshipConnection!)

该用户或组织作为出资者的赞助。

sponsorshipsAsSponsor 的参数

  • activeOnly (Boolean)

    是否仅包含当前活跃的赞助，而非该赞助者曾经进行的所有赞助。

    默认值为 true。

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

  • maintainerLogins ([String!])

    将返回的赞助过滤为指定维护者的赞助。即赞助的接受者为具有给定登录名的用户或组织。

  • orderBy (SponsorshipOrder)

    对从此连接返回的赞助进行排序的选项。如果留空，赞助将按与查看者的相关性排序。

totalSponsorshipAmountAsSponsorInCents (Int)

该实体在 GitHub 上用于赞助的金额（美分，例如 500 = 5.00 美元）。仅在本人或有权管理所请求组织赞助的用户查看时返回值。

totalSponsorshipAmountAsSponsorInCents 的参数

  • since (DateTime)

    仅过滤在此时间或之后发生的付款。

  • sponsorableLogins ([String!])

    仅过滤向具有指定用户名的用户或组织进行的付款。

  • until (DateTime)

    仅过滤在此时间之前发生的付款。

viewerCanSponsor (Boolean!)

查看者是否能够赞助此用户/组织。

viewerIsSponsoring (Boolean!)

如果查看者正在赞助此用户/组织，则为 true。

Starrable

可被加星的对象。

Starrable 的实现者为

Starrable 的字段

名称描述

id (ID!)

Starrable 对象的 Node ID。

stargazerCount (Int!)

返回此对象拥有的星标者数量。

stargazers (StargazerConnection!)

给该可加星对象加星的用户列表。

stargazers 的参数

  • after (String)

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

  • before (String)

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

  • first (Int)

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

  • last (Int)

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

viewerHasStarred (Boolean!)

返回布尔值，指示查看用户是否已为该可加星对象加星。

Subscribable

可以通过网页或电子邮件订阅的实体。

Subscribable 的实现者为

Subscribable 的字段

名称描述

id (ID!)

Subscribable 对象的 Node ID。

viewerCanSubscribe (Boolean!)

检查查看者是否能够更改其对仓库的订阅状态。

viewerSubscription (SubscriptionState)

标识查看者是正在关注、未关注还是忽略该可订阅实体。

SubscribableThread

可以通过网页或电子邮件订阅的实体。

SubscribableThread 的实现者为

SubscribableThread 的字段

名称描述

id (ID!)

SubscribableThread 对象的 Node ID。

viewerThreadSubscriptionFormAction (ThreadSubscriptionFormAction)

标识查看者的线程订阅表单操作。

viewerThreadSubscriptionStatus (ThreadSubscriptionState)

标识查看者的线程订阅状态。

TeamAuditEntryData

针对 team.* 动作的审计条目元数据。

TeamAuditEntryData 的实现者为

TeamAuditEntryData 的字段

名称描述

team (Team)

与该动作关联的团队。

teamName (String)

团队名称。

teamResourcePath (URI)

该团队的 HTTP 路径。

teamUrl (URI)

该团队的 HTTP URL。

TopicAuditEntryData

带有主题的审计条目元数据。

TopicAuditEntryData 的实现者为

TopicAuditEntryData 的字段

名称描述

topic (Topic)

添加到仓库的主题名称。

topicName (String)

添加到仓库的主题名称。

UniformResourceLocatable

表示可以通过 URL 检索的类型。

Updatable

可被更新的实体。

Updatable 的实现者为

Fields for Updatable

名称描述

viewerCanUpdate (Boolean!)

检查当前查看者是否能够更新此对象。

UpdatableComment

可被更新的评论。

UpdatableComment 的实现者为

Fields for UpdatableComment

名称描述

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

当前查看者无法更新此评论的原因。

Votable

可以被投赞成票的主体。

Votable 的实现者为

Fields for Votable

名称描述

upvoteCount (Int!)

该主体收到的赞成票数量。

viewerCanUpvote (Boolean!)

当前用户是否能够对该主体添加或移除赞成票。

viewerHasUpvoted (Boolean!)

当前用户是否已经对该主体投过赞成票。

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