[Schema Inaccuracy] dismissal request and bypass request webhooks have no required fields
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 38/100
- Issue-Typ
- Bug
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- openapi, typescript
- Bereich
- api, documentation
Rechercherichtung
Beginnen Sie in descriptions/ghec/ghec.json und prüfen Sie die aufgeführten Schema-Komponenten für exemption, dismissal-request und bypass-request. Ermitteln Sie, welche Eigenschaften in den Webhook-Payloads nicht optional sind, fügen Sie diese Eigenschaften zum required-Abschnitt jeder Komponente hinzu und verifizieren Sie, dass die resultierenden Schemas genaue TypeScript-Webhook-Typen erzeugen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 1.6k
- Forks
- 345
- Ø Merge
- 2 Std. 35 Min.
- Gemergte PRs (30 T.)
- 73
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus github/rest-api-description
-
feature
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
github/rest-api-description#7286 ·
Maintainer antworten meist innerhalb von 1 Tag
-
feature
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
github/rest-api-description#7266 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
feature
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
github/rest-api-description#7246 ·
Maintainer antworten meist innerhalb von 1 Tag
-
feature
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
github/rest-api-description#7220 ·
Maintainer antworten meist innerhalb von 1 Tag
-
feature
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
github/rest-api-description#7201 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in github/rest-api-description
Ähnliche Issues
-
comp/gateway comp/plugins duplicate P3 type/bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
NousResearch/hermes-agent#137019 ·
Maintainer antworten meist innerhalb von 1 Tag
-
status: team-only type: dependency-upgrade
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
spring-projects/spring-boot#52138 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
anthropics/sandbox-runtime#696 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
confluence: a paged listing's links re-encode a parameter they carry, where real carries it as sentOffenfidelity
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 63/100
Maintainer antworten meist innerhalb von 1 Tag
-
area:deploy task
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
wilanis/wilanis-js#1017 ·
Maintainer antworten meist innerhalb von 1 Tag