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

feat(swagger-ui-react): defaultModelExpandDepth and plugins props (#5594)

Browse Source 
* Add plugins as React prop

* Add defaultModelExpandDepth as React prop

* Add documentation re: defaultModelExpandDepth and plugins props

* Fetched latest and rebased on that

* add on-mount-only warning messages to new options

Co-authored-by: Todd Lemoine <43755148+tlemoine-jama@users.noreply.github.com>
Co-authored-by: kyle shockey <kyleshockey@gmail.com>
This commit is contained in:
Peter Mooney
2020-01-04 17:15:33 -08:00
committed by kyle shockey
parent 87dfc8da26
commit 296f73aa00
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -71,6 +71,18 @@ Controls the default expansion setting for the operations and tags. It can be 'l
⚠️ 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. ⚠️ 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.
#### `defaultModelExpandDepth`: PropTypes.number
The default expansion depth for models (set to -1 completely hide the models).
⚠️ 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.
#### `plugins`: PropTypes.arrayOf(PropTypes.object),
An array of objects that augment and modify Swagger UI's functionality. See Swagger UI's [Plugin API](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plugin-api.md) 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 ## Limitations
* Not all configuration bindings are available. * Not all configuration bindings are available.

4
flavors/swagger-ui-react/index.js
View File

@@ -11,12 +11,14 @@ export default class SwaggerUI extends React.Component {
componentDidMount() { componentDidMount() {
const ui = swaggerUIConstructor({ const ui = swaggerUIConstructor({
plugins: this.props.plugins,
spec: this.props.spec, spec: this.props.spec,
url: this.props.url, url: this.props.url,
requestInterceptor: this.requestInterceptor, requestInterceptor: this.requestInterceptor,
responseInterceptor: this.responseInterceptor, responseInterceptor: this.responseInterceptor,
onComplete: this.onComplete, onComplete: this.onComplete,
docExpansion: this.props.docExpansion, docExpansion: this.props.docExpansion,
defaultModelExpandDepth: this.props.defaultModelExpandDepth,
}) })
this.system = ui this.system = ui
@@ -82,4 +84,6 @@ SwaggerUI.propTypes = {
responseInterceptor: PropTypes.func, responseInterceptor: PropTypes.func,
onComplete: PropTypes.func, onComplete: PropTypes.func,
docExpansion: PropTypes.oneOf(['list', 'full', 'none']), docExpansion: PropTypes.oneOf(['list', 'full', 'none']),
defaultModelExpandDepth: PropTypes.number,
plugins: PropTypes.arrayOf(PropTypes.object),
} }