diff --git a/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs b/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
index 6adfa1738e..0939847439 100644
--- a/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
+++ b/src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
@@ -258,7 +258,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object by specifying a string.
+ /// Creates a object with by specifying a
+ /// string.
///
/// The content to write to the response.
/// The created object for the response.
@@ -269,8 +270,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object by specifying a string
- /// and a content type.
+ /// Creates a object with by specifying a
+ /// string and a content type.
///
/// The content to write to the response.
/// The content type (MIME type).
@@ -282,8 +283,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object by specifying a string,
- /// a , and .
+ /// Creates a object with by specifying a
+ /// string, a , and .
///
/// The content to write to the response.
/// The content type (MIME type).
@@ -302,8 +303,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object by specifying a
- /// string and a .
+ /// Creates a object with by specifying a
+ /// string and a .
///
/// The content to write to the response.
/// The content type (MIME type).
@@ -321,17 +322,18 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an empty No Content (204) response.
+ /// Creates a object that produces an empty
+ /// response.
///
/// The created object for the response.
[NonAction]
public virtual NoContentResult NoContent()
- {
+ {
return new NoContentResult();
}
///
- /// Creates a object that produces an empty OK (200) response.
+ /// Creates a object that produces an empty response.
///
/// The created for the response.
[NonAction]
@@ -341,7 +343,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an object that produces an OK (200) response.
+ /// Creates an object that produces an response.
///
/// The content value to format in the entity body.
/// The created for the response.
@@ -352,7 +354,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that redirects to the specified .
+ /// Creates a object that redirects ()
+ /// to the specified .
///
/// The URL to redirect to.
/// The created for the response.
@@ -369,7 +372,7 @@ namespace Microsoft.AspNetCore.Mvc
///
/// Creates a object with set to true
- /// using the specified .
+ /// () using the specified .
///
/// The URL to redirect to.
/// The created for the response.
@@ -385,8 +388,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that redirects to
- /// the specified local .
+ /// Creates a object that redirects
+ /// () to the specified local .
///
/// The local URL to redirect to.
/// The created for the response.
@@ -402,8 +405,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object with
- /// set to true using the specified .
+ /// Creates a object with set to
+ /// true () using the specified .
///
/// The local URL to redirect to.
/// The created for the response.
@@ -419,7 +422,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action using the .
+ /// Redirects () to the specified action using the .
///
/// The name of the action.
/// The created for the response.
@@ -430,8 +433,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action using the
- /// and .
+ /// Redirects () to the specified action using the
+ /// and .
///
/// The name of the action.
/// The parameters for a route.
@@ -443,8 +446,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action using the
- /// and the .
+ /// Redirects () to the specified action using the
+ /// and the .
///
/// The name of the action.
/// The name of the controller.
@@ -456,8 +459,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action using the specified ,
- /// , and .
+ /// Redirects () to the specified action using the specified
+ /// , , and .
///
/// The name of the action.
/// The name of the controller.
@@ -473,8 +476,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action using the specified ,
- /// , and .
+ /// Redirects () to the specified action using the specified
+ /// , , and .
///
/// The name of the action.
/// The name of the controller.
@@ -490,9 +493,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action using the specified ,
- /// , ,
- /// and .
+ /// Redirects () to the specified action using the specified ,
+ /// , , and .
///
/// The name of the action.
/// The name of the controller.
@@ -513,8 +515,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action with set to true
- /// using the specified .
+ /// Redirects () to the specified action with
+ /// set to true using the specified .
///
/// The name of the action.
/// The created for the response.
@@ -525,8 +527,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action with set to true
- /// using the specified and .
+ /// Redirects () to the specified action with
+ /// set to true using the specified
+ /// and .
///
/// The name of the action.
/// The parameters for a route.
@@ -538,8 +541,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action with set to true
- /// using the specified and .
+ /// Redirects () to the specified action with
+ /// set to true using the specified
+ /// and .
///
/// The name of the action.
/// The name of the controller.
@@ -551,8 +555,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action with set to true
- /// using the specified ,
+ /// Redirects () to the specified action with
+ /// set to true using the specified ,
/// , and .
///
/// The name of the action.
@@ -569,9 +573,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action with set to true
- /// using the specified , ,
- /// and .
+ /// Redirects () to the specified action with
+ /// set to true using the specified ,
+ /// , and .
///
/// The name of the action.
/// The name of the controller.
@@ -587,9 +591,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified action with set to true
- /// using the specified , ,
- /// , and .
+ /// Redirects () to the specified action with
+ /// set to true using the specified ,
+ /// , , and .
///
/// The name of the action.
/// The name of the controller.
@@ -615,7 +619,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route using the specified .
+ /// Redirects () to the specified route using the specified .
///
/// The name of the route.
/// The created for the response.
@@ -626,7 +630,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route using the specified .
+ /// Redirects () to the specified route using the specified .
///
/// The parameters for a route.
/// The created for the response.
@@ -637,8 +641,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route using the specified
- /// and .
+ /// Redirects () to the specified route using the specified
+ /// and .
///
/// The name of the route.
/// The parameters for a route.
@@ -650,8 +654,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route using the specified
- /// and .
+ /// Redirects () to the specified route using the specified
+ /// and .
///
/// The name of the route.
/// The fragment to add to the URL.
@@ -663,8 +667,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route using the specified ,
- /// , and .
+ /// Redirects () to the specified route using the specified
+ /// , , and .
///
/// The name of the route.
/// The parameters for a route.
@@ -683,8 +687,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route with set to true
- /// using the specified .
+ /// Redirects () to the specified route with
+ /// set to true using the specified .
///
/// The name of the route.
/// The created for the response.
@@ -695,8 +699,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route with set to true
- /// using the specified .
+ /// Redirects () to the specified route with
+ /// set to true using the specified .
///
/// The parameters for a route.
/// The created for the response.
@@ -707,8 +711,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route with set to true
- /// using the specified and .
+ /// Redirects () to the specified route with
+ /// set to true using the specified
+ /// and .
///
/// The name of the route.
/// The parameters for a route.
@@ -720,8 +725,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route with set to true
- /// using the specified and .
+ /// Redirects () to the specified route with
+ /// set to true using the specified
+ /// and .
///
/// The name of the route.
/// The fragment to add to the URL.
@@ -733,9 +739,9 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Redirects to the specified route with set to true
- /// using the specified , ,
- /// and .
+ /// Redirects () to the specified route with
+ /// set to true using the specified ,
+ /// , and .
///
/// The name of the route.
/// The parameters for a route.
@@ -754,8 +760,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns a file with the specified as content and the
- /// specified as the Content-Type.
+ /// Returns a file with the specified as content
+ /// () and the specified as the Content-Type.
///
/// The file contents.
/// The Content-Type of the file.
@@ -767,7 +773,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns a file with the specified as content, the
+ /// Returns a file with the specified as content (), the
/// specified as the Content-Type and the
/// specified as the suggested file name.
///
@@ -782,8 +788,8 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns a file in the specified with the
- /// specified as the Content-Type.
+ /// Returns a file in the specified ()
+ /// with the specified as the Content-Type.
///
/// The with the contents of the file.
/// The Content-Type of the file.
@@ -795,7 +801,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns a file in the specified with the
+ /// Returns a file in the specified () with the
/// specified as the Content-Type and the
/// specified as the suggested file name.
///
@@ -810,7 +816,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns the file specified by with the
+ /// Returns the file specified by () with the
/// specified as the Content-Type.
///
/// The virtual path of the file to be returned.
@@ -823,7 +829,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns the file specified by with the
+ /// Returns the file specified by () with the
/// specified as the Content-Type and the
/// specified as the suggested file name.
///
@@ -838,7 +844,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns the file specified by with the
+ /// Returns the file specified by () with the
/// specified as the Content-Type.
///
/// The physical path of the file to be returned.
@@ -851,7 +857,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Returns the file specified by with the
+ /// Returns the file specified by () with the
/// specified as the Content-Type and the
/// specified as the suggested file name.
///
@@ -869,7 +875,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an that produces an Unauthorized (401) response.
+ /// Creates an that produces an response.
///
/// The created for the response.
[NonAction]
@@ -879,7 +885,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an that produces a Not Found (404) response.
+ /// Creates an that produces a response.
///
/// The created for the response.
[NonAction]
@@ -889,7 +895,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an that produces a Not Found (404) response.
+ /// Creates an that produces a response.
///
/// The created for the response.
[NonAction]
@@ -899,7 +905,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an that produces a Bad Request (400) response.
+ /// Creates an that produces a response.
///
/// The created for the response.
[NonAction]
@@ -909,7 +915,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an that produces a Bad Request (400) response.
+ /// Creates an that produces a response.
///
/// The created for the response.
[NonAction]
@@ -919,7 +925,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates an that produces a Bad Request (400) response.
+ /// Creates an that produces a response.
///
/// The created for the response.
[NonAction]
@@ -934,7 +940,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The URI at which the content has been created.
/// The content value to format in the entity body.
@@ -951,7 +957,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The URI at which the content has been created.
/// The content value to format in the entity body.
@@ -968,7 +974,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The name of the action to use for generating the URL.
/// The content value to format in the entity body.
@@ -980,7 +986,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The name of the action to use for generating the URL.
/// The route data to use for generating the URL.
@@ -993,7 +999,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The name of the action to use for generating the URL.
/// The name of the controller to use for generating the URL.
@@ -1011,7 +1017,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The name of the route to use for generating the URL.
/// The content value to format in the entity body.
@@ -1023,7 +1029,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The route data to use for generating the URL.
/// The content value to format in the entity body.
@@ -1035,7 +1041,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces a Created (201) response.
+ /// Creates a object that produces a response.
///
/// The name of the route to use for generating the URL.
/// The route data to use for generating the URL.
@@ -1048,7 +1054,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The created for the response.
[NonAction]
@@ -1058,7 +1064,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The optional content value to format in the entity body; may be null.
/// The created for the response.
@@ -1069,7 +1075,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The optional URI with the location at which the status of requested content can be monitored.
/// May be null.
@@ -1086,7 +1092,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The optional URI with the location at which the status of requested content can be monitored.
/// May be null.
@@ -1098,7 +1104,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The URI with the location at which the status of requested content can be monitored.
/// The optional content value to format in the entity body; may be null.
@@ -1110,7 +1116,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The URI with the location at which the status of requested content can be monitored.
/// The optional content value to format in the entity body; may be null.
@@ -1127,7 +1133,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the action to use for generating the URL.
/// The created for the response.
@@ -1138,7 +1144,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the action to use for generating the URL.
/// The name of the controller to use for generating the URL.
@@ -1150,7 +1156,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the action to use for generating the URL.
/// The optional content value to format in the entity body; may be null.
@@ -1162,7 +1168,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the action to use for generating the URL.
/// The name of the controller to use for generating the URL.
@@ -1175,7 +1181,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the action to use for generating the URL.
/// The route data to use for generating the URL.
@@ -1188,7 +1194,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the action to use for generating the URL.
/// The name of the controller to use for generating the URL.
@@ -1206,7 +1212,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The route data to use for generating the URL.
/// The created for the response.
@@ -1217,7 +1223,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the route to use for generating the URL.
/// The created for the response.
@@ -1228,7 +1234,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the route to use for generating the URL.
///The route data to use for generating the URL.
@@ -1240,7 +1246,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The route data to use for generating the URL.
/// The optional content value to format in the entity body; may be null.
@@ -1252,7 +1258,7 @@ namespace Microsoft.AspNetCore.Mvc
}
///
- /// Creates a object that produces an Accepted (202) response.
+ /// Creates a object that produces an response.
///
/// The name of the route to use for generating the URL.
/// The route data to use for generating the URL.
@@ -1268,6 +1274,11 @@ namespace Microsoft.AspNetCore.Mvc
/// Creates a .
///
/// The created for the response.
+ ///
+ /// The behavior of this method depends on the in use.
+ /// and
+ /// are among likely status results.
+ ///
[NonAction]
public virtual ChallengeResult Challenge()
=> new ChallengeResult();
@@ -1277,6 +1288,11 @@ namespace Microsoft.AspNetCore.Mvc
///
/// The authentication schemes to challenge.
/// The created for the response.
+ ///
+ /// The behavior of this method depends on the in use.
+ /// and
+ /// are among likely status results.
+ ///
[NonAction]
public virtual ChallengeResult Challenge(params string[] authenticationSchemes)
=> new ChallengeResult(authenticationSchemes);
@@ -1287,6 +1303,11 @@ namespace Microsoft.AspNetCore.Mvc
/// used to perform the authentication
/// challenge.
/// The created for the response.
+ ///
+ /// The behavior of this method depends on the in use.
+ /// and
+ /// are among likely status results.
+ ///
[NonAction]
public virtual ChallengeResult Challenge(AuthenticationProperties properties)
=> new ChallengeResult(properties);
@@ -1299,6 +1320,11 @@ namespace Microsoft.AspNetCore.Mvc
/// challenge.
/// The authentication schemes to challenge.
/// The created for the response.
+ ///
+ /// The behavior of this method depends on the in use.
+ /// and
+ /// are among likely status results.
+ ///
[NonAction]
public virtual ChallengeResult Challenge(
AuthenticationProperties properties,
@@ -1306,40 +1332,58 @@ namespace Microsoft.AspNetCore.Mvc
=> new ChallengeResult(authenticationSchemes, properties);
///
- /// Creates a .
+ /// Creates a ( by default).
///
/// The created for the response.
+ ///
+ /// Some authentication schemes, such as cookies, will convert to
+ /// a redirect to show a login page.
+ ///
[NonAction]
public virtual ForbidResult Forbid()
=> new ForbidResult();
///
- /// Creates a with the specified authentication schemes.
+ /// Creates a ( by default) with the
+ /// specified authentication schemes.
///
/// The authentication schemes to challenge.
/// The created for the response.
+ ///
+ /// Some authentication schemes, such as cookies, will convert to
+ /// a redirect to show a login page.
+ ///
[NonAction]
public virtual ForbidResult Forbid(params string[] authenticationSchemes)
=> new ForbidResult(authenticationSchemes);
///
- /// Creates a with the specified .
+ /// Creates a ( by default) with the
+ /// specified .
///
/// used to perform the authentication
/// challenge.
/// The created for the response.
+ ///
+ /// Some authentication schemes, such as cookies, will convert to
+ /// a redirect to show a login page.
+ ///
[NonAction]
public virtual ForbidResult Forbid(AuthenticationProperties properties)
=> new ForbidResult(properties);
///
- /// Creates a with the specified specified authentication schemes and
- /// .
+ /// Creates a ( by default) with the
+ /// specified specified authentication schemes and .
///
/// used to perform the authentication
/// challenge.
/// The authentication schemes to challenge.
/// The created for the response.
+ ///
+ /// Some authentication schemes, such as cookies, will convert to
+ /// a redirect to show a login page.
+ ///
[NonAction]
public virtual ForbidResult Forbid(AuthenticationProperties properties, params string[] authenticationSchemes)
=> new ForbidResult(authenticationSchemes, properties);