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

feat(swagger-ui-react): add showExtensions option (#7563)

Browse Source 
Closes #5892
This commit is contained in:
glebbash
2021-11-08 10:37:28 +02:00
committed by GitHub
parent 83021df9b0
commit d7ec726886
2 changed files with 8 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

@@ -101,6 +101,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.
#### `showExtensions`: PropTypes.bool
Controls the display of vendor extension (`x-`) fields and values for Operations, Parameters, Responses, and Schema.
⚠️ 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.

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

@@ -24,6 +24,7 @@ export default class SwaggerUI extends React.Component {
defaultModelExpandDepth: this.props.defaultModelExpandDepth, defaultModelExpandDepth: this.props.defaultModelExpandDepth,
displayOperationId: this.props.displayOperationId, displayOperationId: this.props.displayOperationId,
tryItOutEnabled: this.props.tryItOutEnabled, tryItOutEnabled: this.props.tryItOutEnabled,
showExtensions: this.props.showExtensions,
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,
}) })
@@ -112,4 +113,5 @@ SwaggerUI.defaultProps = {
defaultModelsExpandDepth: 1, defaultModelsExpandDepth: 1,
presets: [], presets: [],
deepLinking: false, deepLinking: false,
showExtensions: false,
} }