Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display static documentation information for multipart properties in OpenAPI 3.0 files #5169

Open
RichieLoco opened this issue Feb 8, 2019 · 20 comments · May be fixed by #10166
Open

Display static documentation information for multipart properties in OpenAPI 3.0 files #5169

RichieLoco opened this issue Feb 8, 2019 · 20 comments · May be fixed by #10166

Comments

@RichieLoco
Copy link

Following on from #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

@hkosova
Copy link
Contributor

hkosova commented Feb 11, 2019

Possibly related (or duplicate): #4581

@shockey
Copy link
Contributor

shockey commented Feb 11, 2019

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

@mariaefi29
Copy link

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

@andreaszehender
Copy link

Any updates? That's a bad limitation currently.

@KhushbooBaheti
Copy link

any updates on this?

@Simon-Gregory-LG
Copy link

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?

@ypark9
Copy link

ypark9 commented Apr 6, 2021

Any updates??

@osteel
Copy link

osteel commented Apr 14, 2021

Need this too!

@jalagari
Copy link

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

@osteel
Copy link

osteel commented Apr 23, 2021

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

@JMPSequeira
Copy link

Are there plans to make this happen?

@emmanuelmathot
Copy link

Any updates on this?

charalarg added a commit to charalarg/swagger-ui that referenced this issue Aug 23, 2021
@charalarg
Copy link

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.

@hassanemad15697
Copy link

Hello everyone, any updates on this issue?

@boukenka
Copy link

Hello. Any update on this?

@Davidos533
Copy link

Hello, it's really needed

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

@originalmk
Copy link

Still needed, so +1

@kenchen-cs
Copy link

kenchen-cs commented May 24, 2024

I have a simple change that can help on this.

#9756 (comment)

@jearton
Copy link

jearton commented Jun 27, 2024

neet it + 1

@BreakBB BreakBB linked a pull request Oct 11, 2024 that will close this issue
17 tasks
@peter-pundy-actabl
Copy link

Would still like to see this implemented. +1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.