Clarify that allow_broker is not applicable to ConfidentialClientApplication #559
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
…ication It is applicable to PublicClientApplication and base class ClientApplication
jiasli
reviewed
May 18, 2023
| @@ -444,6 +444,8 @@ def __init__( | |||
| New in version 1.19.0. | |||
|
|
|||
| :param boolean allow_broker: | |||
| This parameter is NOT applicable to :class:`ConfidentialClientApplication`. | |||
There was a problem hiding this comment.
Maybe a positive statement?
This parameter is ONLY applicable to
PublicClientApplication.
There was a problem hiding this comment.
I believe the emphasis of this PR and its corresponding issue were to call out the only invalid situation among the three. So, taking your suggestion into account, we can change it to:
This parameter is applicable to
PublicClientApplicationand its base classClientApplication, but NOT applicable toConfidentialClientApplication.
How about that?
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.
Although MSAL provides two top-level classes: PublicClientApplication and ConfidentialClientApplication, there is another less-popular but still-doable pattern which is to use the base class ClientApplication directly. So, that
allow_brokeris applicable to both PublicClientApplication and the base class ClientApplication. So, that dynamic check in base class is necessary.The ConfidentialClientApplication inherits the
__init__()and its documentation from base class. Now, we choose to add a sentence in that documentation to clarify that the parameter is not applicable to ConfidentialClientApplication.See it in action in the staged documentation.
This resolves #544.