Skip to content

feat: new and updated payload examples with resulting schema changes#813

Merged
wolfy1339 merged 15 commits into
mainfrom
update-payloads
Jun 29, 2023
Merged

feat: new and updated payload examples with resulting schema changes#813
wolfy1339 merged 15 commits into
mainfrom
update-payloads

Conversation

@wolfy1339

@wolfy1339 wolfy1339 commented Jun 29, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Resolves #812

Behavior

Before the change?

  • The schemas were not up to date with real world payloads

After the change?

  • Updates the schemas to be up to date with real world payloads

Other information

  • Information derived from the OpenAPI spec, and from the example payloads

Additional info

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes (Please add the Type: Breaking change label)
  • No

If Yes, what's the impact:

  • N/A

Pull request type

Please add the corresponding label for change this PR introduces:

  • Feature/model/API additions: Type: Feature

@wolfy1339 wolfy1339 added the Type: Feature New feature or request label Jun 29, 2023
@wolfy1339 wolfy1339 linked an issue Jun 29, 2023 that may be closed by this pull request
[BUG]: registry_package is missing installation object #812
Closed
1 task
@wolfy1339 wolfy1339 mentioned this pull request Jun 29, 2023
Closed
1 task
kfcampbell
kfcampbell approved these changes Jun 29, 2023
View reviewed changes

@kfcampbell kfcampbell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How did you go about doing this? How come it wasn't caught by the update script?

@wolfy1339

wolfy1339 commented Jun 29, 2023

Copy link
Copy Markdown
Member Author

The update script is broken because of the switch in the GitHub docs to the OpenAPI spec, and because the examples have been removed.

@wolfy1339

wolfy1339 commented Jun 29, 2023

Copy link
Copy Markdown
Member Author

I have a webhooks endpoint running on my server that compares incoming webhooks to the schema defined in this repo.

It was originally implemented by @G-Rath, as a serverless function to run on Azure, and I modified it to run on express.

https://github.com/G-Rath/compare-gh-webhook-to-schema-function

@wolfy1339 wolfy1339 merged commit 9f7f7f3 into main Jun 29, 2023
@wolfy1339 wolfy1339 deleted the update-payloads branch June 29, 2023 17:29
@octokitbot

octokitbot commented Jun 29, 2023

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 7.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@G-Rath

G-Rath commented Jun 29, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

@wolfy1339 fwiw I don't mind migrating the original app to Express/Koa if you like - the serverless function has been shutdown anyway, and it'd give me something to do 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@kfcampbell kfcampbell kfcampbell approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

released Type: Feature New feature or request

Projects

🧰 Octokit Active
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG]: registry_package is missing installation object

4 participants

@wolfy1339 @octokitbot @G-Rath @kfcampbell