OAI / OAI/OpenAPI-Specification
Is it possible to indicate the requiredness of a `multipart/form-data`'s request's `filename` directive?
Nessuno ha ancora preso questa issue.
- Lingua principale
- Markdown
- Stelle
- 31.2k
- Fork
- 9.2k
- Merge medio
- 6h 37m
- PR unite (30g)
- 27
Descrizione
As far as I can tell, the required property in the OpenAPI spec can be used to specify that an entire multipart/form-data part is required, but it cannot be used to indicate whether the filename directive is required.
This would be pretty useful since some multipart/form-data endpoints require the filename directive while others do not. If OpenAPI allowed specifying those semantics, then that could be used in various generators that consume OpenAPI (e.g. an SDK generator could check whether the end-user supplied a filename if it's required).
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.
Direzione di ricerca
Inizia leggendo i requisiti di OpenAPI per multipart/form-data e la definizione collegata di filename in Content-Disposition. Determina come la semantica richiesta di filename potrebbe essere rappresentata per consumer come i generatori di SDK e definisci il completamento tramite una modifica della specifica concordata con i relativi esempi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- openapi
- Ambito
- api, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100