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

feat(swagger-ui-react): add request snippets configuration (#7536)

Browse Source 
Closes #7523
This commit is contained in:
Mahtis Michel
2021-11-08 12:13:32 +01:00
committed by GitHub
parent c7b215b6bb
commit 3fea224a7d
2 changed files with 36 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -125,6 +125,18 @@ 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.
#### `requestSnippetsEnabled`: PropTypes.bool,
Enables the request snippet section. When disabled, the legacy curl snippet will be used. 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.
#### `requestSnippets`: PropTypes.object,
Configures the request snippet core plugin. See Swagger UI's [Display Configuration](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#display) for more details.
⚠️ 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.