Optimize api documentation

nager · Jun 17, 2024 · 69c1802 · 69c1802
1 parent a6477f3
commit 69c1802
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/src/Nager.Authentication.AspNet/Controllers/UserAccountController.cs b/src/Nager.Authentication.AspNet/Controllers/UserAccountController.cs
@@ -106,11 +106,13 @@ public async Task<ActionResult> GetMfaActivationAsync(
         /// <param name="request"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        /// <response code="204">Password changed</response>
+        /// <response code="204">Mfa activated</response>
+        /// <response code="400">Mfa workflow error</response>
         /// <response code="500">Unexpected error</response>
         [HttpPost]
         [Route("Mfa/Activate")]
         [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest, Type = typeof(MfaErrorResponseDto))]
         [ProducesResponseType(StatusCodes.Status500InternalServerError)]
         public async Task<ActionResult> ActivateMfaAsync(
             [Required][FromBody] TimeBasedOneTimeTokenRequestDto request,
@@ -135,7 +137,7 @@ public async Task<ActionResult> ActivateMfaAsync(
 
                 case MfaActivationResult.AlreadyActive:
                 case MfaActivationResult.InvalidCode:
-                    return StatusCode(StatusCodes.Status400BadRequest, new { error = mfaResult.ToString() });
+                    return StatusCode(StatusCodes.Status400BadRequest, new MfaErrorResponseDto { Error = mfaResult.ToString() });
 
                 default:
                     return StatusCode(StatusCodes.Status500InternalServerError);
@@ -148,11 +150,13 @@ public async Task<ActionResult> ActivateMfaAsync(
         /// <param name="request"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        /// <response code="204">Password changed</response>
+        /// <response code="204">Mfa deactivated</response>
+        /// <response code="400">Mfa workflow error</response>
         /// <response code="500">Unexpected error</response>
         [HttpPost]
         [Route("Mfa/Deactivate")]
         [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest, Type = typeof(MfaErrorResponseDto))]
         [ProducesResponseType(StatusCodes.Status500InternalServerError)]
         public async Task<ActionResult> DeactivateMfaAsync(
             [Required][FromBody] TimeBasedOneTimeTokenRequestDto request,
@@ -177,7 +181,7 @@ public async Task<ActionResult> DeactivateMfaAsync(
 
                 case MfaDeactivationResult.NotActive:
                 case MfaDeactivationResult.InvalidCode:
-                    return StatusCode(StatusCodes.Status400BadRequest, new { error = mfaResult.ToString() });
+                    return StatusCode(StatusCodes.Status400BadRequest, new MfaErrorResponseDto { Error = mfaResult.ToString() });
 
                 default:
                     return StatusCode(StatusCodes.Status500InternalServerError);

diff --git a/src/Nager.Authentication.AspNet/Dtos/MfaErrorResponseDto.cs b/src/Nager.Authentication.AspNet/Dtos/MfaErrorResponseDto.cs
@@ -0,0 +1,7 @@
+namespace Nager.Authentication.AspNet.Dtos
+{
+    public class MfaErrorResponseDto
+    {
+        public string Error { get; set; }
+    }
+}
diff --git a/src/Nager.Authentication.AspNet/Nager.Authentication.AspNet.csproj b/src/Nager.Authentication.AspNet/Nager.Authentication.AspNet.csproj
@@ -18,7 +18,7 @@
     <TargetFrameworks>net8.0;net7.0;net6.0</TargetFrameworks>
     <Nullable>enable</Nullable>
 
-    <Version>2.0.1</Version>
+    <Version>2.0.2</Version>
   </PropertyGroup>
 
   <ItemGroup>