Конечные точки REST API для событий временной шкалы

Сведения о событиях временной шкалы

REST API можно использовать для просмотра различных типов событий, инициируемых действием временной шкалы в проблемах и запросах на вытягивание. Дополнительные сведения о конкретных событиях, которые можно получить, см. в разделе Типы события проблемы. Чтобы просмотреть действия GitHub вне проблем и запросов на вытягивание, см . раздел AUTOTITLE.

События временной шкалы можно использовать для отображения сведений о проблемах и запросах на вытягивание или определения того, кто должен получать уведомления о комментариях о проблемах.

Каждый запрос на вытягивание является проблемой, но не каждая проблема является запросом на вытягивание. По этой причине общие действия для обоих функций, например управление назначателями, метками и вехами, предоставляются в конечных точках проблем.

List timeline events for an issue

List all timeline events for an issue.

Подробные маркеры доступа для "List timeline events for an issue

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь по крайней мере один из следующих наборов разрешений.:

"Issues" repository permissions (read)
"Pull requests" repository permissions (read)

Эту конечную точку можно использовать без проверки подлинности или указанных выше разрешений, если запрашиваются только общедоступные ресурсы.

Параметры для "List timeline events for an issue"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number` integer Обязательное поле The number that identifies the issue.

Параметры запроса
Имя., Тип, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`

Коды состояния http-ответа для "List timeline events for an issue"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`410`	Gone

Примеры кода для "List timeline events for an issue"

Пример запроса

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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/timeline

Response

Status: 200

[
  {
    "id": 6430295168,
    "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA",
    "url": "https://HOSTNAME/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://HOSTNAME/users/github",
      "html_url": "https://github.com/github",
      "followers_url": "https://HOSTNAME/users/github/followers",
      "following_url": "https://HOSTNAME/users/github/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/github/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/github/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/github/subscriptions",
      "organizations_url": "https://HOSTNAME/users/github/orgs",
      "repos_url": "https://HOSTNAME/users/github/repos",
      "events_url": "https://HOSTNAME/users/github/events{/privacy}",
      "received_events_url": "https://HOSTNAME/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://HOSTNAME/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://HOSTNAME/users/github-product-roadmap",
      "html_url": "https://github.com/github-product-roadmap",
      "followers_url": "https://HOSTNAME/users/github-product-roadmap/followers",
      "following_url": "https://HOSTNAME/users/github-product-roadmap/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/github-product-roadmap/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/github-product-roadmap/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/github-product-roadmap/subscriptions",
      "organizations_url": "https://HOSTNAME/users/github-product-roadmap/orgs",
      "repos_url": "https://HOSTNAME/users/github-product-roadmap/repos",
      "events_url": "https://HOSTNAME/users/github-product-roadmap/events{/privacy}",
      "received_events_url": "https://HOSTNAME/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://HOSTNAME/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://HOSTNAME/users/github-product-roadmap",
      "html_url": "https://github.com/github-product-roadmap",
      "followers_url": "https://HOSTNAME/users/github-product-roadmap/followers",
      "following_url": "https://HOSTNAME/users/github-product-roadmap/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/github-product-roadmap/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/github-product-roadmap/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/github-product-roadmap/subscriptions",
      "organizations_url": "https://HOSTNAME/users/github-product-roadmap/orgs",
      "repos_url": "https://HOSTNAME/users/github-product-roadmap/repos",
      "events_url": "https://HOSTNAME/users/github-product-roadmap/events{/privacy}",
      "received_events_url": "https://HOSTNAME/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://HOSTNAME/repos/github/roadmap/issues/comments/1130876857",
    "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857",
    "issue_url": "https://HOSTNAME/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://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/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://HOSTNAME/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://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": true
    }
  }
]