Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve API description for SharedTokenCacheCredential #30687

Closed
scottaddie opened this issue Aug 23, 2022 · 0 comments · Fixed by #32195
Closed

Improve API description for SharedTokenCacheCredential #30687

scottaddie opened this issue Aug 23, 2022 · 0 comments · Fixed by #32195
Assignees
@schaabs
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. Docs
Milestone
2022-11

Comments

@scottaddie
Copy link
Member

scottaddie commented Aug 23, 2022 •
edited
Loading

Library name

Azure.Identity

Please describe the feature.

The SharedTokenCacheCredential class' XML docs do a poor job of explaining its purpose:

azure-sdk-for-net/sdk/identity/Azure.Identity/src/Credentials/SharedTokenCacheCredential.cs

Lines 17 to 19 in f38a2ef

/// <summary>
/// Authenticates using tokens in the local cache shared between Microsoft applications.
/// </summary>

What's meant by "between Microsoft applications"? When is it appropriate to use this credential type? Let's clean this up, so that customers reading the API ref page better understand its purpose. Kudos to @sadukie for the feedback!

Additionally, add a row for SharedTokenCacheCredential to the table at https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md#authenticating-via-development-tools.
@scottaddie scottaddie added Client This issue points to a problem in the data-plane of the library. Azure.Identity Docs labels Aug 23, 2022
@joshfree joshfree added this to the 2022-10 milestone Sep 26, 2022
@joshfree joshfree moved this from Planned to Untriaged in Azure Identity SDK Improvements Sep 26, 2022
@schaabs schaabs modified the milestones: 2022-10, 2022-11 Oct 13, 2022
@scottaddie scottaddie mentioned this issue Oct 31, 2022
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Mar 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@schaabs schaabs

Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. Docs
Projects
Azure Identity SDK Improvements
Archived in project
Milestone
2022-11
Development

Successfully merging a pull request may close this issue.

Update SharedTokenCacheCredential XML class documentation schaabs/azure-sdk-for-net
3 participants
@joshfree @scottaddie @schaabs