Skip to content

[Schema Inaccuracy] Innacurracies in the schema definition of the PingEvent webhook (#/components/schemas/webhook-ping) #1940

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

Open
5 tasks
wolfy1339 opened this issue Dec 3, 2022 · 0 comments

Comments

@wolfy1339
Copy link

Schema Inaccuracy

These are some improvement I have found that could be made when comparing the current definition of the PingEvent to the definition in octokit/webhooks

  • In the schema for the PingEvent webhook, no property is marked as required. (Innacuracy)
  • The hook[config][content_type] property can be augmented using an enum, as indicated in it's description, the values would be json and form
  • The hook[events] property can be augmented to be a oneOf, either an array with only the value * for all events, or an array with an enum of all possible webhook events, as done in octokit/webhooks
  • The hook[type] property can be augmented to be an enum of the different webhook types, either Repository, Organization, or App
  • The hook[config][insecure_ssl] property can be augmented to be an enum of either 0 or 1 as those are the only supported values

Expected

For the properties to be marked as required.
The other issues aren't critical, they are values that could be defined more explicitly.

Reproduction Steps

n/a

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

No branches or pull requests

2 participants