feat: Implement a configuration option for the initial "send empty value" checkbox state. #10274
+28
−4
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
This new configuration option
defaultSendEmptyValue
/DEFAULT_SEND_EMPTY_VAlUE
can be used to set the initial state of the "send empty value" checkbox. Default is true (checked).Motivation and Context
Fixes #6505
In our API, we have lots of multipart form fields which are allowed to be ommitted, but when provided must follow some pattern (e.g. valid Date, URL, email, etc).
Currently these are all sent as empty strings ("Send empty value" is checked) by default,
which causes lots of errors.
Users interacting with the form must un-check these fields when not providing a value.
Being able to set "Send empty value" to un-checked (false) by default, results in a much better user experience.
How Has This Been Tested?
I have built swagger-ui locally with my changes and swapped
swagger-ui-bundle.js
into our project to test it.Screenshots (if appropriate):
Checklist
My PR contains...
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests
Re tests: I have updated the docker config tests. Not sure if any more tests are required.