From d7ec726886a7e436585e0bd9432970e596a7fac4 Mon Sep 17 00:00:00 2001 From: glebbash Date: Mon, 8 Nov 2021 10:37:28 +0200 Subject: [PATCH] feat(swagger-ui-react): add showExtensions option (#7563) Closes #5892 --- flavors/swagger-ui-react/README.md | 6 ++++++ flavors/swagger-ui-react/index.jsx | 2 ++ 2 files changed, 8 insertions(+) diff --git a/flavors/swagger-ui-react/README.md b/flavors/swagger-ui-react/README.md index a3df264b4ee..e2c33dd2d80 100644 --- a/flavors/swagger-ui-react/README.md +++ b/flavors/swagger-ui-react/README.md @@ -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. +#### `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 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. diff --git a/flavors/swagger-ui-react/index.jsx b/flavors/swagger-ui-react/index.jsx index 10bb7f396a3..6fff43393c8 100644 --- a/flavors/swagger-ui-react/index.jsx +++ b/flavors/swagger-ui-react/index.jsx @@ -24,6 +24,7 @@ export default class SwaggerUI extends React.Component { defaultModelExpandDepth: this.props.defaultModelExpandDepth, displayOperationId: this.props.displayOperationId, tryItOutEnabled: this.props.tryItOutEnabled, + showExtensions: this.props.showExtensions, showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true, deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false, }) @@ -112,4 +113,5 @@ SwaggerUI.defaultProps = { defaultModelsExpandDepth: 1, presets: [], deepLinking: false, + showExtensions: false, }