improvement: oauth "scopes" improvements #6037
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a "scopes" option to the "ui.initOAuth" function.
This option can be an array of strings or a string separated by the "scopeSeparator" option (or space by default).
If specified, the Authorize pop-up will have the given set of scopes automatically selected.
Additionally, this PR also adds a "select all" and "select none" link to cause all/no scopes to be selected. See screenshot.
Motivation and Context
When using Swagger UI's OAuth functionality with an API that has multiple scopes, it can be extremely tedious to select all (or a specific set).
Fixes #2531
How Has This Been Tested?
I have updated the Selenium e2e configuration for initOAuth to specify the "scopes" option as "read:pets openid profile".
I then updated the "schemeContainer render click event" test (and main.js schemeContainer) to test the presence of the "read:pets" checkbox as being checked and the "write:pets" checkbox as being unchecked. I then click the select all and select none links and verify the scopes are properly selected.
Screenshots:
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests