[Schema Inaccuracy] alert field of secret scanning alert webhook events have no required fields
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 55/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi, typescript
- Ambito
- api
Direzione di ricerca
Inizia individuando il componente dello schema secret-scanning-alert-webhook e le descrizioni dei webhook webhook-secret-scanning-alert-* menzionate nell’issue. Usa l’esempio TypeScript con @octokit/openapi-webhooks-types-ghec per esaminare il tipo di evento generato; il lavoro è completato quando le proprietà di alert sono obbligatorie invece di includere undefined.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Schema Inaccuracy
The secret-scanning-alert-webhook schema component, used by the alert field of the webhook-secret-scanning-alert-* webhooks (e.g. webhook-secret-scanning-alert-created, does not have any required fields.
The alert is the subject of the webhook and is never optional. Many of the fields of the alert are primary keys or other required elements, such as number, created_at, updated_at, url, html_url, and many more.
Expected
The alert field of all of the webhook-secret-scanning-alert- webhooks should have required properties.
Reproduction Steps
Discovered by using TypeScript and reviewing the code of the ghec REST API descriptions. Using code, it can be discovered by:
import { webhooks } from '@octokit/openapi-webhooks-types-ghec'
type SecretScanningAlertCreatedEvent = webhooks['secret-scanning-alert-created']['post']['requestBody']['content']['application/json'];
const event: SecretScanningAlertCreatedEvent;
// Review type of event - all fields have a type that includes `| undefined`
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 1.6k
- Fork
- 342
- Merge medio
- 2h 23m
- PR unite (30g)
- 57
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/rest-api-description
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
github/rest-api-description#7220 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
github/rest-api-description#7201 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Apertafeature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7162 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7135 ·
Tutte le issue di github/rest-api-description
Issue simili
-
Area: Excel support
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
yeti-platform/yeti#1380 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
griptape-ai/griptape#2353 ·