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

feat: add tryItOutEnabled configuration (#6865)

Browse Source 
* feat: add tryItOutEnabled configuration

allow users to set tryItOutEnabled: true to display
the "Try it out" section by default

tryItOutEnabled to take === "true" for the
query string value or === true if someone
implements query string type parsing in the query
This commit is contained in:
Kyle Hoskins
2021-01-26 11:00:38 -06:00
committed by GitHub
parent 470e2fed9b
commit 265bdc07b7
10 changed files with 58 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -113,6 +113,12 @@ An array of functions that augment and modify Swagger UI's functionality. See Sw
⚠️ 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.
#### `tryItOutEnabled`: PropTypes.bool
Controls whether the "Try it out" section should start enabled. The default is false.
⚠️ 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.
## Limitations
* Not all configuration bindings are available.