swagger-ui icon indicating copy to clipboard operation
swagger-ui copied to clipboard

Display static documentation information for multipart properties in OpenAPI 3.0 files

Open RichieLoco opened this issue 6 years ago • 19 comments

Following on from https://github.com/swagger-api/swagger-ui/issues/5164, I am suggesting that for specs with multipart/form-data that we allow the main request body of the spec to show a preview of the payload, rather than leaving it blank (and appearing unrendered) like so: v3 20 3_multipart For "Try it now" feature it appears rendered correctly: v3 20 3_multipart_tryitout I am proposing something similar to the above pic, even if text areas/drop-downs appear greyed out. Attached following spec as an example which highlights what I thought was an issue, but turns out to be a feature: v3.20.2_multipart_snippet.txt Cheers, Rich

RichieLoco avatar Feb 08 '19 07:02 RichieLoco

Possibly related (or duplicate): #4581

hkosova avatar Feb 11 '19 08:02 hkosova

@hkosova very closely related indeed, but this is for multipart/form-data properties, which display like parameters but are not parameters 😄

shockey avatar Feb 11 '19 17:02 shockey

Hi all! Do you have any updates on that issue?

mariaefi29 avatar Dec 26 '19 08:12 mariaefi29

Any updates? That's a bad limitation currently.

andreaszehender avatar Apr 16 '20 12:04 andreaszehender

any updates on this?

KhushbooBaheti avatar Nov 25 '20 15:11 KhushbooBaheti

Somewhere between 3.32.5 and 3.42.0 it doesn't even display any json in the try it now textbox any more.

Multipart support seems to be lagging behind the standard quite a bit now.

Multipart is extremely useful for sending object data + file data, which is actually a fairly common scenario. This actually worked better back in 3.16.0 with the v2 spec.

Is there a roadmap to improve the multipart experience?

Simon-Gregory-LG avatar Feb 27 '21 08:02 Simon-Gregory-LG

Any updates??

ypark9 avatar Apr 06 '21 19:04 ypark9

Need this too!

osteel avatar Apr 14 '21 17:04 osteel

Is there any workaround or other way as its looks very bad experience

jalagari avatar Apr 23 '21 11:04 jalagari

@jalagari at the moment I provide a sample JSON in the endpoint's description directly

osteel avatar Apr 23 '21 12:04 osteel

Are there plans to make this happen?

JMPSequeira avatar Apr 25 '21 21:04 JMPSequeira

Any updates on this?

emmanuelmathot avatar May 26 '21 08:05 emmanuelmathot

Hello everyone, i made a quick fix for this issue, regarding documentation of the multipart/form properties, on my fork. https://github.com/charalarg/swagger-ui. You can see the result on the readme file.

charalarg avatar Aug 23 '21 11:08 charalarg

Hello everyone, any updates on this issue?

hassanemad15697 avatar Oct 12 '22 09:10 hassanemad15697

Hello. Any update on this?

boukenka avatar Feb 17 '23 10:02 boukenka

Hello, it's really needed

Else i need go to bottom of swagger page and see schema in schema repository there.

Davidos533 avatar Apr 12 '23 09:04 Davidos533

Still needed, so +1

originalmk avatar Sep 22 '23 21:09 originalmk

I have a simple change that can help on this.

https://github.com/swagger-api/swagger-ui/issues/9756#issuecomment-2129004526

kenchen-cs avatar May 24 '24 09:05 kenchen-cs

neet it + 1

jearton avatar Jun 27 '24 06:06 jearton

Would still like to see this implemented. +1

peter-pundy-actabl avatar Feb 19 '25 17:02 peter-pundy-actabl

+1 this is a very bad limitation und could be easily solved :(

hasenbam avatar Mar 13 '25 15:03 hasenbam