Skip to content

Add docs for Negotiate, OAuth, OpenIdConnect #26610

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
Merged
merged 4 commits into from
Oct 6, 2020
Merged

Add docs for Negotiate, OAuth, OpenIdConnect #26610

merged 4 commits into from
Oct 6, 2020

Conversation

pranavkm
Copy link
Contributor

@pranavkm pranavkm commented Oct 5, 2020

Contributes to #26397

@pranavkm pranavkm requested a review from Tratcher as a code owner October 5, 2020 17:20
@ghost ghost added the area-auth Includes: Authn, Authz, OAuth, OIDC, Bearer label Oct 5, 2020
@pranavkm pranavkm requested a review from HaoK October 5, 2020 17:20
@pranavkm pranavkm added the tell-mode Indicates a PR which is being merged during tell-mode label Oct 5, 2020
HaoK
HaoK reviewed Oct 5, 2020
View reviewed changes
src/Security/Authentication/Negotiate/src/Events/AuthenticatedContext.cs
/// <param name="context"></param>
/// <param name="scheme"></param>
/// <param name="options"></param>
/// <inheritdoc />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know you could inherit doc like this? So what exactly is the result of mixing summary an inheritdoc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It picks the docs from the base type for the values that weren't supplied - in this case, the docs for the parameters.

@pranavkm pranavkm added this to the 5.0.0 milestone Oct 5, 2020
@pranavkm
Copy link
Contributor Author

pranavkm commented Oct 5, 2020

@Tratcher could you look when you get a chance?

Tratcher
Tratcher requested changes Oct 5, 2020
View reviewed changes
src/Security/Authentication/OAuth/src/MapAllClaimsAction.cs
@@ -13,10 +13,14 @@ namespace Microsoft.AspNetCore.Authentication.OAuth.Claims
/// </summary>
public class MapAllClaimsAction : ClaimAction
{
/// <summary>
/// Initializes a new instance of <see cref="MapAllClaimsAction"/>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you use See when referring to the current type?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes it hyperlink back to the type in the docs. Also makes it so that the doc can be refactored if the type is renamed

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're not suppose to rename types Pranav 😁

src/Security/Authentication/OpenIdConnect/src/OpenIdConnectHandler.cs
protected HttpClient Backchannel => Options.Backchannel;

/// <summary>
/// Gets the <see cref="System.Text.Encodings.Web.HtmlEncoder"/>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Namespace?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It resolves to the property otherwise. We want to the point to the type. Btw, the property is unused from what I could tell.

pranavkm
pranavkm commented Oct 5, 2020
View reviewed changes
src/Security/Authentication/OAuth/src/MapAllClaimsAction.cs
@@ -13,10 +13,14 @@ namespace Microsoft.AspNetCore.Authentication.OAuth.Claims
/// </summary>
public class MapAllClaimsAction : ClaimAction
{
/// <summary>
/// Initializes a new instance of <see cref="MapAllClaimsAction"/>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes it hyperlink back to the type in the docs. Also makes it so that the doc can be refactored if the type is renamed

src/Security/Authentication/OpenIdConnect/src/OpenIdConnectHandler.cs
protected HttpClient Backchannel => Options.Backchannel;

/// <summary>
/// Gets the <see cref="System.Text.Encodings.Web.HtmlEncoder"/>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It resolves to the property otherwise. We want to the point to the type. Btw, the property is unused from what I could tell.

@pranavkm pranavkm merged commit 8b741bd into release/5.0 Oct 6, 2020
@pranavkm pranavkm deleted the prkrishn/security-docs2 branch October 6, 2020 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Tratcher Tratcher Tratcher approved these changes

@HaoK HaoK HaoK approved these changes

Assignees
No one assigned
Labels
area-auth Includes: Authn, Authz, OAuth, OIDC, Bearer tell-mode Indicates a PR which is being merged during tell-mode
Projects
None yet
Milestone
5.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@pranavkm @Tratcher @HaoK