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

feat: add support of defaultModelRendering prop to swagger-ui-react

Browse Source 
Co-authored-by: Tim Lai <timothy.lai@gmail.com>
This commit is contained in:
Alex Rejto
2022-01-12 14:31:55 -08:00
committed by GitHub
parent e6ea523e7c
commit 6273fd1dd8
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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. ⚠️ 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 #### `displayOperationId`: PropTypes.bool
Controls the display of operationId in operations list. The default is false. Controls the display of operationId in operations list. The default is false.

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

@@ -15,6 +15,7 @@ export default class SwaggerUI extends React.Component {
url: this.props.url, url: this.props.url,
layout: this.props.layout, layout: this.props.layout,
defaultModelsExpandDepth: this.props.defaultModelsExpandDepth, defaultModelsExpandDepth: this.props.defaultModelsExpandDepth,
defaultModelRendering: this.props.defaultModelRendering,
presets: [presets.apis,...this.props.presets], presets: [presets.apis,...this.props.presets],
requestInterceptor: this.requestInterceptor, requestInterceptor: this.requestInterceptor,
responseInterceptor: this.responseInterceptor, responseInterceptor: this.responseInterceptor,
@@ -106,6 +107,7 @@ SwaggerUI.propTypes = {
showMutatedRequest: PropTypes.bool, showMutatedRequest: PropTypes.bool,
defaultModelExpandDepth: PropTypes.number, defaultModelExpandDepth: PropTypes.number,
defaultModelsExpandDepth: PropTypes.number, defaultModelsExpandDepth: PropTypes.number,
defaultModelRendering: PropTypes.oneOf["example", "model"],
presets: PropTypes.arrayOf(PropTypes.func), presets: PropTypes.arrayOf(PropTypes.func),
deepLinking: PropTypes.bool, deepLinking: PropTypes.bool,
showExtensions: PropTypes.bool, showExtensions: PropTypes.bool,
@@ -124,6 +126,7 @@ SwaggerUI.defaultProps = {
queryConfigEnabled: false, queryConfigEnabled: false,
docExpansion: "list", docExpansion: "list",
defaultModelsExpandDepth: 1, defaultModelsExpandDepth: 1,
defaultModelRendering: "example",
presets: [], presets: [],
deepLinking: false, deepLinking: false,
showExtensions: false, showExtensions: false,