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

Aberta Para iniciantes

#4,408 aberta em 6/1/2025 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade: 2/5
Tempo estimado: 1-3 horas
Facilidade para iniciantes: 62/100

Tipo de issue: Bug
Clareza: Razoavelmente clara
Status de atividade: Estagnada
Stack de tecnologia: openapi
Domínio: api

Direção de pesquisa

Inspecione api.github.com.2022-11-28.json nos três caminhos de componentes webhook-workflow-run identificados na issue, com foco em pull_requests.items.properties.id e number. Altere essas definições para integer e revise as outras definições de id tipadas como number mencionadas na issue; considera-se concluído quando as entradas de esquema afetadas corresponderem aos tipos integer esperados.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante: Sem dados de linguagem
Estrelas: 1.6k
Forks: 342
Merge médio: 3h 33min
PRs com merge (30d): 51

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

Leia a issue inteira e depois o guia de contribuição do projeto.
Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
Faça um fork do repositório e trabalhe em uma branch.
Abra um pull request que referencie o número da issue.