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

feat(swagger-ui-react): add displayOperationId config support (#5795)

Browse Source
This commit is contained in:
Jordan Garside
2020-06-12 14:28:42 -07:00
committed by GitHub
parent ae33deeaab
commit bd1b297b56
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

@@ -77,6 +77,12 @@ 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.
#### `displayOperationId`: PropTypes.bool
Controls the display of operationId in operations list. The default is false.
⚠️ 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.
#### `plugins`: PropTypes.arrayOf(PropTypes.object), #### `plugins`: PropTypes.arrayOf(PropTypes.object),
An array of objects that augment and modify Swagger UI's functionality. See Swagger UI's [Plugin API](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plugin-api.md) for more details. An array of objects that augment and modify Swagger UI's functionality. See Swagger UI's [Plugin API](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plugin-api.md) for more details.

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

@@ -20,6 +20,7 @@ export default class SwaggerUI extends React.Component {
docExpansion: this.props.docExpansion, docExpansion: this.props.docExpansion,
supportedSubmitMethods: this.props.supportedSubmitMethods, supportedSubmitMethods: this.props.supportedSubmitMethods,
defaultModelExpandDepth: this.props.defaultModelExpandDepth, defaultModelExpandDepth: this.props.defaultModelExpandDepth,
displayOperationId: this.props.displayOperationId,
}) })
this.system = ui this.system = ui
@@ -90,6 +91,7 @@ SwaggerUI.propTypes = {
), ),
defaultModelExpandDepth: PropTypes.number, defaultModelExpandDepth: PropTypes.number,
plugins: PropTypes.arrayOf(PropTypes.object), plugins: PropTypes.arrayOf(PropTypes.object),
displayOperationId: PropTypes.bool,
} }
SwaggerUI.defaultProps = { SwaggerUI.defaultProps = {