Comments

api/Controllers/HealthController.cs

@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Cors;
 using Microsoft.AspNetCore.Mvc;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace Api.Controllers
 {
@@ -22,6 +23,9 @@ namespace Api.Controllers
         /// </returns>
         // GET api/health/live
         [HttpGet("live")]
+        [SwaggerOperation(Summary = "Liveness probe", Description = "Returns whether the API process is alive.")]
+        [SwaggerResponse(StatusCodes.Status200OK, "Service is alive")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
         public IActionResult Live() => Ok(new { status = "alive" });
 
         /// <summary>
@@ -33,6 +37,9 @@ namespace Api.Controllers
         /// </returns>
         // GET api/health
         [HttpGet]
+        [SwaggerOperation(Summary = "Health check", Description = "Returns overall health status and current UTC time.")]
+        [SwaggerResponse(StatusCodes.Status200OK, "Health check succeeded")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
         public IActionResult Health() => Ok(new { status = "ok", time = DateTimeOffset.UtcNow });
 
         /// <summary>
@@ -43,6 +50,9 @@ namespace Api.Controllers
         /// <returns>200 OK with the same JSON payload provided in the request body.</returns>
         // POST api/health/echo
         [HttpPost("echo")]
+        [SwaggerOperation(Summary = "Echo payload", Description = "Returns the same JSON payload received in the request body.")]
+        [SwaggerResponse(StatusCodes.Status200OK, "Payload echoed successfully")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
         public IActionResult Echo(object payload) => Ok(payload);
 
         /// <summary>
@@ -55,6 +65,11 @@ namespace Api.Controllers
         /// </returns>
         // GET api/health/ready
         [HttpGet("ready")]
+        [SwaggerOperation(Summary = "Readiness probe", Description = "Returns whether the service is ready to accept traffic.")]
+        [SwaggerResponse(StatusCodes.Status200OK, "Service is ready")]
+        [SwaggerResponse(StatusCodes.Status503ServiceUnavailable, "Service is not ready")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status503ServiceUnavailable)]
         public IActionResult Ready()
         {
             var ready = true;