Schema Inaccuracy
The following schema components do not define any required fields, even though some fields are always present (e.g. primary keys):
exemption-requestexemption-responsedismissal-request-code-scanning-metadatadismissal-request-secret-scanning-metadataexemption-request-secret-scanning-metadatadismissal-request-code-scanningdismissal-request-secret-scanningexemption-request-secret-scanningexemption-request-push-ruleset-bypass
These components are used by the various bypass-request and dismissal-request webhooks, such as:
dismissal-request-secret-scanning-cancelleddismissal-request-secret-scanning-completeddismissal-request-secret-scanning-createddismissal-request-secret-scanning-response-dismisseddismissal-request-secret-scanning-response-submitteddismissal-request-code-scanning-createddismissal-request-code-scanning-response-submittedbypass-request-secret-scanning-cancelledbypass-request-secret-scanning-completedbypass-request-secret-scanning-createdbypass-request-secret-scanning-response-dismissedbypass-request-secret-scanning-response-submittedbypass-request-push-ruleset-cancelledbypass-request-push-ruleset-completedbypass-request-push-ruleset-createdbypass-request-push-ruleset-response-dismissedbypass-request-push-ruleset-response-submitted
Expected
The schemas of the dismissal request and bypass request webhooks should have all non-optional fields listed in required sections of their schema components.
For example, most of the fields of exemption-request are likely non-optional in GitHub's implementation: id (primary key), number (alternate key), repository_id (a request needs a repository), requester_login (a user needs to create the request), request_type, status, created_at, html_url. I don't know the exact values since it would be specific to the GitHub database and implementation.
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.
Schema Inaccuracy
The following schema components do not define any
requiredfields, even though some fields are always present (e.g. primary keys):exemption-requestexemption-responsedismissal-request-code-scanning-metadatadismissal-request-secret-scanning-metadataexemption-request-secret-scanning-metadatadismissal-request-code-scanningdismissal-request-secret-scanningexemption-request-secret-scanningexemption-request-push-ruleset-bypassThese components are used by the various
bypass-requestanddismissal-requestwebhooks, such as:dismissal-request-secret-scanning-cancelleddismissal-request-secret-scanning-completeddismissal-request-secret-scanning-createddismissal-request-secret-scanning-response-dismisseddismissal-request-secret-scanning-response-submitteddismissal-request-code-scanning-createddismissal-request-code-scanning-response-submittedbypass-request-secret-scanning-cancelledbypass-request-secret-scanning-completedbypass-request-secret-scanning-createdbypass-request-secret-scanning-response-dismissedbypass-request-secret-scanning-response-submittedbypass-request-push-ruleset-cancelledbypass-request-push-ruleset-completedbypass-request-push-ruleset-createdbypass-request-push-ruleset-response-dismissedbypass-request-push-ruleset-response-submittedExpected
The schemas of the dismissal request and bypass request webhooks should have all non-optional fields listed in
requiredsections of their schema components.For example, most of the fields of
exemption-requestare likely non-optional in GitHub's implementation:id(primary key),number(alternate key),repository_id(a request needs a repository),requester_login(a user needs to create the request),request_type,status,created_at,html_url. I don't know the exact values since it would be specific to the GitHub database and implementation.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.