Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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

Copy link
Copy link
Open
@wolfy1339

Description

@wolfy1339
Issue body actions

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.