swagger-api / swagger-api/swagger-ui
Display static documentation information for multipart properties in OpenAPI 3.0 files
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
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:
For "Try it now" feature it appears rendered correctly:
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the static multipart/form-data request-body rendering with the existing “Try it now” rendering, using the attached v3.20.2 multipart specification as the reproduction case. Identify the request-body UI entry point and its related tests, then verify that multipart properties display a non-interactive payload preview instead of appearing blank.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100