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

feat(swagger-ui-react): add support for persistAuthorization prop (#7842)

Browse Source 
Closes #7389
This commit is contained in:
kyori19
2022-03-01 18:54:03 +09:00
committed by GitHub
parent 8009035fa9
commit 67dd4f6a8d
2 changed files with 9 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

@@ -152,6 +152,12 @@ Configures the request snippet core plugin. See Swagger UI's [Display Configurat
⚠️ 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.
#### `persistAuthorization`: PropTypes.bool
If set, it persists authorization data and it would not be lost on browser close/refresh. 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.
## Limitations ## Limitations
* Not all configuration bindings are available. * Not all configuration bindings are available.

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

@@ -33,6 +33,7 @@ export default class SwaggerUI extends React.Component {
deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false, deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false,
showExtensions: this.props.showExtensions, showExtensions: this.props.showExtensions,
filter: ["boolean", "string"].includes(typeof this.props.filter) ? this.props.filter : false, filter: ["boolean", "string"].includes(typeof this.props.filter) ? this.props.filter : false,
persistAuthorization: this.props.persistAuthorization,
}) })
this.system = ui this.system = ui
@@ -122,6 +123,7 @@ SwaggerUI.propTypes = {
requestSnippets: PropTypes.object, requestSnippets: PropTypes.object,
tryItOutEnabled: PropTypes.bool, tryItOutEnabled: PropTypes.bool,
displayRequestDuration: PropTypes.bool, displayRequestDuration: PropTypes.bool,
persistAuthorization: PropTypes.bool,
} }
SwaggerUI.defaultProps = { SwaggerUI.defaultProps = {
@@ -155,4 +157,5 @@ SwaggerUI.defaultProps = {
defaultExpanded: true, defaultExpanded: true,
languages: null, // e.g. only show curl bash = ["curl_bash"] languages: null, // e.g. only show curl bash = ["curl_bash"]
}, },
persistAuthorization: false,
} }