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

feat(swagger-ui-react): option for showMutatedRequest (#6273)

Browse Source 
Co-authored-by: neel <neelima.sri.vathsavai@autodesk.com>
This commit is contained in:
Tim Lai
2020-07-29 16:11:20 -07:00
committed by GitHub
parent fd5a59a3fd
commit b99ebe7dd3
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -95,6 +95,12 @@ HTTP methods that have the Try it out feature enabled. An empty array disables T
⚠️ 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.
#### `showMutatedRequest`: PropTypes.bool
If set to `true`, uses the mutated request returned from a requestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used.
⚠️ 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.

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

@@ -21,6 +21,7 @@ export default class SwaggerUI extends React.Component {
supportedSubmitMethods: this.props.supportedSubmitMethods, supportedSubmitMethods: this.props.supportedSubmitMethods,
defaultModelExpandDepth: this.props.defaultModelExpandDepth, defaultModelExpandDepth: this.props.defaultModelExpandDepth,
displayOperationId: this.props.displayOperationId, displayOperationId: this.props.displayOperationId,
showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true,
}) })
this.system = ui this.system = ui
@@ -92,6 +93,7 @@ SwaggerUI.propTypes = {
defaultModelExpandDepth: PropTypes.number, defaultModelExpandDepth: PropTypes.number,
plugins: PropTypes.arrayOf(PropTypes.object), plugins: PropTypes.arrayOf(PropTypes.object),
displayOperationId: PropTypes.bool, displayOperationId: PropTypes.bool,
showMutatedRequest: PropTypes.bool,
} }
SwaggerUI.defaultProps = { SwaggerUI.defaultProps = {