Fix so query parameter filter=true/false enables/disables the filter bar instead of filtering by that string #6477
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
According to the configuration documentation filter "Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression."
Since url parameters are string we should compare against strings instead of booleans to check if the value is
true
to show the bar without filtering by any value orfalse
to hide the bar (although it is also hidden if no parameter is set).Motivation and Context
Fixes #6276
While testing I also realized that when
filter=false
instead of hiding the bar would filter by the word "false" https://petstore.swagger.io/?filter=falseHow Has This Been Tested?
Locally I have tested by sending the value
true
,false
and also other strings.Screenshots (if appropriate):
filter=true
filter=false
filter=other-value
Checklist
My PR contains...
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests