feat: add support of defaultModelRendering prop to swagger-ui-react
Co-authored-by: Tim Lai <timothy.lai@gmail.com>
This commit is contained in:
@@ -83,6 +83,13 @@ 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.
|
||||
|
||||
#### `defaultModelRendering`: PropTypes.oneOf(["example", "model"])
|
||||
|
||||
Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.) The default value is 'example'.
|
||||
|
||||
⚠️ 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.
|
||||
|
||||
|
||||
#### `displayOperationId`: PropTypes.bool
|
||||
|
||||
Controls the display of operationId in operations list. The default is false.
|
||||
|
||||
@@ -15,6 +15,7 @@ export default class SwaggerUI extends React.Component {
|
||||
url: this.props.url,
|
||||
layout: this.props.layout,
|
||||
defaultModelsExpandDepth: this.props.defaultModelsExpandDepth,
|
||||
defaultModelRendering: this.props.defaultModelRendering,
|
||||
presets: [presets.apis,...this.props.presets],
|
||||
requestInterceptor: this.requestInterceptor,
|
||||
responseInterceptor: this.responseInterceptor,
|
||||
@@ -106,6 +107,7 @@ SwaggerUI.propTypes = {
|
||||
showMutatedRequest: PropTypes.bool,
|
||||
defaultModelExpandDepth: PropTypes.number,
|
||||
defaultModelsExpandDepth: PropTypes.number,
|
||||
defaultModelRendering: PropTypes.oneOf["example", "model"],
|
||||
presets: PropTypes.arrayOf(PropTypes.func),
|
||||
deepLinking: PropTypes.bool,
|
||||
showExtensions: PropTypes.bool,
|
||||
@@ -124,6 +126,7 @@ SwaggerUI.defaultProps = {
|
||||
queryConfigEnabled: false,
|
||||
docExpansion: "list",
|
||||
defaultModelsExpandDepth: 1,
|
||||
defaultModelRendering: "example",
|
||||
presets: [],
|
||||
deepLinking: false,
|
||||
showExtensions: false,
|
||||
|
||||
Reference in New Issue
Block a user