[Schema Inaccuracy] webhook-workflow-run-* components define pull request numbers and ids as 'number' instead of 'integer'

Aperta Adatta ai principianti

#4,408 aperta il 6/1/2025 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà: 2/5
Tempo stimato: 1-3 ore
Idoneità per principianti: 62/100

Tipo di issue: Bug
Chiarezza: Abbastanza chiara
Stato di attività: Ferma
Stack tecnologico: openapi
Ambito: api

Direzione di ricerca

Esamina api.github.com.2022-11-28.json nei tre percorsi dei componenti webhook-workflow-run identificati nell’issue, concentrandoti su pull_requests.items.properties.id e number. Modifica queste definizioni in integer e rivedi le altre definizioni di id tipizzate come number indicate nell’issue; il lavoro è completato quando le voci dello schema interessate corrispondono ai tipi integer previsti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

feature

Schema Inaccuracy

The workflow_run webhook schemas define pull request numbers and ids as floating point numbers instead of integers.

This applies to:

#/components/schemas/webhook-workflow-run-completed
#/components/schemas/webhook-workflow-run-in-progress
#/components/schemas/webhook-workflow-run-requested

where the path $.properties.workflow_run.properties.pull_requests.items.properties.id and $.properties.workflow_run.properties.pull_requests.items.properties.number are both defined as "type": "number".

Expected

Pull request numbers are always integers, and in practice, the workflow_run event data for workflow_run.pull_requests[].number and workflow_run.pull_requests[].id is always an integer. The schema is wrong here. Please correct their type to "integer".

In all of the type definitions in api.github.com.2022-11-28.json, the above locations are the only 3 definitions for the "number" property to use "type": "number". There are a total of 8 "id" definitions that type these as "type": "number", meaning that there are up to 5 additional locations which are probably wrong too.

Lingua principale: Nessun dato sulla lingua
Stelle: 1.6k
Fork: 342
Merge medio: 3h 33m
PR unite (30g): 51

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.