fix: array initial value to be undefined on try it out #9258
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When using the "Try it out" on a endpoint with a parameter that is an array and has an example value, that example value is defined as initial value for that parameter, despite the UI rendering the array with 0 item.
Motivation and Context
Example, this endpoint in the image bellow, has a single parameter that's an array of string and includes an example, when you click Try it out, the parameter renders with 0 items, so you would assume that when trying this endpoint no query parameters would be sent, but in reality the swagger-ui is sending the example value in the request:
2 possible solutions for this:
I think the latter is the best approach and the one that would change the little.
This pull request also implements the latter.
How Has This Been Tested?
I've tested this change using this example openapi.json schema:
To test this, just run this schema in the latest release of swagger-ui vs this pr version, and click try it out, then execute without changing any parameters.
Screenshots (if appropriate):
Checklist
My PR contains...
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests