OAI / OAI/OpenAPI-Specification
Callbacks runtime expressions in multipart bodies
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Markdown
- Sterne
- 31.2k
- Forks
- 9.2k
- Ø Merge
- 6 Std. 37 Min.
- Gemergte PRs (30 T.)
- 27
Beschreibung
Hi,
In the OpenAPI spec, when defining a Callback Object, you can use a runtime expression in the form of:
$request.body#...
What goes after "body" should be a JSON pointer expression.
However, when the HTTP request contains a multipart body, I fail to see how to reference a specific body part, where the JSON pointer expression is to be applied.
Any hint on how to express this in OpenAPI?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den verlinkten Abschnitten zum OpenAPI 3.0.2 Callback Object und zu Runtime Expressions und vergleiche anschließend deren Definition von $request.body mit Multipart-Request-Bodys. Ermittle, ob auf einen Multipart-Part über die bestehende JSON-Pointer-Form zugegriffen werden kann; abgeschlossen ist die Aufgabe, wenn die Spezifikation den unterstützten Ausdruck eindeutig dokumentiert oder die erforderliche Änderung an der Spezifikation identifiziert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi
- Bereich
- api
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Ruhig
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100