Skip to content

Commit

Permalink
feat(swagger-ui-react): add showExtensions option (#7563)
Browse files Browse the repository at this point in the history
Closes #5892
  • Loading branch information
glebbash committed Nov 8, 2021
1 parent 83021df commit d7ec726
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions flavors/swagger-ui-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions flavors/swagger-ui-react/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -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,
})
Expand Down Expand Up @@ -112,4 +113,5 @@ SwaggerUI.defaultProps = {
defaultModelsExpandDepth: 1,
presets: [],
deepLinking: false,
showExtensions: false,
}

0 comments on commit d7ec726

Please sign in to comment.