#111 statuscode 400 in swagger and update guideline

Codit · Mar 22, 2019 · bfc7c98 · bfc7c98
1 parent 5f13698
commit bfc7c98
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/maturity-level-one/README.md b/maturity-level-one/README.md
@@ -143,6 +143,7 @@ This allows you to be secure on the physical API while the consumers can still u
     - Less details compared to a custom data contract
     - Read [this blog post](https://tech.domain.com.au/2017/11/please-dont-spare-me-the-details/) on how to achieve this
   - If the above suggestion is not possible you should use a custom data contract. See Microsoft example [here](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#7102-error-condition-responses).
+- For all controllers, document all possible return status codes using a [SwaggerResponse] attribute.
 - Shouldn't there be a general response for our API's, a general scheme we can use after all? Maybe using trackingcodes etc with map to app insights?
 
 ## Document your APIs

diff --git a/maturity-level-one/src/Controllers/v1/PlayersController.cs b/maturity-level-one/src/Controllers/v1/PlayersController.cs
@@ -21,6 +21,7 @@ namespace Codit.LevelOne.Controllers.v1
     [Route("world-cup/v1/[controller]")]
     [ApiController]
     [ValidateModel]
+    [SwaggerResponse((int) HttpStatusCode.BadRequest, "Input validation error.")]
     public class PlayersController : ControllerBase
     {
         private const string GetPlayerRoute = "Players_GetPlayer";

diff --git a/maturity-level-one/src/Controllers/v1/TeamsController.cs b/maturity-level-one/src/Controllers/v1/TeamsController.cs
@@ -17,6 +17,7 @@ namespace Codit.LevelOne.Controllers.v1
     [Route("world-cup/v1/[controller]")]
     [ApiController]
     [ValidateModel]
+    [SwaggerResponse((int)HttpStatusCode.BadRequest, "Input validation error.")]
     public class TeamsController : ControllerBase
     {
         private readonly IWorldCupRepository _worldCupRepository;

diff --git a/maturity-level-two/src/Controllers/v1/CarController.cs b/maturity-level-two/src/Controllers/v1/CarController.cs
@@ -15,6 +15,7 @@ namespace Codit.LevelTwo.Controllers.v1
     [Route("codito/v1/[controller]")]
     [ApiController]
     [ValidateModel]
+    [SwaggerResponse((int)HttpStatusCode.BadRequest, "Input validation error.")]
     public class CarController : ControllerBase
     {
         private readonly ICoditoRepository _coditoRepository;

diff --git a/maturity-level-two/src/Controllers/v1/CustomizationController.cs b/maturity-level-two/src/Controllers/v1/CustomizationController.cs
@@ -19,6 +19,7 @@ namespace Codit.LevelTwo.Controllers.v1
     [Route("codito/v1/[controller]")]
     [ApiController]
     [ValidateModel]
+    [SwaggerResponse((int)HttpStatusCode.BadRequest, "Input validation error.")]
     public class CustomizationController : ControllerBase
     {