Replace hard-coded status codes with fields (dotnet#15426)

* Replace hard-coded status codes with fields * more work
shampeter · Oct 31, 2019 · 0ed167e · 0ed167e
1 parent 7433eb2
commit 0ed167e
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 22 deletions.
diff --git a/aspnetcore/tutorials/getting-started-with-NSwag.md b/aspnetcore/tutorials/getting-started-with-NSwag.md
@@ -259,7 +259,7 @@ The preceding action returns `IActionResult`, but inside the action it's returni
 
 ::: moniker range=">= aspnetcore-2.1"
 
- Because NSwag uses [Reflection](/dotnet/csharp/programming-guide/concepts/reflection), and the recommended return type for web API actions is [ActionResult\<T>](xref:Microsoft.AspNetCore.Mvc.ActionResult%601), it can only infer the return type defined by `T`. You can't automatically infer other possible return types.
+Because NSwag uses [Reflection](/dotnet/csharp/programming-guide/concepts/reflection), and the recommended return type for web API actions is [ActionResult\<T>](xref:Microsoft.AspNetCore.Mvc.ActionResult%601), it can only infer the return type defined by `T`. You can't automatically infer other possible return types.
 
 Consider the following example:
 

diff --git a/.../web-api-help-pages-using-swagger/samples/2.0/TodoApi.NSwag/Controllers/TodoController.cs b/.../web-api-help-pages-using-swagger/samples/2.0/TodoApi.NSwag/Controllers/TodoController.cs
@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 using System.Collections.Generic;
 using System.Linq;
 using TodoApi.Models;
@@ -69,8 +70,8 @@ public IActionResult GetById(long id)
         /// <response code="201">Returns the newly created item</response>
         /// <response code="400">If the item is null</response>
         #region snippet_CreateActionAttributes
-        [ProducesResponseType(typeof(TodoItem), 201)]   // Created
-        [ProducesResponseType(400)]                     // BadRequest
+        [ProducesResponseType(typeof(TodoItem), StatusCodes.Status201Created)]  // Created
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]                 // BadRequest
         #endregion snippet_CreateActionAttributes
         #region snippet_CreateAction
         [HttpPost]

diff --git a/...pi-help-pages-using-swagger/samples/2.0/TodoApi.Swashbuckle/Controllers/TodoController.cs b/...pi-help-pages-using-swagger/samples/2.0/TodoApi.Swashbuckle/Controllers/TodoController.cs
@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 using System.Collections.Generic;
 using System.Linq;
 using TodoApi.Models;
@@ -69,8 +70,8 @@ public IActionResult GetById(long id)
         /// <response code="201">Returns the newly created item</response>
         /// <response code="400">If the item is null</response>            
         [HttpPost]
-        [ProducesResponseType(typeof(TodoItem), 201)]
-        [ProducesResponseType(400)]
+        [ProducesResponseType(typeof(TodoItem), StatusCodes.Status201Created)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public IActionResult Create([FromBody] TodoItem item)
         {
             if (item == null)

diff --git a/.../web-api-help-pages-using-swagger/samples/2.1/TodoApi.NSwag/Controllers/TodoController.cs b/.../web-api-help-pages-using-swagger/samples/2.1/TodoApi.NSwag/Controllers/TodoController.cs
@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 using System.Collections.Generic;
 using System.Linq;
 using TodoApi.Models;
@@ -68,8 +69,8 @@ public ActionResult<TodoItem> GetById(long id)
         /// <response code="201">Returns the newly created item</response>
         /// <response code="400">If the item is null</response>
         #region snippet_CreateActionAttributes
-        [ProducesResponseType(201)]     // Created
-        [ProducesResponseType(400)]     // BadRequest
+        [ProducesResponseType(StatusCodes.Status201Created)]     // Created
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]  // BadRequest
         #endregion snippet_CreateActionAttributes
         #region snippet_CreateAction
         [HttpPost]

diff --git a/...pi-help-pages-using-swagger/samples/2.1/TodoApi.Swashbuckle/Controllers/TodoController.cs b/...pi-help-pages-using-swagger/samples/2.1/TodoApi.Swashbuckle/Controllers/TodoController.cs
@@ -1,11 +1,12 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 using System.Collections.Generic;
 using System.Linq;
 using TodoApi.Models;
 
 namespace TodoApi.Controllers
 {
-#region snippet_TodoController
+    #region snippet_TodoController
     [Produces("application/json")]
     [Route("api/[controller]")]
     [ApiController]
@@ -68,8 +69,8 @@ public ActionResult<TodoItem> GetById(long id)
         /// <response code="201">Returns the newly created item</response>
         /// <response code="400">If the item is null</response>            
         [HttpPost]
-        [ProducesResponseType(201)]
-        [ProducesResponseType(400)]
+        [ProducesResponseType(StatusCodes.Status201Created)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public ActionResult<TodoItem> Create(TodoItem item)
         {
             _context.TodoItems.Add(item);

diff --git a/...pi-help-pages-using-swagger/samples/3.0/TodoApi.Swashbuckle/Controllers/TodoController.cs b/...pi-help-pages-using-swagger/samples/3.0/TodoApi.Swashbuckle/Controllers/TodoController.cs
@@ -1,11 +1,12 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 using System.Collections.Generic;
 using System.Linq;
 using TodoApi.Models;
 
 namespace TodoApi.Controllers
 {
-#region snippet_TodoController
+    #region snippet_TodoController
     [Produces("application/json")]
     [Route("api/[controller]")]
     [ApiController]
@@ -68,8 +69,8 @@ public ActionResult<TodoItem> GetById(long id)
         /// <response code="201">Returns the newly created item</response>
         /// <response code="400">If the item is null</response>            
         [HttpPost]
-        [ProducesResponseType(201)]
-        [ProducesResponseType(400)]
+        [ProducesResponseType(StatusCodes.Status201Created)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public ActionResult<TodoItem> Create(TodoItem item)
         {
             _context.TodoItems.Add(item);

diff --git a/...ials/web-api-help-pages-using-swagger/samples/3.0/TodoApi.Swashbuckle/readme.md b/...ials/web-api-help-pages-using-swagger/samples/3.0/TodoApi.Swashbuckle/readme.md
@@ -312,8 +312,8 @@ Add a [\<remarks>](/dotnet/csharp/programming-guide/xmldoc/remarks) element to t
 /// <response code="201">Returns the newly created item</response>
 /// <response code="400">If the item is null</response>            
 [HttpPost]
-[ProducesResponseType(201)]
-[ProducesResponseType(400)]
+[ProducesResponseType(StatusCodes.Status201Created)]
+[ProducesResponseType(StatusCodes.Status400BadRequest)]
 public ActionResult<TodoItem> Create(TodoItem item)
 {
     _context.TodoItems.Add(item);
@@ -404,8 +404,8 @@ The `Create` action returns an HTTP 201 status code on success. An HTTP 400 stat
 /// <response code="201">Returns the newly created item</response>
 /// <response code="400">If the item is null</response>            
 [HttpPost]
-[ProducesResponseType(201)]
-[ProducesResponseType(400)]
+[ProducesResponseType(StatusCodes.Status201Created)]
+[ProducesResponseType(StatusCodes.Status400BadRequest)]
 public ActionResult<TodoItem> Create(TodoItem item)
 ```