[Possible Schema Inaccuracy] multiple PR fields have odd description
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Inizia individuando la risposta/lo schema "pull-request" ed esamina le definizioni di mergeable, draft, rebaseable e mergeable_state. Confronta il loro comportamento opzionale e nullable con l'enum MergeStateStatus dell'API GraphQL; il lavoro è completato quando lo schema documenta chiaramente questi comportamenti oppure rappresenta correttamente i campi e i valori dell'enum.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I'm not entirely sure that these are schema inaccuracies but multiple fields of PRs (specifically the "pull-request" response / schema) have an odd definition:
mergeableis a nullable boolean field,it is not otherwise documented, it's hard to fathom why a PR would be something other than "mergeable" and "not mergeable". Either the field should be marked required, or the behaviour should be explained (I guess "we don't know if it's mergeable yet" is possible but in that case why not just set it to non-mergeable?).draftis somewhat similarly an optional boolean, it's not clear when it would be absent (possibly projects which don't support / allow draft PRs? still why have that in the response rather than justfalse?)rebaseableis both nullable and optional, same remarks as above.mergeable_stateis completely undocumented aside from knowing it's a string. Looking at the GraphQL API, it the example value ("clean") matches theMergeStateStatusenum. If this is the right conversion,mergeable_stateshould be defined as an enum with those values provided (and documented as they are in the graphql schema, maybe).
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 1.6k
- Fork
- 342
- Merge medio
- 2h 23m
- PR unite (30g)
- 57
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/rest-api-description
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
github/rest-api-description#7220 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
github/rest-api-description#7201 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Apertafeature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7162 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7135 ·
Tutte le issue di github/rest-api-description
Issue simili
-
Area: Excel support
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
yeti-platform/yeti#1380 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
griptape-ai/griptape#2353 ·