问题事件由问题和拉取请求中的活动触发,并且在 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 | 字符串 | 指示事件发生时间的事件戳。 |
添加到项目
问题或拉取请求已添加到项目(经典)。只有在代码仓库中启用了项目(经典)时,您才能在响应中看到此事件。 启用
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
添加到项目的属性
注意
项目卡片详细信息现在显示在与项目相关的事件和时间线事件的 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 | 字符串 | 问题所在的列的名称。 |
指派
问题或拉取请求已指派给用户。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
指派的属性
名称 | 类型 | 描述 |
---|---|---|
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 中不可用。 |
自动基准更改失败
GitHub 未能成功尝试自动更改拉取请求的基准分支。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
自动基准更改失败的属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
自动基准更改成功
GitHub 成功尝试自动更改拉取请求的基准分支。
此事件适用于以下问题类型。
问题事件的 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
时,它会标识使用“关闭/修复”语法关闭问题的提交。有关语法的更多信息,请参阅“将拉取请求链接到问题”。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 表示评论更新或创建的时间戳,如果评论从未更新过。 |
作者关联 | 字符串 | 用户在该 issue 所在仓库中的权限。例如,如果仓库所有者创建了一条评论,则该值将为 "OWNER" 。 |
正文 | 字符串 | 评论正文文本。 |
event | 字符串 | 事件值为 "commented" 。 |
actor | 对象 | 生成事件的人员。 |
提交
一个提交被添加到拉取请求的 HEAD
分支。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
拉取请求 |
提交属性
此事件属性不使用与 问题事件对象通用属性 相同的结构。此事件将返回以下属性。
名称 | 类型 | 描述 |
---|---|---|
sha | 字符串 | 拉取请求中提交的 SHA 值。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 获取提交的 REST API URL。 |
html_url | 字符串 | 提交的 HTML URL。 |
作者 | 对象 | 提交的作者。 |
提交者 | 对象 | 代表作者提交该提交的人。 |
树 | 对象 | 提交的 Git 树。 |
消息 | 字符串 | 提交消息。 |
父提交 | 对象数组 | 父提交列表。 |
验证 | 对象 | 验证提交签名的结果。有关更多信息,请参阅“Git 提交的 REST API 端点”。 |
event | 字符串 | 事件值为 "committed" 。 |
关联
该 issue 或拉取请求已链接到另一个 issue 或拉取请求。有关更多信息,请参阅“将拉取请求链接到 issue”。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |
将注释转换为 issue
通过将项目(经典)中的注释转换为 issue 来创建 issue。只有在项目(经典)已在仓库中启用时,您才能在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
将注释转换为 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 | 字符串 | 问题所在的列的名称。 |
转换为讨论
该 issue 已关闭并转换为讨论。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
转换为讨论属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
交叉引用
该 issue 或拉取请求已从另一个 issue 或拉取请求中引用。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
交叉引用属性
此事件属性不使用与 问题事件对象通用属性 相同的结构。此事件将返回以下属性。
名称 | 类型 | 描述 |
---|---|---|
actor | 对象 | 生成事件的人员。 |
created_at | 字符串 | 表示交叉引用添加时间的时间戳。 |
updated_at | 字符串 | 表示交叉引用更新或创建的时间戳,如果交叉引用从未更新过。 |
来源 | 对象 | 添加交叉引用的 issue 或拉取请求。 |
source[type] | 字符串 | 此值将始终为 "issue" ,因为拉取请求属于 issue 类型。REST API 中的时间线事件中仅返回由 issue 或拉取请求触发的交叉引用事件。要确定触发事件的 issue 是否为拉取请求,您可以检查 source[issue][pull_request] 对象是否存在。 |
source[issue] | 对象 | 添加交叉引用的 issue 对象。 |
event | 字符串 | 事件值为 "cross-referenced" 。 |
移除里程碑
该 issue 或拉取请求已从里程碑中移除。
此事件适用于以下问题类型。
问题事件的 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] | 字符串 | 里程碑的标题。 |
部署
拉取请求已部署。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |
取消关联
该 issue 或拉取请求已取消与另一个 issue 或拉取请求的链接。有关更多信息,请参阅“将拉取请求链接到 issue”。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |
添加标签
已向 issue 或拉取请求添加标签。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
添加标签属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
标签 | 对象 | 添加或移除自 issue 的标签 |
label[name] | 字符串 | 标签的名称。 |
label[color] | 字符串 | 十六进制颜色代码。 |
锁定
该 issue 或拉取请求已锁定。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
锁定属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
锁定原因 | 字符串 | 如果提供了锁定原因,则为锁定 issue 或拉取请求对话的原因。 |
提及
actor
在 issue 或拉取请求正文中被 @提及
。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
提及属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
标记为重复
具有写入权限的用户将 issue 标记为另一个 issue 的重复项,或将拉取请求标记为另一个拉取请求的重复项。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |
添加里程碑
该 issue 或拉取请求已添加到里程碑。
此事件适用于以下问题类型。
问题事件的 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] | 字符串 | 里程碑的标题。 |
在项目中移动列
该 issue 或拉取请求已在项目(经典)的列之间移动。只有在项目(经典)已在仓库中启用时,您才能在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
在项目中移动列属性
注意
项目卡片详细信息现在显示在与项目相关的事件和时间线事件的 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 | 字符串 | 问题所在的列的名称。 |
上一个列名称 | 字符串 | issue 从中移动的列的名称。 |
置顶
该 issue 已置顶。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |
引用
该 issue 已从提交消息中引用。commit_id
属性是发生此操作的提交 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 | 字符串 | 指示事件发生时间的事件戳。 |
从项目中移除
该 issue 或拉取请求已从项目(经典)中移除。只有在项目(经典)已在仓库中启用时,您才能在响应中看到此事件。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
从项目中移除属性
注意
项目卡片详细信息现在显示在与项目相关的事件和时间线事件的 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 | 字符串 | 问题所在的列的名称。 |
重命名
已更改 issue 或拉取请求的标题。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
重命名属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
重命名 | 对象 | 名称详细信息。 |
rename[from] | 字符串 | 以前的名称。 |
rename[to] | 字符串 | 新名称。 |
重新打开
该 issue 或拉取请求已重新打开。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |
驳回的审查 | 对象 | 驳回的审查信息。 |
dismissed_review[state] | 字符串 | 驳回时拉取请求的状态。可以是以下之一:commented 、approved 或 changes_requested 。 |
dismissed_review[review_id] | 字符串 | 拉取请求审查的唯一标识符。 |
dismissed_review[dismissal_message] | 字符串 | 用户在驳回审查时包含的消息。 |
dismissed_review[dismissal_commit_id] | 字符串 | 如果存在,则为驳回审查的提交的唯一标识符。 |
请求审查
已请求拉取请求审查。
此事件适用于以下问题类型。
问题事件的 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。 |
user | 对象 | 对问题发表评论的人员。 |
正文 | 字符串 | 审查摘要文本。 |
commit_id | 字符串 | 审查时拉取请求中最新提交的 SHA 值。 |
提交时间 | 字符串 | 表示审查提交时间的时间戳。 |
状态 | 字符串 | 提交的审查的状态。可以是以下之一:commented 、changes_requested 、approved 或 dismissed 。 |
html_url | 字符串 | 审查的 HTML URL。 |
拉取请求 URL | 字符串 | 获取拉取请求的 REST API URL。 |
作者关联 | 字符串 | 用户在该 issue 所在仓库中的权限。例如,如果仓库所有者创建了一条评论,则该值将为 "OWNER" 。 |
_links | 对象 | html_url 和 pull_request_url 。 |
event | 字符串 | 事件值为 "reviewed" 。 |
订阅
有人订阅接收 issue 或拉取请求的通知。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
订阅属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
转移
该 issue 已转移到另一个仓库。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 |
转移属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
取消指派
用户已从 issue 中取消指派。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
取消指派属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
assignee | 对象 | 取消指派的人。 |
assigner | 对象 | 为该 issue 执行取消指派的人。此字段在 issue 事件的 REST API 中可用,但在时间线事件的 REST API 中不可用。 |
移除标签
已从 issue 中移除标签。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
移除标签属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
标签 | 对象 | 添加或移除自 issue 的标签 |
label[name] | 字符串 | 标签的名称。 |
label[color] | 字符串 | 十六进制颜色代码。 |
解锁
该 issue 已解锁。
此事件适用于以下问题类型。
问题事件的 REST API | 时间线事件的 REST API | |
---|---|---|
问题 | ||
拉取请求 |
解锁属性
名称 | 类型 | 描述 |
---|---|---|
id | 整数 | 事件的唯一标识符。 |
node_id | 字符串 | 事件的 全局节点 ID。 |
url | 字符串 | 用于获取事件的 REST API URL。 |
actor | 对象 | 生成事件的人员。 |
event | 字符串 | 标识发生的实际事件类型。 |
commit_id | 字符串 | 引用此问题的提交的 SHA。 |
commit_url | 字符串 | 指向引用此问题的提交的 GitHub REST API 链接。 |
created_at | 字符串 | 指示事件发生时间的事件戳。 |
锁定原因 | 字符串 | 如果提供了锁定原因,则为锁定 issue 或拉取请求对话的原因。 |
取消标记为重复
用户之前标记为另一个问题的重复项的问题不再被视为重复项,或者用户之前标记为另一个拉取请求的重复项的拉取请求不再被视为重复项。
此事件适用于以下问题类型。
问题事件的 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 | 字符串 | 指示事件发生时间的事件戳。 |