L’API REST est maintenant versionnée. Pour plus d’informations, consultez « À propos des versions de l’API ».

Points de terminaison d’API REST pour les événements de chronologie

Utilisez l’API REST pour recevoir des événements déclenchés par l’activité de chronologie dans les problèmes et les demandes de tirage.

À propos des événements de chronologie

Vous pouvez utiliser l’API REST pour voir différents types d’événements déclenchés par l’activité de chronologie dans les problèmes et les demandes de tirage. Pour plus d’informations sur les événements spécifiques que vous pouvez recevoir, consultez « Types d’événement de problème ». Pour voir l’activité GitHub en dehors des problèmes et des demandes de tirage, consultez « Types d’événements GitHub ».

Vous pouvez utiliser les événements de chronologie pour afficher des informations sur les problèmes et les demandes de tirage ou déterminer qui doit être informé des commentaires de problème.

Chaque demande de tirage est un problème, mais chaque problème n’est pas une demande de tirage. Pour cette raison, les actions « partagées » pour les deux fonctionnalités, comme la gestion des personnes responsables, des étiquettes et des jalons, sont fournies dans les points de terminaison Problèmes.

List timeline events for an issue

List all timeline events for an issue.

Jetons d’accès affinés pour « List timeline events for an issue »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir au moins l’un des ensembles d’autorisations suivants:

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

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour « List timeline events for an issue »

En-têtes
accept string

Setting to application/vnd.github+json is recommended.

Paramètres de chemin d’accès
owner string Obligatoire

The account owner of the repository. The name is not case sensitive.

repo string Obligatoire

The name of the repository without the .git extension. The name is not case sensitive.

issue_number integer Obligatoire

The number that identifies the issue.

Paramètres de requête
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default: 1

Codes d’état de la réponse HTTP pour « List timeline events for an issue »

Code d’étatDescription
200

OK

404

Resource not found

410

Gone

Exemples de code pour « List timeline events for an issue »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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

Response

Status: 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 } } ]