From 57b18dd73ede7d2d7872b6e56fa76dd08baf3fde Mon Sep 17 00:00:00 2001
From: Ryan Brandenburg <rybrande@microsoft.com>
Date: Fri, 3 Mar 2017 15:24:11 -0800
Subject: [PATCH] Note possible StatusCodes of Challenge

---
 .../ControllerBase.cs                            | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs b/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
index d12c8bf64e..536960a142 100644
--- a/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
+++ b/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
@@ -1270,6 +1270,10 @@ public virtual AcceptedAtRouteResult AcceptedAtRoute(string routeName, object ro
         /// Creates a <see cref="ChallengeResult"/>.
         /// </summary>
         /// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
+        /// <remarks>
+        /// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
+        /// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
+        /// </remarks>
         [NonAction]
         public virtual ChallengeResult Challenge()
             => new ChallengeResult();
@@ -1279,6 +1283,10 @@ public virtual ChallengeResult Challenge()
         /// </summary>
         /// <param name="authenticationSchemes">The authentication schemes to challenge.</param>
         /// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
+        /// <remarks>
+        /// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
+        /// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
+        /// </remarks>
         [NonAction]
         public virtual ChallengeResult Challenge(params string[] authenticationSchemes)
             => new ChallengeResult(authenticationSchemes);
@@ -1289,6 +1297,10 @@ public virtual ChallengeResult Challenge(params string[] authenticationSchemes)
         /// <param name="properties"><see cref="AuthenticationProperties"/> used to perform the authentication
         /// challenge.</param>
         /// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
+        /// <remarks>
+        /// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
+        /// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
+        /// </remarks>
         [NonAction]
         public virtual ChallengeResult Challenge(AuthenticationProperties properties)
             => new ChallengeResult(properties);
@@ -1301,6 +1313,10 @@ public virtual ChallengeResult Challenge(AuthenticationProperties properties)
         /// challenge.</param>
         /// <param name="authenticationSchemes">The authentication schemes to challenge.</param>
         /// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
+        /// <remarks>
+        /// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
+        /// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
+        /// </remarks>
         [NonAction]
         public virtual ChallengeResult Challenge(
             AuthenticationProperties properties,