PushEvent payload data does not exist on types.d.ts

[patrickelectric]

Code:

export type GitHubEvent = GetResponseDataTypeFromEndpointMethod<typeof octokit.activity.listPublicEventsForUser>[0];

const iterator = octokit.paginate.iterator(octokit.rest.activity.listPublicEventsForUser, {
  username: user,
  per_page: 100,
})
events = []
for await (const item of iterator) {
  events = this.events.concat(item.data)
}

JsonContent of event object:

"payload": {
  "push_id": 10843997312,
  "size": 1,
  "distinct_size": 1,
  "ref": "refs/heads/master",
  "head": "c73a84db441fdd656d90be5172e41b3eaa69a356",
  "before": "cc3d1a380867a6b30a1520526c4be8f20fc52a69",
  "commits": ...

types.d.ts

[oscard0m]

Hi @patrickelectric,

Thanks for reporting the issue and taking the time to provide a detailed explanation with payload examples.

Checking GitHub API Documentation for 'List public events for a User' I can see the payload response example with the "payload" you are mentioning in your Issue Description:

But the JSON schema for the response seems to not be aligned with it. I only see:

 "action": ...,
 "issue": ...,
 "comment": ...,
  "pages": ...

Checking GitHub's REST API OpenAPI Description, where Octokit extracts all the typing from, I see the JSON Schema like that:

"payload": {
    "type": "object",
    "properties": {
      "action": {
        "type": "string"
      },
      "issue": {
        "$ref": "#/components/schemas/issue"
      },
      "comment": {
        "$ref": "#/components/schemas/issue-comment"
      },
      "pages": {
        "type": "array",
        ...
      }

Link to the file and line. Because the size is quite large, GitHub is not capable of rendering it in their web viewer so you will have to download it or clone their repo.

---

Seems to be something to report to GitHub Open API Descritpion. what do you think? @timrogers @nickfloyd @wolfy1339

[wolfy1339]

This is actually a known issue.
There's an issue opened for it already 😉 octokit/rest.js#128
github/rest-api-description#1318