Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

[Schema Inaccuracy] dismissal request and bypass request webhooks have no required fields

Ouverte
  • Quelque chose ne va pas ?
#4,800 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
38/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
openapi, typescript
Domaine
api, documentation

Piste de recherche

Commencez dans descriptions/ghec/ghec.json et examinez les composants de schéma répertoriés pour exemption, dismissal-request et bypass-request. Déterminez quelles propriétés sont obligatoires dans les payloads de webhook, ajoutez ces propriétés à la section required de chaque composant et vérifiez que les schémas obtenus produisent des types de webhook TypeScript exacts.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

feature

Schema Inaccuracy

The following schema components do not define any required fields, even though some fields are always present (e.g. primary keys):

  • exemption-request
  • exemption-response
  • dismissal-request-code-scanning-metadata
  • dismissal-request-secret-scanning-metadata
  • exemption-request-secret-scanning-metadata
  • dismissal-request-code-scanning
  • dismissal-request-secret-scanning
  • exemption-request-secret-scanning
  • exemption-request-push-ruleset-bypass

These components are used by the various bypass-request and dismissal-request webhooks, such as:

  • dismissal-request-secret-scanning-cancelled
  • dismissal-request-secret-scanning-completed
  • dismissal-request-secret-scanning-created
  • dismissal-request-secret-scanning-response-dismissed
  • dismissal-request-secret-scanning-response-submitted
  • dismissal-request-code-scanning-created
  • dismissal-request-code-scanning-response-submitted
  • bypass-request-secret-scanning-cancelled
  • bypass-request-secret-scanning-completed
  • bypass-request-secret-scanning-created
  • bypass-request-secret-scanning-response-dismissed
  • bypass-request-secret-scanning-response-submitted
  • bypass-request-push-ruleset-cancelled
  • bypass-request-push-ruleset-completed
  • bypass-request-push-ruleset-created
  • bypass-request-push-ruleset-response-dismissed
  • bypass-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.

Langage dominant
Aucune donnée de langage
Étoiles
1.6k
Forks
345
Merge moyen
2 h 30 min
PR mergées (30 j)
79

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/rest-api-description

Toutes les issues de github/rest-api-description

Issues similaires

Plus d'issues Backend & API Design

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.