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

feat(swagger-ui-react): add showCommonExtensions option (#8436)

Browse Source
This commit is contained in:
afrkorsakow
2023-03-07 23:25:08 +09:00
committed by GitHub
parent 9895e37078
commit 6b56e3828e
2 changed files with 9 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

@@ -114,6 +114,12 @@ Controls the display of vendor extension (`x-`) fields and values for Operations
⚠️ 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.
#### `showCommonExtensions`: PropTypes.bool
Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters.
⚠️ 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 #### `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. 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.

3
flavors/swagger-ui-react/index.jsx
View File

@@ -33,6 +33,7 @@ export default class SwaggerUI extends React.Component {
showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true, showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true,
deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false, deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false,
showExtensions: this.props.showExtensions, showExtensions: this.props.showExtensions,
showCommonExtensions: this.props.showCommonExtensions,
filter: ["boolean", "string"].includes(typeof this.props.filter) ? this.props.filter : false, filter: ["boolean", "string"].includes(typeof this.props.filter) ? this.props.filter : false,
persistAuthorization: this.props.persistAuthorization, persistAuthorization: this.props.persistAuthorization,
withCredentials: this.props.withCredentials, withCredentials: this.props.withCredentials,
@@ -122,6 +123,7 @@ SwaggerUI.propTypes = {
presets: PropTypes.arrayOf(PropTypes.func), presets: PropTypes.arrayOf(PropTypes.func),
deepLinking: PropTypes.bool, deepLinking: PropTypes.bool,
showExtensions: PropTypes.bool, showExtensions: PropTypes.bool,
showCommonExtensions: PropTypes.bool,
filter: PropTypes.oneOfType([ filter: PropTypes.oneOfType([
PropTypes.string, PropTypes.string,
PropTypes.bool, PropTypes.bool,
@@ -146,6 +148,7 @@ SwaggerUI.defaultProps = {
deepLinking: false, deepLinking: false,
displayRequestDuration: false, displayRequestDuration: false,
showExtensions: false, showExtensions: false,
showCommonExtensions: false,
filter: false, filter: false,
requestSnippetsEnabled: false, requestSnippetsEnabled: false,
requestSnippets: { requestSnippets: {