[Schema Inaccuracy] webhook-workflow-run-* components define pull request numbers and ids as 'number' instead of 'integer' #4408
Description
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.