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

scrape and export GitHub Enterprise versions of webhooks #25

Closed
gr2m opened this issue May 21, 2019 · 9 comments · Fixed by #443
Closed

scrape and export GitHub Enterprise versions of webhooks #25

gr2m opened this issue May 21, 2019 · 9 comments · Fixed by #443
Labels
Type: Feature New feature or request

Comments

@gr2m
Copy link
Contributor

gr2m commented May 21, 2019

https://developer.github.com/enterprise/<GHE version>/v3/activity/events/types/,
e.g. https://developer.github.com/enterprise/2.16/v3/activity/events/types/

@gr2m gr2m added the Type: Feature New feature or request label May 21, 2019
@zeke
Copy link
Contributor

zeke commented May 4, 2020

Pairing on this with @gr2m today. Things we need:

  • Track current enterprise version (in cache maybe)
  • Enterprise payload-examples for GHE from @rachmari
  • Export JSON files for each enterprise version

We should be able to roll this out as a feature (non-breaking change) that adds additional exports.

@zeke
Copy link
Contributor

zeke commented May 4, 2020

Prior art from octokit/routes: https://github.com/octokit/routes/blob/master/bin/octokit-rest-routes.js#L11-L15

# load all enterprise versions
$ bin/octkit-rest-routes.js --ghe

# load specific version
$ bin/octkit-rest-routes.js --ghe=2.20

@zeke zeke mentioned this issue May 4, 2020
@gr2m gr2m assigned zeke and unassigned zeke May 5, 2020
@zeke
Copy link
Contributor

zeke commented May 16, 2020

I plan to work on this next week.

cc @chiedo

Dev Effort estimate: Small

@zeke zeke changed the title Add GHE versions scrape and export GitHub Enterprise versions of webhooks May 16, 2020
@zeke
Copy link
Contributor

zeke commented May 16, 2020

@gr2m
Copy link
Contributor Author

gr2m commented May 17, 2020

Note: This page recently moved to https://developer.github.com/webhooks/event-payloads/

I'll take care of moving to the new page

@zeke
Copy link
Contributor

zeke commented May 19, 2020

Update: I will not be working on this issue this week after all. We are initially going to migrate the https://developer.github.com/webhooks/event-payloads/ page to the help.github.com as-is, and we will revisit the effort to scrape this content into a structured format at a later date.

@wolfy1339
Copy link
Member

I've got payload examples and the cache set up for enterprise versions.

Is there a way to get access to instances of GHES so we can get more payload examples?

How should the schemas be created for the versions? Do we re-use the ones for .com and make the necessary changes based on the payload examples we have?

@gr2m
Copy link
Contributor Author

gr2m commented May 12, 2021

Is there a way to get access to instances of GHES

I'm looking into it

Update Jun 4: still waiting for a response

@gr2m gr2m closed this as completed in #443 Jun 4, 2021
@octokitbot
Copy link
Collaborator

🎉 This issue has been resolved in version 3.76.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants