feat(types): use OpenAPI spec

[wolfy1339]

Resolves #840

---

Behavior

Before the change?

• The types were made in house by using example payloads and extrapolated a schema from them

After the change?

• The types use the official GitHub OpenAPI spec

Other information

---

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:

• Since we are switching the source of the types, I feel it better to release this as a breaking change

Pull request type

Please add the corresponding label for change this PR introduces:

• Feature/model/API additions: Type: Feature

---

[ollie-iterators]

Some errors:

Error: test/typescript-validate.ts(106,7): error TS2578: Unused '@ts-expect-error' directive.

Also some from the types.d.ts about the property "webhook-check-run-created-form-encoded" not existing on a type

[wolfy1339]

I am aware of the errors.

Error: test/typescript-validate.ts(106,7): error TS2578: Unused '@ts-expect-error' directive.

This is due to github/rest-api-description#2465
The test is supposed to error in normal circumstances, and the error is ignored.

Also some from the types.d.ts about the property "webhook-check-run-created-form-encoded" not existing on a type

That has been fixed. octokit/openapi-webhooks@01457e3

I haven't updated this PR

[ollie-iterators]

Great

[wolfy1339]

The webhooks OpenAPI spec has been out for a year now.

The schemas (excluding enum values) are pretty much the same. I have noticed in many areas where they don't change the enum according to the action.

Overall it would be nice to have people test this package with the OpenAPI webhooks spec

[wolfy1339]

@oscard0m @gr2m @G-Rath I'd like to get your input on this

[gr2m]

I looked through the changes and it looks great, thank you for putting in all this work! When we ship it, shall we move @wolfy1339/openapi-webhooks-types and @wolfy1339/openapi-webhooks to @octokit as well?

[wolfy1339]

I looked through the changes and it looks great, thank you for putting in all this work! When we ship it, shall we move @wolfy1339/openapi-webhooks-types and @wolfy1339/openapi-webhooks to @octokit as well?

Yes, that was the goal

[wolfy1339]

I am coming around to this PR again, I have created octokit/openapi-webhooks#80 to track the move to the Octokit org.

I don't have the permissions to move the repo myself, so whomever is available that can do it @kfcampbell @gr2m @nickfloyd

[github-actions]

🎉 This PR is included in version 12.2.0-beta.1 🎉

The release is available on:

• GitHub release
• npm package (@beta dist-tag)

Your semantic-release bot 📦🚀