Change an optional scopes parameter to be required #64
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous default None value would cause an exception in our code decorate_scope(). The fix is to change the previously optional scopes parameter to required. This kind of api surface change would usually be a breaking change, but in this case it is not, because the previous default value would cause exception so it was in fact required. FWIW, you can still explicitly use empty list [] as scope, and the response would contain id_token and refresh_token, but no access_token.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Discovered in PR #61 's second finding (thank you Jann!), the previous default None value in
acquire_token_by_username_password(..., scopes=None)would cause an exception in our internal helperdecorate_scope().The fix is to change the previously optional scopes parameter to required.
This kind of api surface change would usually be a breaking change, but in this case it is not,
because the previous default value would cause exception so it was in fact required.
FWIW, you can still explicitly use empty list
[]as scope,and the response would contain id_token and refresh_token, but no access_token.