[Schema Inaccuracy] "Add labels to an issue" requestBody and description incorrect
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 42/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api
Direzione di ricerca
Inizia individuando la definizione OpenAPI per POST /repos/{owner}/{repo}/issues/{issue_number}/labels e confronta i relativi schemi e le descrizioni di requestBody con il comportamento documentato in questa issue. Il lavoro è completo quando la descrizione dell’endpoint, le forme accettate e i vincoli minItems riflettono accuratamente il comportamento osservato dell’API.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Schema Inaccuracy
For POST /repos/{owner}/{repo}/issues/{issue_number}/labels, the description is currently
Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
and the requestBody is documented as
The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a
stringor anarrayof labels directly, but GitHub recommends passing an object with thelabelskey. You can also replace all of the labels for an issue. For more information, see "Set labels for an issue.
and the schema specifies, in effect:
- a lone $string
- an array of $strings
- an array of
{name: $string} - an object with a single property
labelswhose value is an array of strings - an object with a single property
labelswhose value is an array of{name: $string}
incorrect description
First off, the descriptions (of both the endpoint and the requestBody) assert that passing an empty array will remove all the labels, this does not happen, it may have been copied over from the "set labels for an issue" endpoint.
incorrect minItems
On every array, the schema declares minItems: 1, this seems to be untrue for form (2) / (3) which does accept an empty array (it just does nothing), it is true for form 4/5
(1) is not valid
Trying to pass a naked string to the endpoint results in a validation error:
r = session.post(
f'{pr.issue_url}/labels',
json="test",
)
=>
{"message":"Invalid request.\n\nNo subschema in \"anyOf\" matched.\nFor 'anyOf/0', \"test\" is not an array.\nFor 'anyOf/1', \"test\" is not an array.\nFor 'anyOf/2', \"test\" is not an object.","documentation_url":"https://docs.github.com/rest/issues/labels#add-labels-to-an-issue"}
(5) is not valid
Trying to pass a nested record results in a validation error:
r = session.post(
f'{pr.issue_url}/labels',
json={"labels": [{"name": "test"}]},
)
=>
{"message":"Invalid request.\n\nNo subschema in \"anyOf\" matched.\nFor 'anyOf/0', {\"labels\"=>[{\"name\"=>\"test\"}]} is not an array.\nFor 'anyOf/1', {\"labels\"=>[{\"name\"=>\"test\"}]} is not an array.\nFor 'items', {\"name\"=>\"test\"} is not a string.","documentation_url":"https://docs.github.com/rest/issues/labels#add-labels-to-an-issue"}
- 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
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
microsoft/magentic-ui#588 ·
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
alexgorbatchev/simple-ptt#3 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
CorrelAid/formtransform#44 ·