[Question] Optional response payloads
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Leggi le indicazioni di OpenAPI Response Object e il riferimento a RFC 7231 menzionato nell’issue, concentrandoti sul fatto che una risposta con contenuto consenta un payload vuoto. Il lavoro è completato quando la specifica documenta chiaramente come esprimere le risposte che possono includere o omettere un payload, soprattutto per i codici di stato 4xx e 5xx.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Hi,
How to express in OpenAPI that a response payload is optional for a given HTTP response code?
I noticed that the keyword "required: true/false" is applicable only to Request Body Object, but not to Response Body Object.
So, if a Response Body Object has a "content" field, does it indicate that a response payload is mandatory, and receiving an empty payload is considered as not allowed?
My goal is to express that a given HTTP response (mainly error codes, 4xx, 5xx) can be sent with, or without response payload. Per RFC 7231, the presence of response payloads in these error codes is encouraged (should) but it's not really mandated.
Thanks!
/Jesús.
- Lingua principale
- Markdown
- Stelle
- 31.2k
- Fork
- 9.2k
- Merge medio
- 2g 9h
- PR unite (30g)
- 17
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi 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 OAI/OpenAPI-Specification
-
Housekeeping
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 45/100
OAI/OpenAPI-Specification#5566 ·
I maintainer di solito rispondono entro 1 giorno
-
Housekeeping
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 35/100
OAI/OpenAPI-Specification#5562 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Housekeeping
Difficoltà 5/5 Più di una settimana Idoneità per principianti 10/100
OAI/OpenAPI-Specification#5556 · 3 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
v3.2.1 releaseForse di nuovo libera @lornajane l’ha presa 33 giorni fa e non c’è nessuna pull request aperta. Aperta
OAI/OpenAPI-Specification#5460 · 11 commenti · 1 reazione · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
param serialization
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
OAI/OpenAPI-Specification#5366 · 12 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di OAI/OpenAPI-Specification
Issue simili
-
effort: low prio: low ready
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
digitalfabrik/integreat-cms#4616 ·
I maintainer di solito rispondono entro 5 giorni
-
refactor topic-map
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
Add an EPUB parserApertaarea: core good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
openapi/gknowledge#21 ·
-
get() for StrEnumForse già presa @FeJo5952 l’ha presa oggi. Apertagood first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
collective/icalendar#1921 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
ETQ admin, le select de condition d'une annotation répétable liste les champs publics deux foisAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
demarche-numerique/demarche.numerique.gouv.fr#14301 ·
I maintainer di solito rispondono entro 1 giorno