Specify additional known responses other than 200 OK in swagger schema
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Inizia individuando le definizioni dello schema Swagger/OpenAPI per le operazioni che attualmente descrivono solo risposte 200. Esamina le risposte di errore comuni documentate, incluse 401 e 422, e verifica che i client generati possano vedere le risposte note per ogni operazione. Il lavoro è completato quando lo schema descrive le risposte di successo e gli errori noti rilevanti per tali operazioni.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Tripletex's schema describes 200 OK responses, like this:
but it is lacking in regards to describing the other expected responses like 401, 422 etc. This results in generated clients[^2] not knowing of all responses an operation may yield, in this case it has no knowledge of any errors:
If I understand swagger's doc^1 correctly it would be appropriate to include other common responses too:
Note that an API specification does not necessarily need to cover all possible HTTP response codes, since they may not be known in advance. However, it is expected to cover successful responses and any known errors. By "known errors" we mean, for example, a 404 Not Found response for an operation that returns a resource by ID, or a 400 Bad Request response in case of invalid operation parameters.
[^2]: Example https://openapi-ts.pages.dev/
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 49
- Fork
- 47
- Merge medio
- 1h 1m
- PR unite (30g)
- 1
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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 Tripletex/tripletex-api2
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
Tripletex/tripletex-api2#133 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Tripletex/tripletex-api2#130 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
Tripletex/tripletex-api2#127 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
Tripletex/tripletex-api2#126 · 1 reazione ·
-
faktura( 1500 konto) Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
Tripletex/tripletex-api2#114 ·
Tutte le issue di Tripletex/tripletex-api2
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
mksglu/context-mode#1200 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr impact:auth-provider issue-rating: 🌊 off-meta tidepool P2
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 80/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100