Repository navigation
Description
β οΈ Note to onlookers: don't rely on this information, this issue is out of date! We're breaking everything here out into their own issues soon.
This is a collection ticket for OAS3 specification features that are not yet supported by Swagger-UI.
Items that affect both UI and Client will be listed here as well, but Client-only items will be filed in the Client issue tracker.
Significant items should be broken out into their own ticket when work begins, but simple items can be addressed as a line item here.
Rendering
- Parameter
example/examplesis not displayed
#3616 is open for this.
Implement functionality for Try-It-Out simultaneously.
- Parameter
style/explodeis not displayed
- Parameter
allowReservedis not displayed
- Parameter
contentis not displayed
Reuse method for displaying Request Bodies
Render all media types, even though only one is allowed by the specification
- Media type
example/examplesis not displayed
Identical to Request Body, Parameter content
- Callbacks are not rendered
- Media type
encodingis not displayed
This has lots of moving parts before it's useful: breaking down jsonschema, rendering individual inputs, handling file uploads, etc
- Discriminator objects are not displayed
This will change the way we display allOf, anyOf, oneOf, not.
- Link-level servers are not displayed
Try-It-Out
- Parameter
style/explodeis not considered in request construction
Needs support in Swagger-Client, mostly. Important!
- Links can't be used to stage another operation
- Link-level servers are not available for executing requests
- Parameter
contentvalues are not rendered for Try-It-Out - Parameter
encodingvalues are not considered - Blacklisted header names (
Accept,Content-Type,Authorization) are not filtered out - Path and operation-level servers are not available for executing requests
- Parameter
allowEmptyValueis not considered in request value validation
Add a checkbox that allows construction of a request with that parameter empty (may require value validation changes)
if βsend empty valueβ is checked - youβre sending an empty value meaning the requirement is satisfied
Implementation may be best served by a split of Client'sbuildRequestbased on definition version
- Security type
openIdConnectis not supported - Form Data:
- Nested object serialization is not handled correctly (OAS 3.0 Form Data Try-It-Out object serializationΒ #3788)
- Form data fields should be displayed as items instead of a JSON object
- File upload UI should appear when applicable
Activity
shockey commentedon Sep 8, 2017
cc: @webron
hkosova commentedon Sep 11, 2017
Also:
Rendering
description(implemented in UI v. 3.20.2 / Editor v. 3.6.17)descriptionnullableattribute in schemasTry It Out / Rendering
enumas dropdown (implemented in UI v. 3.4.0 / Editor v. 3.1.12)arrayitems (implemented in UI v. 3.4.0 / Editor v. 3.1.12)allowReserved=false(Query parameters with allowReserved=false not percent-encoded during OAS3 "Try It Out"Β #3817)zhandao commentedon Sep 14, 2017
In the OAS3,
enumis moved intoschema, UI has not yet support this.leehicks commentedon Oct 18, 2017
Is there an update on when Authentication/Authorization will be supported by the UI? We used the "authorizations" in 2.0 heavily and are wanting to release with 3.0 support soon. This is a big missing piece for us. I saw mention in #3774, #3705, #3665 that it is being worked on in this issue number.
webron commentedon Oct 18, 2017
Yup. The authorization should be included by in this week's release. Keep in mind it's more about compatibility with what existed in 2.0 (base auth, oauth2, and api key). That means that OIDC is not going to be available yet. As for bearer (JWT!), that might be in, but @shockey would be able to verify.
shockey commentedon Oct 18, 2017
will be supported π
webron commentedon Oct 18, 2017
O.M.G. !!!! !! ! π±
shockey commentedon Oct 21, 2017
@leehicks, FYI, support for most 3.0 security schemes were added in tonight's release! Check out the release notes for more info.
webron commentedon Oct 23, 2017
@leehicks - release notes - https://github.com/swagger-api/swagger-ui/releases/tag/v3.4.0
If you encountered an issue with the implementation, please file a ticket, providing the requested details in the template.
csvikram commentedon Nov 15, 2017
@webron - Any progress on below issues?
webron commentedon Nov 15, 2017
We try to keep the list above up to date...
craigjbass commentedon Nov 16, 2017
Hey - looks like d587d9c was regressed at some point between 3.3.1 and 3.4.4. ( Callbacks are not rendered )
webron commentedon Nov 16, 2017
@craigjbass thanks, see swagger-api/swagger-editor#1565.
8 remaining items
heldersepu commentedon Feb 24, 2018
@webron the comment from @jelanwar got me thinking, "anything" ...
maybe this is an opportunity to monetize Open Source projects?
What if people interested in speeding features/bug fixes could put a coin bounty on the issues?
That should bring developers to submit PR to collect the bounty
akalongman commentedon Mar 22, 2018
We really need the feature described in #4345
imsopov commentedon Apr 30, 2018
Please allow this soon!
zeromake commentedon Sep 26, 2018
doc
in is
headersupportin is
cookienot support has errorerror:
hkosova commentedon Sep 26, 2018
@zeromake make sure your spec is
openapi: 3.0.0and notswagger: '2.0'.malutanpetronel commentedon Oct 31, 2018
..
* @OA\MediaType(
* mediaType="multipart/form-data",
* @OA\Schema(
* type="object",
* @OA\Property(
* property="files",
* description="Choose a file to upload",
* type="array",
* @OA\Items(
* description="file",
* type="string",
* format="binary",
* ),
...
after this I use
public function upload(Request $request)
{
//$imageContent = $request->getContent();
$files = $request->input('files');
$files = explode(',', $files);
foreach ($files as $file) {
dd($file);
}
}
and get
..characters">[object File]"...
How I am suppose to play with the [object File] above to finish the upload please ?
lcahlander commentedon Jan 24, 2019
When is multipart file upload going to be supported. You had this before!
nicod-pc commentedon Jan 25, 2019
It is supported in 2.9.2.
lcahlander commentedon Jan 25, 2019
It is not showing up for me. Please see my stackoverflow https://stackoverflow.com/questions/54334438/how-do-i-specify-a-multifile-upload-in-openapi
lcahlander commentedon Jan 25, 2019
The picker shows up, but the UI does not appear to send the filename or mime type along with the binary.
hkosova commentedon Jan 29, 2019
@lcahlander
This is issue #4600.
beltschatsar commentedon Apr 24, 2019
Hi,
Can we have status about this missing feature ?
So that an api call output can serve as input for another call (as explained there: https://swagger.io/docs/specification/links/)
Thanks!
j-ibarra commentedon Apr 2, 2020
Hi there; I am trying to send multiple files in one property, as described in the Specification, I declare
when I send the request I spect
curl -X POST -H "Content-Type: multipart/form-data" "http://localhost:3000/testmultipart" --form 'file=@file1.ext' --form 'file=@file3.ext' --form 'file=@file2.ext' 'but I see this in the body
{ "file": [ "string" ] }silkfire commentedon May 7, 2023
What's the status of
and rendering links as hyperlinks?
paul-uz commentedon Jun 2, 2026
Any update on Links?