[Schema Inaccuracy] head.label and head.user can be null in pull-request schema

Aperta Adatta ai principianti
#5,562 2 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
68/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
github, openapi
Ambito
api, documentation

Direzione di ricerca

Inizia da #/components/schemas/pull-request e ispeziona le definizioni di head.label e head.user, usando la risposta curl segnalata per pull request 51976 come esempio del malfunzionamento. Contrassegna entrambe le proprietà come nullable e documenta le condizioni di nullabilità, preservando la gestione esistente di head.repo; verifica che lo schema generato rifletta queste modifiche.

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

Descrizione

feature

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.

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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/rest-api-description

Tutte le issue di github/rest-api-description

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.