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

support for supportedSubmitMethods property in react component (#5376)

Browse Source 
* support for supportedSubmitMethods property in react component

* update react README

Co-authored-by: Radek <radek.miazio@skysanner.net>
Co-authored-by: kyle shockey <kyle.shockey1@gmail.com>
This commit is contained in:
MoOmEeN
2020-03-23 00:17:56 +00:00
committed by GitHub
parent 95e72e7c70
commit 6f1dd08e2a
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -83,6 +83,12 @@ An array of objects that augment and modify Swagger UI's functionality. See Swag
⚠️ 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.
#### `supportedSubmitMethods`: PropTypes.arrayOf(PropTypes.oneOf(['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace']))
HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display.
⚠️ 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

@@ -18,6 +18,7 @@ export default class SwaggerUI extends React.Component {
responseInterceptor: this.responseInterceptor, responseInterceptor: this.responseInterceptor,
onComplete: this.onComplete, onComplete: this.onComplete,
docExpansion: this.props.docExpansion, docExpansion: this.props.docExpansion,
supportedSubmitMethods: this.props.supportedSubmitMethods,
defaultModelExpandDepth: this.props.defaultModelExpandDepth, defaultModelExpandDepth: this.props.defaultModelExpandDepth,
}) })
@@ -84,6 +85,9 @@ 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']),
supportedSubmitMethods: PropTypes.arrayOf(
PropTypes.oneOf(['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'])
),
defaultModelExpandDepth: PropTypes.number, defaultModelExpandDepth: PropTypes.number,
plugins: PropTypes.arrayOf(PropTypes.object), plugins: PropTypes.arrayOf(PropTypes.object),
} }