[Schema Inaccuracy] Pull Request Review Comment `position` should be nullable

Aperta
#5,568 3 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
55/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia individuando lo schema dei commenti di revisione delle Pull Request nella descrizione OpenAPI e confronta il relativo campo position con le risposte dell'API mostrate nella issue. Contrassegna position come nullable e verifica che gli schemi sia per l'elenco sia per il recupero dei commenti di revisione riflettano il valore null osservato.

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

Descrizione

feature

Schema Inaccuracy

For each Pull Request Comment in the API, it has a position field attached. Some comments are not attached to a position so this field is null. The Schema does not reflect this nuance.

Expected

position in Pull Request review comments should be marked as nullable

Reproduction Steps

We have observed this in 2 different APIs, either listing PR review comments or fetching a specific comment:

$ curl https://api.github.com/repos/pytorch/tutorials/pulls/2120/comments
$ curl https://api.github.com/repos/pytorch/tutorials/pulls/comments/1024558033

In both cases, the position field is null:

...
"position": 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.