OAI / OAI/OpenAPI-Specification

Callbacks runtime expressions in multipart bodies

Aperta
#2,146 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

links media and encoding question
Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

Descrizione

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?

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalle sezioni collegate Callback Object e runtime expressions di OpenAPI 3.0.2, quindi confronta la loro definizione di $request.body con i body delle richieste multipart. Determina se una parte multipart può essere indirizzata utilizzando la forma esistente di JSON Pointer; il lavoro è completo quando la specifica documenta chiaramente l’espressione supportata oppure identifica la modifica necessaria alla specifica.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
openapi
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.