问题事件由 issue 与 pull request 中的活动触发,可通过 REST API 查看问题事件和时间线事件。每种事件类型会指明该事件是仅在 issue 事件 API、仅在时间线事件 API,或两者都可用。
GitHub 的 REST API 将每个 pull request 视为 issue,但并非所有 issue 都是 pull request。因此,Issue Events 与 Timeline Events 接口在响应中可能同时返回 issue 与 pull request。pull request 在 issue 对象中拥有一个 pull_request 属性。由于 pull request 本身也是 issue,同一仓库中 issue 编号与 pull request 编号不会冲突。例如,你在仓库中创建的第一个 issue 编号为 1,随后创建的第一个 pull request 编号即为 2。每种事件类型会指明该事件发生于 pull request、issue,或两者皆可。
问题事件对象通用属性
除仅在时间线事件 API 中可用的事件外,所有问题事件均遵循相同的对象结构。部分事件还会包含额外属性,用于提供关于事件资源的更多上下文信息。有关与此对象格式不同的属性,请参阅对应的事件说明。
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
assigned
该 issue 或 pull request 已被分配给某位用户。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for assigned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
assignee | object | 被分配到此 issue 的用户。 |
assigner | object | 执行分配操作的用户。此字段在 issue events API 中可用,但在 timeline events API 中不可用。 |
automatic_base_change_failed
GitHub 未能成功自动更改 pull request 的 base 分支。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for automatic_base_change_failed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
automatic_base_change_succeeded
GitHub 成功自动更改了 pull request 的 base 分支。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for automatic_base_change_succeeded
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
base_ref_changed
pull request 的 base 引用分支已更改。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for base_ref_changed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
closed
该 issue 或 pull request 已关闭。当出现 commit_id 时,它指明使用 “closes / fixes” 语法关闭 issue 的提交。有关该语法的更多信息,请参阅将 pull request 与 issue 关联。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for closed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
commented
在 issue 或 pull request 中添加了评论。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for commented
此事件的属性结构不同于问题事件对象通用属性。以下属性会随该事件返回。
| 名称 | 类型 | 描述 |
|---|---|---|
url | string | 获取该 issue 评论的 REST API URL。 |
html_url | string | 该 issue 评论的 HTML URL。 |
issue_url | string | 该 issue 的 HTML URL。 |
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
user | object | 发表评论的用户。 |
created_at | string | 评论添加时间的时间戳。 |
updated_at | string | 评论更新时间的时间戳;如果评论从未更新,则为创建时间。 |
author_association | string | 用户在该 issue 所在仓库中的权限。例如,若仓库所有者创建了评论,则该值为 "OWNER"。 |
body | string | 评论正文文本。 |
event | string | 事件值为 "commented"。 |
actor | object | 触发该事件的用户。 |
committed
向 pull request 的 HEAD 分支添加了提交。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for committed
此事件的属性结构不同于问题事件对象通用属性。以下属性会随该事件返回。
| 名称 | 类型 | 描述 |
|---|---|---|
sha | string | pull request 中该提交的 SHA。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 获取该提交的 REST API URL。 |
html_url | string | 该提交的 HTML URL。 |
author | object | 提交的作者。 |
committer | object | 代表作者提交该提交的用户。 |
tree | object | 该提交的 Git 树对象。 |
message | string | 提交信息。 |
parents | array of objects | 父提交列表。 |
verification | object | 对提交签名进行验证的结果。更多信息请参阅Git 提交的 REST API 端点。 |
event | string | 事件值为 "committed"。 |
connected
该 issue 或 pull request 已链接至另一个 issue 或 pull request。更多信息请参阅将 pull request 与 issue 关联。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for connected
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
convert_to_draft
pull request 已转换为草稿模式。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for convert_to_draft
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
converted_to_discussion
issue 已关闭并转换为 discussion(讨论)。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 |
Properties for converted_to_discussion
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
cross-referenced
该 issue 或 pull request 被其他 issue 或 pull request 引用。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for cross-referenced
此事件的属性结构不同于问题事件对象通用属性。以下属性会随该事件返回。
| 名称 | 类型 | 描述 |
|---|---|---|
actor | object | 触发该事件的用户。 |
created_at | string | 交叉引用添加时间的时间戳。 |
updated_at | string | 交叉引用更新或创建时间的时间戳(若从未更新则为创建时间)。 |
来源 | object | 添加交叉引用的 issue 或 pull request。 |
source[type] | string | 此值始终为 "issue",因为 pull request 本质上是 issue。只有由 issue 或 pull request 触发的 cross‑reference 事件会在时间线事件的 REST API 中返回。要判断触发事件的 issue 是否为 pull request,只需检查 source[issue][pull_request] 对象是否存在。 |
source[issue] | object | 添加 cross‑reference 的 issue 对象。 |
event | string | 事件值为 "cross-referenced"。 |
demilestoned
该 issue 或 pull request 已从里程碑中移除。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for demilestoned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
里程碑 | object | 里程碑对象。 |
milestone[title] | string | 里程碑标题。 |
deployed
pull request 已部署。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for deployed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
deployment_environment_changed
pull request 的部署环境已更改。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for deployment_environment_changed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
disconnected
该 issue 或 pull request 已与另一 issue 或 pull request 取消链接。更多信息请参阅将 pull request 与 issue 关联。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for disconnected
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
head_ref_deleted
pull request 的 HEAD 分支已被删除。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for head_ref_deleted
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
head_ref_restored
pull request 的 HEAD 分支已恢复至最近一次已知提交。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
head_ref_force_pushed
pull request 的 HEAD 分支被强制推送。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for head_ref_force_pushed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
labeled
向 issue 或 pull request 添加了标签。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for labeled
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
label | object | 添加或删除的标签 |
label[name] | string | 标签名称。 |
label[color] | string | 十六进制颜色码。 |
locked
issue 或 pull request 已被锁定。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for locked
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
lock_reason | string | 锁定对话的原因(如果提供了)。 |
mentioned
在 issue 或 pull request 正文中 @mentioned 了 actor。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for mentioned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
marked_as_duplicate
具有写权限的用户将某 issue 标记为另一个 issue 的重复,或将某 pull request 标记为另一个 pull request 的重复。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for marked_as_duplicate
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
merged
pull request 已合并。commit_id 属性为被合并的 HEAD 提交的 SHA1,commit_repository 与主仓库相同。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for merged
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
milestoned
issue 或 pull request 已被添加至里程碑。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for milestoned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
里程碑 | object | 里程碑对象。 |
milestone[title] | string | 里程碑标题。 |
pinned
issue 已置顶。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 |
Properties for pinned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
ready_for_review
草稿 pull request 已标记为可供审查。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for ready_for_review
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
referenced
issue 在提交信息中被引用。commit_id 为对应提交的 SHA1,commit_repository 为该提交所在的仓库。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for referenced
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
renamed
issue 或 pull request 的标题已更改。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for renamed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
rename | object | 名称详情。 |
rename[from] | string | 之前的名称。 |
rename[to] | string | 新的名称。 |
reopened
issue 或 pull request 已重新打开。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for reopened
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
review_dismissed
pull request 的审查已被驳回。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for review_dismissed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
dismissed_review | object | 驳回审查的信息。 |
dismissed_review[state] | string | 驳回时 pull request 所处的状态,可为 commented、approved 或 changes_requested。 |
dismissed_review[review_id] | string | pull request 审查的唯一标识符。 |
dismissed_review[dismissal_message] | string | 用户驳回审查时填写的消息。 |
dismissed_review[dismissal_commit_id] | string | 驳回该审查的提交的唯一标识符(若存在)。 |
review_requested
对 pull request 发起了审查请求。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for review_requested
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
requested_reviewer | object | 被请求审查该 pull request 的用户。 |
review_requester | object | 发起审查请求的用户。 |
review_request_removed
pull request 的审查请求被移除。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for review_request_removed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
requested_reviewer | object | 被请求审查该 pull request 的用户。 |
review_requester | object | 发起审查请求的用户。 |
reviewed
pull request 已完成审查。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 拉取请求 |
Properties for reviewed
此事件的属性结构不同于问题事件对象通用属性。以下属性会随该事件返回。
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
user | object | 发表评论的用户。 |
body | string | 审查摘要文本。 |
commit_id | string | 审查时 pull request 中最新提交的 SHA。 |
submitted_at | string | 审查提交时间的时间戳。 |
状态 | string | 提交审查的状态,可为 commented、changes_requested、approved 或 dismissed。 |
html_url | string | 审查的 HTML URL。 |
pull_request_url | string | 获取该 pull request 的 REST API URL。 |
author_association | string | 用户在该 issue 所在仓库中的权限。例如,若仓库所有者创建了评论,则该值为 "OWNER"。 |
_links | object | 包括 html_url 与 pull_request_url。 |
event | string | 事件值为 "reviewed"。 |
subscribed
有人订阅了该 issue 或 pull request,以接收通知。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for subscribed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
transferred
issue 已转移至另一个仓库。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 |
Properties for transferred
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
unassigned
某用户已被从该 issue 中取消分配。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for unassigned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
assignee | object | 被取消分配的用户。 |
assigner | object | 执行取消分配操作的用户。此字段在 issue events API 中可用,但在 timeline events API 中不可用。 |
unlabeled
该 issue 的标签被移除。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for unlabeled
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
label | object | 添加或删除的标签 |
label[name] | string | 标签名称。 |
label[color] | string | 十六进制颜色码。 |
unlocked
issue 已解锁。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for unlocked
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
lock_reason | string | 锁定对话的原因(如果提供了)。 |
unmarked_as_duplicate
之前被标记为重复的 issue(或 pull request)已不再视为重复。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for unmarked_as_duplicate
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
unpinned
issue 已取消置顶。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 |
Properties for unpinned
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
unsubscribed
有人取消订阅该 issue 或 pull request 的通知。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for unsubscribed
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |
user_blocked
组织所有者在组织内阻止了某用户。此操作是通过在该用户的 issue 评论中进行的。
此事件适用于以下 issue 类型。
| REST API for issue events | REST API for timeline events | |
|---|---|---|
| 议题 | ||
| 拉取请求 |
Properties for user_blocked
| 名称 | 类型 | 描述 |
|---|---|---|
id | integer | 事件的唯一标识符。 |
node_id | string | 事件的全局节点 ID。 |
url | string | 用于获取该事件的 REST API URL。 |
actor | object | 触发该事件的用户。 |
event | string | 标识实际发生的事件类型。 |
commit_id | string | 引用此 issue 的提交的 SHA。 |
commit_url | string | 引用此 issue 的提交在 GitHub REST API 中的链接。 |
created_at | string | 表示事件发生时间的时间戳。 |