Skip to content

Commit e5260c8

Browse files
CopilotJamesNK
andcommitted
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 <[email protected]>
1 parent b8611d9 commit e5260c8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/Security/Authorization/Core/src/DefaultAuthorizationService.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ public DefaultAuthorizationService(IAuthorizationPolicyProvider policyProvider,
5656
/// <param name="resource">The resource to evaluate the requirements against.</param>
5757
/// <param name="requirements">The requirements to evaluate.</param>
5858
/// <returns>
59-
/// A flag indicating whether authorization has succeeded.
60-
/// This value is <c>true</c> when the user fulfills the policy, otherwise <c>false</c>.
59+
/// A <see cref="Task{TResult}"/> that contains an <see cref="AuthorizationResult"/> indicating whether authorization has succeeded.
60+
/// The result's <see cref="AuthorizationResult.Succeeded"/> property is <c>true</c> when the user fulfills the policy; otherwise <c>false</c>.
6161
/// </returns>
6262
public virtual async Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal user, object? resource, IEnumerable<IAuthorizationRequirement> requirements)
6363
{
@@ -93,8 +93,8 @@ public virtual async Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal us
9393
/// <param name="resource">The resource the policy should be checked with.</param>
9494
/// <param name="policyName">The name of the policy to check against a specific context.</param>
9595
/// <returns>
96-
/// A flag indicating whether authorization has succeeded.
97-
/// This value is <c>true</c> when the user fulfills the policy otherwise <c>false</c>.
96+
/// A <see cref="Task{TResult}"/> that contains an <see cref="AuthorizationResult"/> indicating whether authorization has succeeded.
97+
/// The result's <see cref="AuthorizationResult.Succeeded"/> property is <c>true</c> when the user fulfills the policy; otherwise <c>false</c>.
9898
/// </returns>
9999
public virtual async Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal user, object? resource, string policyName)
100100
{

0 commit comments

Comments
 (0)