[Schema Inaccuracy] head.label and head.user can be null in pull-request schema
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 68/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Estagnada
- Stack de tecnologia
- github, openapi
- Domínio
- api, documentation
Direção de pesquisa
Comece em #/components/schemas/pull-request e inspecione as definições de head.label e head.user, usando a resposta de curl relatada para pull request 51976 como o exemplo da falha. Marque ambas as propriedades como nullable e documente as condições de nulabilidade, preservando o tratamento existente para head.repo; verifique se o schema gerado reflete essas alterações.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Schema Inaccuracy
The current schema for #/components/schemas/pull-request defines head.label and head.user as required.
Expected
head.label and head.user should have nullable: true with the nullability conditions documented (from what I understand, if the user's account was deleted for some reason: all the cases I can see are for "ghost" users)
Reproduction Steps
❯ curl -s https://api.github.com/repos/odoo/odoo/pulls/51976 | jq .head
{
"label": null,
"ref": "12.0",
"sha": "3cf7aba2e293417c6e8a6a4785624c8315ccbb7a",
"user": null,
"repo": null
}
Side-note
The same issue was fixed for head.repo as reported in https://github.com/github/rest-api-description/issues/161 and https://github.com/github/rest-api-description/issues/424, would be nice to also add a description to that property explaining the conditions under which it can be null.
- 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
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.
Mais de github/rest-api-description
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
github/rest-api-description#7201 ·
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Abertafeature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
github/rest-api-description#7162 ·
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
github/rest-api-description#7135 ·
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
github/rest-api-description#7111 · 1 comentário ·
Todas as issues de github/rest-api-description
Issues semelhantes
-
[Bug]: Matrix progress drafts fail with "Matrix runtime not initialized" during tool activity Abertabug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
AXERA-TECH/ax-llm#77 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
games-on-whales/wolf#509 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100