Skip to content

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

@ebickle

Description

@ebickle

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions