Skip to content
This repository has been archived by the owner on Jul 27, 2020. It is now read-only.

"reviewed" event is not documented for timeline #598

Open
maxkomarychev opened this issue Dec 17, 2019 · 1 comment
Open

"reviewed" event is not documented for timeline #598

maxkomarychev opened this issue Dec 17, 2019 · 1 comment
Labels
feature New feature or request

Comments

@maxkomarychev
Copy link

Current specification

https://github.com/octokit/routes/blob/master/openapi/api.github.com/operations/issues/list-events-for-timeline.json

I expected

Documentation here https://developer.github.com/v3/issues/timeline/ does not look comprehensive - i.e. through API I see other event times not mentioned in the spec, e.g. "reviewed"

curl -H "Accept: application/vnd.github.mockingbird-preview" https://api.github.com/repos/octokit/routes/issues/597/timeline

sample json
[
  {
    "sha": "3393a660c742db8553a96db07a38e4a739602cf5",
    "node_id": "MDY6Q29tbWl0MTI0Mjg5ODA1OjMzOTNhNjYwYzc0MmRiODU1M2E5NmRiMDdhMzhlNGE3Mzk2MDJjZjU=",
    "url": "https://api.github.com/repos/octokit/routes/git/commits/3393a660c742db8553a96db07a38e4a739602cf5",
    "html_url": "https://github.com/octokit/routes/commit/3393a660c742db8553a96db07a38e4a739602cf5",
    "author": {
      "name": "dependabot[bot]",
      "email": "49699333+dependabot[bot]@users.noreply.github.com",
      "date": "2019-12-13T18:55:36Z"
    },
    "committer": {
      "name": "GitHub",
      "email": "noreply@github.com",
      "date": "2019-12-13T18:55:36Z"
    },
    "tree": {
      "sha": "c7e7be3d553a073720e80612f79f018ea467eb27",
      "url": "https://api.github.com/repos/octokit/routes/git/trees/c7e7be3d553a073720e80612f79f018ea467eb27"
    },
    "message": "build(deps): bump npm from 6.13.1 to 6.13.4\n\nBumps [npm](https://github.com/npm/cli) from 6.13.1 to 6.13.4.\n- [Release notes](https://github.com/npm/cli/releases)\n- [Changelog](https://github.com/npm/cli/blob/latest/CHANGELOG.md)\n- [Commits](https://github.com/npm/cli/compare/v6.13.1...v6.13.4)\n\nSigned-off-by: dependabot[bot] <support@github.com>",
    "parents": [
      {
        "sha": "31bad0aa0a681fb4ddb3fbe552e24ce9cb384bb7",
        "url": "https://api.github.com/repos/octokit/routes/git/commits/31bad0aa0a681fb4ddb3fbe552e24ce9cb384bb7",
        "html_url": "https://github.com/octokit/routes/commit/31bad0aa0a681fb4ddb3fbe552e24ce9cb384bb7"
      }
    ],
    "verification": {
      "verified": true,
      "reason": "valid",
      "signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJd896oCRBK7hj4Ov3rIwAAdHIIAJd6ZAjFqLD+sEwvJDGhxUZ3\nE2DAqsHYBKDKgztZRxxct3UfjB/gdiGX+54S4xskRvmL0fEOEyoSAuS2/I6yHAXe\nFPdkjwgujqL9IzE0MILWpzXnxkjCX8WzB+LBpMrMtlEP/TMEgrrILxtkwP6OA9K5\nu1PZQqaJ9FtLM2B1PMC6Qqba8slGCm/bg/mqqDEK6ZrGnfKY9RUyN43slGZQ9Lsp\ne5LVfKDCU9HoXDGIuPysaJq/ruKy0YftGTB9rKlXCJc4coOweIvDSfy35U0rS/0e\nyBCFyicd9idhNE1fnCgSoQkco3dTe21MxXsxsVEEFf+Kfxop9/cOFVgkhhV8KqI=\n=bKrl\n-----END PGP SIGNATURE-----\n",
      "payload": "tree c7e7be3d553a073720e80612f79f018ea467eb27\nparent 31bad0aa0a681fb4ddb3fbe552e24ce9cb384bb7\nauthor dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 1576263336 +0000\ncommitter GitHub <noreply@github.com> 1576263336 +0000\n\nbuild(deps): bump npm from 6.13.1 to 6.13.4\n\nBumps [npm](https://github.com/npm/cli) from 6.13.1 to 6.13.4.\n- [Release notes](https://github.com/npm/cli/releases)\n- [Changelog](https://github.com/npm/cli/blob/latest/CHANGELOG.md)\n- [Commits](https://github.com/npm/cli/compare/v6.13.1...v6.13.4)\n\nSigned-off-by: dependabot[bot] <support@github.com>"
    },
    "event": "committed"
  },
  {
    "id": 2882331544,
    "node_id": "MDEyOkxhYmVsZWRFdmVudDI4ODIzMzE1NDQ=",
    "url": "https://api.github.com/repos/octokit/routes/issues/events/2882331544",
    "actor": {
      "login": "dependabot[bot]",
      "id": 49699333,
      "node_id": "MDM6Qm90NDk2OTkzMzM=",
      "avatar_url": "https://avatars0.githubusercontent.com/in/29110?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/dependabot%5Bbot%5D",
      "html_url": "https://github.com/apps/dependabot",
      "followers_url": "https://api.github.com/users/dependabot%5Bbot%5D/followers",
      "following_url": "https://api.github.com/users/dependabot%5Bbot%5D/following{/other_user}",
      "gists_url": "https://api.github.com/users/dependabot%5Bbot%5D/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/dependabot%5Bbot%5D/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/dependabot%5Bbot%5D/subscriptions",
      "organizations_url": "https://api.github.com/users/dependabot%5Bbot%5D/orgs",
      "repos_url": "https://api.github.com/users/dependabot%5Bbot%5D/repos",
      "events_url": "https://api.github.com/users/dependabot%5Bbot%5D/events{/privacy}",
      "received_events_url": "https://api.github.com/users/dependabot%5Bbot%5D/received_events",
      "type": "Bot",
      "site_admin": false
    },
    "event": "labeled",
    "commit_id": null,
    "commit_url": null,
    "created_at": "2019-12-13T18:55:39Z",
    "label": {
      "name": "dependencies",
      "color": "0366d6"
    }
  },
  {
    "id": 332157887,
    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MzMyMTU3ODg3",
    "user": {
      "login": "jovel",
      "id": 96927,
      "node_id": "MDQ6VXNlcjk2OTI3",
      "avatar_url": "https://avatars2.githubusercontent.com/u/96927?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/jovel",
      "html_url": "https://github.com/jovel",
      "followers_url": "https://api.github.com/users/jovel/followers",
      "following_url": "https://api.github.com/users/jovel/following{/other_user}",
      "gists_url": "https://api.github.com/users/jovel/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/jovel/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/jovel/subscriptions",
      "organizations_url": "https://api.github.com/users/jovel/orgs",
      "repos_url": "https://api.github.com/users/jovel/repos",
      "events_url": "https://api.github.com/users/jovel/events{/privacy}",
      "received_events_url": "https://api.github.com/users/jovel/received_events",
      "type": "User",
      "site_admin": true
    },
    "body": "",
    "commit_id": "3393a660c742db8553a96db07a38e4a739602cf5",
    "submitted_at": "2019-12-13T22:55:55Z",
    "state": "approved",
    "html_url": "https://github.com/octokit/routes/pull/597#pullrequestreview-332157887",
    "pull_request_url": "https://api.github.com/repos/octokit/routes/pulls/597",
    "author_association": "NONE",
    "_links": {
      "html": {
        "href": "https://github.com/octokit/routes/pull/597#pullrequestreview-332157887"
      },
      "pull_request": {
        "href": "https://api.github.com/repos/octokit/routes/pulls/597"
      }
    },
    "event": "reviewed"
  },
  {
    "id": 2882894227,
    "node_id": "MDE1OlJlZmVyZW5jZWRFdmVudDI4ODI4OTQyMjc=",
    "url": "https://api.github.com/repos/octokit/routes/issues/events/2882894227",
    "actor": {
      "login": "jovel",
      "id": 96927,
      "node_id": "MDQ6VXNlcjk2OTI3",
      "avatar_url": "https://avatars2.githubusercontent.com/u/96927?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/jovel",
      "html_url": "https://github.com/jovel",
      "followers_url": "https://api.github.com/users/jovel/followers",
      "following_url": "https://api.github.com/users/jovel/following{/other_user}",
      "gists_url": "https://api.github.com/users/jovel/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/jovel/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/jovel/subscriptions",
      "organizations_url": "https://api.github.com/users/jovel/orgs",
      "repos_url": "https://api.github.com/users/jovel/repos",
      "events_url": "https://api.github.com/users/jovel/events{/privacy}",
      "received_events_url": "https://api.github.com/users/jovel/received_events",
      "type": "User",
      "site_admin": true
    },
    "event": "referenced",
    "commit_id": "5b7a46c49dec4d7ba1aa23aa23ff5c4bddc8b1f2",
    "commit_url": "https://api.github.com/repos/octokit/routes/commits/5b7a46c49dec4d7ba1aa23aa23ff5c4bddc8b1f2",
    "created_at": "2019-12-13T22:56:24Z"
  },
  {
    "id": 2882894231,
    "node_id": "MDExOk1lcmdlZEV2ZW50Mjg4Mjg5NDIzMQ==",
    "url": "https://api.github.com/repos/octokit/routes/issues/events/2882894231",
    "actor": {
      "login": "jovel",
      "id": 96927,
      "node_id": "MDQ6VXNlcjk2OTI3",
      "avatar_url": "https://avatars2.githubusercontent.com/u/96927?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/jovel",
      "html_url": "https://github.com/jovel",
      "followers_url": "https://api.github.com/users/jovel/followers",
      "following_url": "https://api.github.com/users/jovel/following{/other_user}",
      "gists_url": "https://api.github.com/users/jovel/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/jovel/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/jovel/subscriptions",
      "organizations_url": "https://api.github.com/users/jovel/orgs",
      "repos_url": "https://api.github.com/users/jovel/repos",
      "events_url": "https://api.github.com/users/jovel/events{/privacy}",
      "received_events_url": "https://api.github.com/users/jovel/received_events",
      "type": "User",
      "site_admin": true
    },
    "event": "merged",
    "commit_id": "5b7a46c49dec4d7ba1aa23aa23ff5c4bddc8b1f2",
    "commit_url": "https://api.github.com/repos/octokit/routes/commits/5b7a46c49dec4d7ba1aa23aa23ff5c4bddc8b1f2",
    "created_at": "2019-12-13T22:56:24Z"
  },
  {
    "id": 2882894237,
    "node_id": "MDExOkNsb3NlZEV2ZW50Mjg4Mjg5NDIzNw==",
    "url": "https://api.github.com/repos/octokit/routes/issues/events/2882894237",
    "actor": {
      "login": "jovel",
      "id": 96927,
      "node_id": "MDQ6VXNlcjk2OTI3",
      "avatar_url": "https://avatars2.githubusercontent.com/u/96927?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/jovel",
      "html_url": "https://github.com/jovel",
      "followers_url": "https://api.github.com/users/jovel/followers",
      "following_url": "https://api.github.com/users/jovel/following{/other_user}",
      "gists_url": "https://api.github.com/users/jovel/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/jovel/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/jovel/subscriptions",
      "organizations_url": "https://api.github.com/users/jovel/orgs",
      "repos_url": "https://api.github.com/users/jovel/repos",
      "events_url": "https://api.github.com/users/jovel/events{/privacy}",
      "received_events_url": "https://api.github.com/users/jovel/received_events",
      "type": "User",
      "site_admin": true
    },
    "event": "closed",
    "commit_id": null,
    "commit_url": null,
    "created_at": "2019-12-13T22:56:24Z"
  },
  {
    "id": 2882894263,
    "node_id": "MDE5OkhlYWRSZWZEZWxldGVkRXZlbnQyODgyODk0MjYz",
    "url": "https://api.github.com/repos/octokit/routes/issues/events/2882894263",
    "actor": {
      "login": "jovel",
      "id": 96927,
      "node_id": "MDQ6VXNlcjk2OTI3",
      "avatar_url": "https://avatars2.githubusercontent.com/u/96927?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/jovel",
      "html_url": "https://github.com/jovel",
      "followers_url": "https://api.github.com/users/jovel/followers",
      "following_url": "https://api.github.com/users/jovel/following{/other_user}",
      "gists_url": "https://api.github.com/users/jovel/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/jovel/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/jovel/subscriptions",
      "organizations_url": "https://api.github.com/users/jovel/orgs",
      "repos_url": "https://api.github.com/users/jovel/repos",
      "events_url": "https://api.github.com/users/jovel/events{/privacy}",
      "received_events_url": "https://api.github.com/users/jovel/received_events",
      "type": "User",
      "site_admin": true
    },
    "event": "head_ref_deleted",
    "commit_id": null,
    "commit_url": null,
    "created_at": "2019-12-13T22:56:26Z"
  }
]
@gr2m
Copy link
Contributor

gr2m commented Dec 19, 2019

I think that event payloads are the same as shown on https://developer.github.com/v3/activity/events/types/. If that's the case we could maybe leverage the scraped data from https://github.com/octokit/webhooks

If the docs are out of sync or lacking, it would be great to contact support@github.com. They will forward your request to the right people. You can send along a link to this issue

@gr2m gr2m added the feature New feature or request label May 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants