Skip to content

Fix XML comments for return values on IAuthorizationService #62765

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

Merged
merged 4 commits into from
Jul 24, 2025
+16 −17
Merged

Fix XML comments for return values on IAuthorizationService #62765

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff63c75
Initial plan
Copilot Jul 17, 2025
b8611d9
Fix XML comments for IAuthorizationService return values
Copilot Jul 17, 2025
e5260c8
Update XML comments for DefaultAuthorizationService return values
Copilot Jul 17, 2025
18ea479
Apply suggestions from code review
JamesNK Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update XML comments for DefaultAuthorizationService return values 
Updated XML documentation for DefaultAuthorizationService methods to correctly describe return values as Task<AuthorizationResult> instead of boolean flags, matching the pattern used for IAuthorizationService interface.

Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
  • Loading branch information
@Copilot @JamesNK
Copilot and JamesNK committed Jul 17, 2025
commit e5260c8c5b7c49196988385b2e95da5a48a09161
8 changes: 4 additions & 4 deletions src/Security/Authorization/Core/src/DefaultAuthorizationService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ public DefaultAuthorizationService(IAuthorizationPolicyProvider policyProvider,
/// <param name="resource">The resource to evaluate the requirements against.</param>
/// <param name="requirements">The requirements to evaluate.</param>
/// <returns>
/// A flag indicating whether authorization has succeeded.
/// This value is <c>true</c> when the user fulfills the policy, otherwise <c>false</c>.
/// A <see cref="Task{TResult}"/> that contains an <see cref="AuthorizationResult"/> indicating whether authorization has succeeded.
/// The result's <see cref="AuthorizationResult.Succeeded"/> property is <c>true</c> when the user fulfills the policy; otherwise <c>false</c>.
/// </returns>
public virtual async Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal user, object? resource, IEnumerable<IAuthorizationRequirement> requirements)
{
Expand Down Expand Up @@ -93,8 +93,8 @@ public virtual async Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal us
/// <param name="resource">The resource the policy should be checked with.</param>
/// <param name="policyName">The name of the policy to check against a specific context.</param>
/// <returns>
/// A flag indicating whether authorization has succeeded.
/// This value is <c>true</c> when the user fulfills the policy otherwise <c>false</c>.
/// A <see cref="Task{TResult}"/> that contains an <see cref="AuthorizationResult"/> indicating whether authorization has succeeded.
/// The result's <see cref="AuthorizationResult.Succeeded"/> property is <c>true</c> when the user fulfills the policy; otherwise <c>false</c>.
/// </returns>
public virtual async Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal user, object? resource, string policyName)
{
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy