Skip to content

[Schema Inaccuracy] webhook-code-scanning-alert-reopened sets alert field as nullable #4801

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
ebickle opened this issue May 5, 2025 · 0 comments
Labels

Comments

@ebickle
Copy link

ebickle commented May 5, 2025

Schema Inaccuracy

The webhook-code-scanning-alert-reopened schema component sets its alert field as "nullable": true. This is likely a schema inaccuracy for the following reasons:

  • The alert is the subject of the webhook - something that doesn't exist cannot be 'reopened'.
  • All other webhook-code-scanning-alert-* webhook event payloads set alert as not-nullable.

Expected

The alert field of the webhook-code-scanning-alert-reopened schema should not be set as "nullable": true

Reproduction Steps

None - observed by reviewing https://raw.githubusercontent.com/github/rest-api-description/refs/heads/main/descriptions/ghec/ghec.json and trying to use @octokit/openapi-webhooks-types-ghec (which depends on the schema data) in TypeScript.

@becco becco added the feature label May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants