Bläddra i källkod

feat(swagger-ui-react): option for showMutatedRequest (#6273)

Co-authored-by: neel <neelima.sri.vathsavai@autodesk.com>
bubble
Tim Lai 4 år sedan
committed by GitHub
förälder
incheckning
b99ebe7dd3
Ingen känd nyckel hittad för denna signaturen i databasen GPG-nyckel ID: 4AEE18F83AFDEB23
2 ändrade filer med 9 tillägg och 1 borttagningar
  1. +6
    -0
      flavors/swagger-ui-react/README.md
  2. +3
    -1
      flavors/swagger-ui-react/index.js

+ 6
- 0
flavors/swagger-ui-react/README.md Visa fil

@@ -95,6 +95,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.

#### `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.

⚠️ 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.

## Limitations

* Not all configuration bindings are available.


+ 3
- 1
flavors/swagger-ui-react/index.js Visa fil

@@ -21,6 +21,7 @@ export default class SwaggerUI extends React.Component {
supportedSubmitMethods: this.props.supportedSubmitMethods,
defaultModelExpandDepth: this.props.defaultModelExpandDepth,
displayOperationId: this.props.displayOperationId,
showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true,
})

this.system = ui
@@ -88,10 +89,11 @@ SwaggerUI.propTypes = {
docExpansion: PropTypes.oneOf(['list', 'full', 'none']),
supportedSubmitMethods: PropTypes.arrayOf(
PropTypes.oneOf(['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'])
),
),
defaultModelExpandDepth: PropTypes.number,
plugins: PropTypes.arrayOf(PropTypes.object),
displayOperationId: PropTypes.bool,
showMutatedRequest: PropTypes.bool,
}

SwaggerUI.defaultProps = {


Laddar…
Avbryt
Spara