问题事件由问题和拉取请求中的活动触发,并在 REST API 中提供 问题事件 和 时间线事件。每种事件类型都指定事件是否在 REST API 中提供问题事件或时间线事件。
GitHub 的 REST API 将每个拉取请求视为一个问题,但并非每个问题都是拉取请求。因此,问题事件和时间线事件端点可能会在响应中返回问题和拉取请求。拉取请求在 issue
对象中具有 pull_request
属性。由于拉取请求是问题,因此问题和拉取请求编号在存储库中不会重叠。例如,如果您在存储库中打开第一个问题,则编号将为 1。如果您随后打开一个拉取请求,则编号将为 2。每种事件类型都指定事件是否发生在拉取请求、问题或两者中。
问题事件对象通用属性
所有问题事件都具有相同的对象结构,除了仅在 REST API 中用于时间线事件的事件。某些事件还包含其他属性,这些属性提供有关事件资源的更多上下文。有关与该对象格式不同的任何属性的详细信息,请参阅特定事件。
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
added_to_project
问题或拉取请求已添加到项目(经典)。您仅在项目(经典)已在存储库中 启用 时,在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
added_to_project 的属性
注意:项目卡片详细信息现在显示在项目相关问题和时间线事件的 REST API 响应中。此功能现已供开发人员预览。有关详细信息,请参阅 博客文章。
要接收 project_card
属性,项目(经典)必须在仓库中 启用,并且您必须在 Accept
标头中提供自定义 媒体类型
application/vnd.github.starfox-preview+json
警告: 预览期间,API 可能会在未事先通知的情况下发生更改。预览功能不支持生产使用。如果您遇到任何问题,请通过 GitHub 支持门户 联系我们。
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
project_card | 对象 | 项目卡片对象。 |
project_id | 整数 | 项目卡片的唯一标识符。 |
project_url | 字符串 | 检索项目卡片的 REST API URL。 |
column_name | 字符串 | 问题所在的列的名称。 |
assigned
问题或拉取请求已分配给用户。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
assigned 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
assignee | 对象 | 分配给此问题的用户。 |
assigner | 对象 | 为该问题执行分配的人员。此字段在 REST API 的问题事件中可用,但在 REST API 的时间线事件中不可用。 |
automatic_base_change_failed
GitHub 尝试自动更改拉取请求的基础分支失败。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
automatic_base_change_failed 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
automatic_base_change_succeeded
GitHub 成功尝试自动更改拉取请求的基础分支。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
automatic_base_change_succeeded 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
base_ref_changed
拉取请求的基础参考分支已更改。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
base_ref_changed 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
closed
问题或拉取请求已关闭。当存在 commit_id
时,它标识使用“closes / fixes”语法关闭问题的提交。有关语法的更多信息,请参见“将拉取请求链接到问题”。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
已关闭的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
已评论
已向问题或拉取请求添加评论。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
已评论的属性
此事件的属性不使用与 问题事件对象通用属性 相同的结构。此事件将返回以下属性。
名称 | 类型 | 描述 |
---|---|---|
url | 字符串 | 检索问题评论的 REST API URL。 |
html_url | 字符串 | 问题评论的 HTML URL。 |
issue_url | 字符串 | 问题的 HTML URL。 |
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
user | 对象 | 对问题进行评论的人。 |
created_at | 字符串 | 指示何时添加评论的时间戳。 |
updated_at | 字符串 | 指示何时更新或创建评论的时间戳,如果评论从未更新。 |
author_association | 字符串 | 用户在问题存储库中的权限。例如,如果存储库所有者创建了评论,则该值为 "OWNER" 。 |
body | 字符串 | 评论正文文本。 |
event | 字符串 | 事件值为 "commented" 。 |
actor | 对象 | 生成事件的人。 |
已提交
已向拉取请求的 HEAD
分支添加提交。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
已提交的属性
此事件的属性不使用与 问题事件对象通用属性 相同的结构。此事件将返回以下属性。
名称 | 类型 | 描述 |
---|---|---|
sha | 字符串 | 拉取请求中提交的 SHA。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 检索提交的 REST API URL。 |
html_url | 字符串 | 提交的 HTML URL。 |
author | 对象 | 提交的作者。 |
committer | 对象 | 代表作者提交提交的人。 |
tree | 对象 | 提交的 Git 树。 |
message | 字符串 | 提交消息。 |
parents | 对象数组 | 父提交列表。 |
verification | 对象 | 验证提交签名的结果。有关更多信息,请参阅“Git 提交的 REST API 端点”。 |
event | 字符串 | 事件值为 "committed" 。 |
connected
该问题或拉取请求已链接到另一个问题或拉取请求。有关更多信息,请参阅“将拉取请求链接到问题”。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
connected 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
convert_to_draft
该拉取请求已转换为草稿模式。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
convert_to_draft 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
converted_note_to_issue
该问题是通过将项目(经典)中的笔记转换为问题而创建的。您仅在项目(经典)已启用的存储库中,才会在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
converted_note_to_issue 的属性
注意:项目卡片详细信息现在显示在项目相关问题和时间线事件的 REST API 响应中。此功能现已供开发人员预览。有关详细信息,请参阅 博客文章。
要接收 project_card
属性,项目(经典)必须在仓库中 启用,并且您必须在 Accept
标头中提供自定义 媒体类型
application/vnd.github.starfox-preview+json
警告: 预览期间,API 可能会在未事先通知的情况下发生更改。预览功能不支持生产使用。如果您遇到任何问题,请通过 GitHub 支持门户 联系我们。
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
project_card | 对象 | 项目卡片对象。 |
project_id | 整数 | 项目卡片的唯一标识符。 |
project_url | 字符串 | 检索项目卡片的 REST API URL。 |
column_name | 字符串 | 问题所在的列的名称。 |
converted_to_discussion
该问题已关闭并转换为讨论。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
converted_to_discussion 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
cross-referenced
该问题或拉取请求已从另一个问题或拉取请求中引用。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
cross-referenced 的属性
此事件的属性不使用与 问题事件对象通用属性 相同的结构。此事件将返回以下属性。
名称 | 类型 | 描述 |
---|---|---|
actor | 对象 | 生成事件的人。 |
created_at | 字符串 | 指示交叉引用添加时间的日期戳。 |
updated_at | 字符串 | 指示交叉引用更新或创建时间的日期戳,如果交叉引用从未更新。 |
source | 对象 | 添加交叉引用的问题或拉取请求。 |
source[type] | 字符串 | 此值始终为 "issue" ,因为拉取请求属于问题类型。REST API 中的时间线事件仅返回由问题或拉取请求触发的交叉引用事件。要确定触发事件的问题是否是拉取请求,您可以检查 source[issue][pull_request] 对象是否存在。 |
source[issue] | 对象 | 添加交叉引用的 issue 对象。 |
event | 字符串 | 事件值为 "cross-referenced" 。 |
demilestoned
该问题或拉取请求已从里程碑中删除。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
demilestoned 的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
里程碑 | 对象 | 里程碑对象。 |
milestone[title] | 字符串 | 里程碑的标题。 |
已部署
拉取请求已部署。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
已部署的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
部署环境已更改
拉取请求部署环境已更改。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
部署环境已更改的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
已断开连接
问题或拉取请求已从另一个问题或拉取请求中取消链接。有关更多信息,请参阅“将拉取请求链接到问题”。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
已断开连接的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
HEAD 分支已删除
拉取请求的HEAD
分支已删除。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
HEAD 分支已删除的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
HEAD 分支已恢复
拉取请求的HEAD
分支已恢复到上次已知提交。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
HEAD 分支已强制推送
拉取请求的 HEAD 分支已强制推送。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
HEAD 分支已强制推送的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
已添加标签
已向问题或拉取请求添加标签。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
已添加标签的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
标签 | 对象 | 已添加到问题或从中删除的标签 |
label[name] | 字符串 | 标签的名称。 |
label[color] | 字符串 | 十六进制颜色代码。 |
已锁定
问题或拉取请求已锁定。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
已锁定的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
锁定原因 | 字符串 | 如果提供,则问题或拉取请求对话被锁定的原因。 |
已提及
actor
在问题或拉取请求正文中被@提及
。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
已提及的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
标记为重复
具有写入权限的用户将问题标记为另一个问题的重复项,或将拉取请求标记为另一个拉取请求的重复项。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
标记为重复的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
已合并
拉取请求已合并。commit_id
属性是已合并的HEAD
提交的 SHA1。commit_repository
始终与主存储库相同。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
已合并的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
已添加到里程碑
该问题或拉取请求已添加到里程碑中。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
里程碑属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
里程碑 | 对象 | 里程碑对象。 |
milestone[title] | 字符串 | 里程碑的标题。 |
moved_columns_in_project
该问题或拉取请求在项目(经典版)中的列之间移动。只有在项目(经典版)已在仓库中启用时,您才会在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
moved_columns_in_project 属性
注意:项目卡片详细信息现在显示在项目相关问题和时间线事件的 REST API 响应中。此功能现已供开发人员预览。有关详细信息,请参阅 博客文章。
要接收 project_card
属性,项目(经典)必须在仓库中 启用,并且您必须在 Accept
标头中提供自定义 媒体类型
application/vnd.github.starfox-preview+json
警告: 预览期间,API 可能会在未事先通知的情况下发生更改。预览功能不支持生产使用。如果您遇到任何问题,请通过 GitHub 支持门户 联系我们。
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
project_card | 对象 | 项目卡片对象。 |
project_id | 整数 | 项目卡片的唯一标识符。 |
project_url | 字符串 | 检索项目卡片的 REST API URL。 |
column_name | 字符串 | 问题所在的列的名称。 |
previous_column_name | 字符串 | 问题从哪个列移动。 |
pinned
该问题已固定。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
pinned 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
ready_for_review
草稿拉取请求已标记为准备审查。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
ready_for_review 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
referenced
该问题在提交消息中被引用。commit_id
属性是发生该事件的提交 SHA1,而 commit_repository 是该提交被推送到的位置。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
referenced 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
removed_from_project
该问题或拉取请求已从项目(经典版)中删除。只有在项目(经典版)已在仓库中启用时,您才会在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
removed_from_project 属性
注意:项目卡片详细信息现在显示在项目相关问题和时间线事件的 REST API 响应中。此功能现已供开发人员预览。有关详细信息,请参阅 博客文章。
要接收 project_card
属性,项目(经典)必须在仓库中 启用,并且您必须在 Accept
标头中提供自定义 媒体类型
application/vnd.github.starfox-preview+json
警告: 预览期间,API 可能会在未事先通知的情况下发生更改。预览功能不支持生产使用。如果您遇到任何问题,请通过 GitHub 支持门户 联系我们。
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
project_card | 对象 | 项目卡片对象。 |
project_id | 整数 | 项目卡片的唯一标识符。 |
project_url | 字符串 | 检索项目卡片的 REST API URL。 |
column_name | 字符串 | 问题所在的列的名称。 |
renamed
该问题或拉取请求标题已更改。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
renamed 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
rename | 对象 | 名称详细信息。 |
rename[from] | 字符串 | 之前的名称。 |
rename[to] | 字符串 | 新名称。 |
reopened
该问题或拉取请求已重新打开。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
reopened 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
review_dismissed
拉取请求审查已驳回。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
review_dismissed 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
dismissed_review | 对象 | 已驳回的评论信息。 |
dismissed_review[state] | 字符串 | 驳回拉取请求时的状态。可以是以下之一:commented 、approved 或 changes_requested 。 |
dismissed_review[review_id] | 字符串 | 拉取请求评论的唯一标识符。 |
dismissed_review[dismissal_message] | 字符串 | 用户在驳回评论时包含的消息。 |
dismissed_review[dismissal_commit_id] | 字符串 | 如果存在,驳回评论的提交的唯一标识符。 |
review_requested
已请求拉取请求评论。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
review_requested 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
requested_reviewer | 对象 | 请求评论拉取请求的人员。 |
review_requester | 对象 | 请求评论的人员。 |
review_request_removed
已删除拉取请求评论请求。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
review_request_removed 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
requested_reviewer | 对象 | 请求评论拉取请求的人员。 |
review_requester | 对象 | 请求评论的人员。 |
reviewed
已审核拉取请求。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
reviewed 属性
此事件的属性不使用与 问题事件对象通用属性 相同的结构。此事件将返回以下属性。
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
user | 对象 | 对问题进行评论的人。 |
body | 字符串 | 评论摘要文本。 |
commit_id | 字符串 | 评论时拉取请求中最新提交的 SHA。 |
submitted_at | 字符串 | 提交评论的时间戳。 |
state | 字符串 | 提交评论的状态。可以是以下之一:commented 、changes_requested 、approved 或 dismissed 。 |
html_url | 字符串 | 评论的 HTML URL。 |
pull_request_url | 字符串 | 检索拉取请求的 REST API URL。 |
author_association | 字符串 | 用户在问题存储库中的权限。例如,如果存储库所有者创建了评论,则该值为 "OWNER" 。 |
_links | 对象 | html_url 和 pull_request_url 。 |
event | 字符串 | 事件值为 "reviewed" 。 |
subscribed
有人订阅了接收有关问题或拉取请求的通知。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
subscribed 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
transferred
问题已转移到另一个存储库。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
transferred 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
unassigned
用户已从问题中取消分配。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
unassigned 属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
assignee | 对象 | 从该问题中取消分配的人员。 |
assigner | 对象 | 对该问题执行取消分配的人员。此字段在 REST API 的问题事件中可用,但在 REST API 的时间线事件中不可用。 |
unlabeled
已从问题中删除标签。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
未标记属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
标签 | 对象 | 已添加到问题或从中删除的标签 |
label[name] | 字符串 | 标签的名称。 |
label[color] | 字符串 | 十六进制颜色代码。 |
解锁
该问题已解锁。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
解锁属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
锁定原因 | 字符串 | 如果提供,则问题或拉取请求对话被锁定的原因。 |
未标记为重复
用户先前标记为另一个问题的重复问题不再被视为重复,或者用户先前标记为另一个拉取请求的重复拉取请求不再被视为重复。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
未标记为重复属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
取消固定
该问题已取消固定。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
取消固定属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
取消订阅
有人取消订阅接收有关问题或拉取请求的通知。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
取消订阅属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |
用户被封禁
组织所有者封禁了用户访问组织。这是通过被封禁用户在该问题上的评论之一完成的。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
用户被封禁属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的日期戳。 |