kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(swagger-ui-react): add support of filter prop (#7547)

Browse Source 
Co-authored-by: Mahtis Michel <mathis.michel@outlook.de>
Co-authored-by: Vladimir Gorej <vladimir.gorej@gmail.com>

Closes #7546
This commit is contained in:
Andriy Semenyuk
2021-11-08 13:08:15 +01:00
committed by GitHub
parent 9d2b35aeb2
commit b71446caa0
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
flavors/swagger-ui-react/README.md
View File

@@ -125,6 +125,10 @@ Controls whether the "Try it out" section should start enabled. The default is f
⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change.
#### `filter`: PropTypes.oneOfType([PropTypes.string, PropTypes.bool])
If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. See Swagger UI's [Plug Points](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plug-points.md#fnopsfilter) to customize the filtering behavior.
#### `requestSnippetsEnabled`: PropTypes.bool,
Enables the request snippet section. When disabled, the legacy curl snippet will be used. The default is false.