REST API 现在已版本化。 有关更多信息,请参阅 "关于 API 版本控制."
时间线事件的 REST API 端点
使用 REST API 接收由问题和拉取请求中的时间线活动触发的事件。
关于时间线事件
您可以使用 REST API 查看由问题和拉取请求中的时间线活动触发的不同类型的事件。有关您可以接收的特定事件的更多信息,请参阅 "问题事件类型." 要查看问题和拉取请求之外的 GitHub 活动,请参阅 "GitHub 事件类型."
您可以使用时间线事件来显示有关问题和拉取请求的信息,或确定谁应该收到问题评论的通知。
每个拉取请求都是一个问题,但并非每个问题都是一个拉取请求。因此,在问题端点中提供了针对这两个功能的“共享”操作,例如管理分配者、标签和里程碑。
列出问题的時間線事件
列出问题的所有时间线事件。
用于“列出问题的時間線事件”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- "问题" 存储库权限(读取)
- "拉取请求" 存储库权限(读取)
如果仅请求公共资源,则无需身份验证或上述权限即可使用此端点。
用于“列出问题的時間線事件”的参数
名称、类型、描述 |
---|
accept string 建议设置为 |
名称、类型、描述 |
---|
owner 字符串 必需仓库的账户所有者。名称不区分大小写。 |
repo 字符串 必需仓库的名称,不包含 |
issue_number 整数 必需标识问题的编号。 |
名称、类型、描述 |
---|
per_page 整数 每页结果数(最大 100)。有关更多信息,请参阅 "在 REST API 中使用分页”。 默认: |
page 整数 要获取的结果页码。有关更多信息,请参阅 "在 REST API 中使用分页”。 默认: |
“列出问题的事件时间线”的 HTTP 响应状态码
状态码 | 描述 |
---|---|
200 | OK |
404 | 资源未找到 |
410 | 已消失 |
“列出问题的事件时间线”的代码示例
请求示例
get/repos/{owner}/{repo}/issues/{issue_number}/timeline
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/timeline
响应
状态:200
[
{
"id": 6430295168,
"node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA",
"url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168",
"actor": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"event": "locked",
"commit_id": null,
"commit_url": null,
"created_at": "2022-04-13T20:49:13Z",
"lock_reason": null,
"performed_via_github_app": null
},
{
"id": 6430296748,
"node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs",
"url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748",
"actor": {
"login": "github-product-roadmap",
"id": 67656570,
"node_id": "MDQ6VXNlcjY3NjU2NTcw",
"avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github-product-roadmap",
"html_url": "https://github.com/github-product-roadmap",
"followers_url": "https://api.github.com/users/github-product-roadmap/followers",
"following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}",
"gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions",
"organizations_url": "https://api.github.com/users/github-product-roadmap/orgs",
"repos_url": "https://api.github.com/users/github-product-roadmap/repos",
"events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}",
"received_events_url": "https://api.github.com/users/github-product-roadmap/received_events",
"type": "User",
"site_admin": false
},
"event": "labeled",
"commit_id": null,
"commit_url": null,
"created_at": "2022-04-13T20:49:34Z",
"label": {
"name": "beta",
"color": "99dd88"
},
"performed_via_github_app": null
},
{
"id": 6635165802,
"node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq",
"url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802",
"actor": {
"login": "github-product-roadmap",
"id": 67656570,
"node_id": "MDQ6VXNlcjY3NjU2NTcw",
"avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github-product-roadmap",
"html_url": "https://github.com/github-product-roadmap",
"followers_url": "https://api.github.com/users/github-product-roadmap/followers",
"following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}",
"gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions",
"organizations_url": "https://api.github.com/users/github-product-roadmap/orgs",
"repos_url": "https://api.github.com/users/github-product-roadmap/repos",
"events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}",
"received_events_url": "https://api.github.com/users/github-product-roadmap/received_events",
"type": "User",
"site_admin": false
},
"event": "renamed",
"commit_id": null,
"commit_url": null,
"created_at": "2022-05-18T19:29:01Z",
"rename": {
"from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)",
"to": "Secret scanning: dry-runs for enterprise-level custom patterns"
},
"performed_via_github_app": null
},
{
"url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857",
"html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857",
"issue_url": "https://api.github.com/repos/github/roadmap/issues/493",
"id": 1130876857,
"node_id": "IC_kwDODwFebM5DZ8-5",
"user": {
"login": "octocat",
"id": 94867353,
"node_id": "U_kgDOBaePmQ",
"avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": true
},
"created_at": "2022-05-19T00:52:15Z",
"updated_at": "2022-05-19T00:52:15Z",
"author_association": "COLLABORATOR",
"body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/",
"reactions": {
"url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions",
"total_count": 0,
"+1": 0,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
},
"performed_via_github_app": null,
"event": "commented",
"actor": {
"login": "octocat",
"id": 94867353,
"node_id": "U_kgDOBaePmQ",
"avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": true
}
}
]