Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update DeleteEvent schema #602

Closed
wants to merge 1 commit into from

Conversation

reginawang3495
Copy link

Signed-off-by: Regina Wang <rrreggginnna@gmail.com>
@wolfy1339 wolfy1339 added the Type: Bug Something isn't working as documented label Jan 5, 2022
@wolfy1339
Copy link
Member

Do you have an actual example payload that shows this as true?
The docs aren't 100% accurate, especially when it comes to Webhooks

@reginawang3495
Copy link
Author

Thanks for the quick review! Not all fields, but yes

{
  "id": "18562886179",
  "type": "DeleteEvent",
  "actor": {
    "id": 15240801,
    "login": "dtjanaka",
    "display_login": "dtjanaka",
    "gravatar_id": "",
    "url": "https://github.com/gitapi/users/dtjanaka",
    "avatar_url": "https://github.com/avatars/u/15240801?"
  },
  "repo": {
    "id": 103854310,
    "name": "uclaacm/website",
    "url": "https://github.com/gitapi/repos/uclaacm/website"
  },
  "payload": {
    "ref": "jedis-typo",
    "ref_type": "branch",
    "pusher_type": "user"
  },
  "public": true,
  "created_at": "2021-10-22T22:59:22Z",
  "org": {
    "id": 8324381,
    "login": "uclaacm",
    "gravatar_id": "",
    "url": "https://github.com/gitapi/orgs/uclaacm",
    "avatar_url": "https://github.com/avatars/u/8324381?"
  }
}

@wolfy1339
Copy link
Member

That's for GitHub events, which are totally different than Webhooks.

We don't yet have any schemas for GitHub events.

@wolfy1339 wolfy1339 closed this Jan 5, 2022
@reginawang3495
Copy link
Author

@wolfy1339 Sorry to bother you, but are you also saying that @octokit doesn't have schemas for GitHub events as a whole as well?

I did personally look around and couldn't find any either

@wolfy1339
Copy link
Member

@wolfy1339 Sorry to bother you, but are you also saying that @octokit doesn't have schemas for GitHub events as a whole as well?

That is correct, we do not have any schemas for GitHub events.
We have some plans to add GitHub Events eventually, octokit/webhooks.js#474

But, Unfortunately the JS octokit libraries no longer have an active maintainer, which means that that is on hold until further notice. I only maintain the webhooks code, and do issue triaging.

You can read about it in this discussion, subscribe to it for further updates.

@reginawang3495
Copy link
Author

Ok sounds good, thanks for the info!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants