Comments

cv-matcher-api/Controllers/CvController.cs

@@ -3,6 +3,7 @@ using Api.Services.Contracts;
 using Microsoft.AspNetCore.Mvc;
 using CvMatcher.Models.Responses;
 using Shared.Models.Requests;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace Api.Controllers;
 
@@ -21,6 +22,11 @@ public sealed class CvController : ControllerBase
 
     [HttpPost("upload")]
     [RequestSizeLimit(10 * 1024 * 1024)]
+    [SwaggerOperation(Summary = "Upload CV document", Description = "Uploads a CV PDF and indexes it for matching.")]
+    [SwaggerResponse(StatusCodes.Status200OK, "CV uploaded and indexed successfully")]
+    [SwaggerResponse(StatusCodes.Status400BadRequest, "Invalid upload request")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    [ProducesResponseType(StatusCodes.Status400BadRequest)]
     public async Task<ActionResult<CvUploadResponse>> Upload([FromForm] UploadFileRequest request, CancellationToken ct)
     {
         try
@@ -39,6 +45,11 @@ public sealed class CvController : ControllerBase
     }
 
     [HttpPost("find-jobs")]
+    [SwaggerOperation(Summary = "Find matching jobs", Description = "Finds top matching jobs for a previously uploaded CV document.")]
+    [SwaggerResponse(StatusCodes.Status200OK, "Matching jobs returned")]
+    [SwaggerResponse(StatusCodes.Status400BadRequest, "Invalid find jobs request")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    [ProducesResponseType(StatusCodes.Status400BadRequest)]
     public async Task<ActionResult<FindJobsResponse>> FindJobs([FromBody] FindJobsRequest request, CancellationToken ct)
     {
         try
@@ -56,6 +67,11 @@ public sealed class CvController : ControllerBase
     }
 
     [HttpPost("match-job")]
+    [SwaggerOperation(Summary = "Match CV to one job", Description = "Computes detailed match analysis between a CV and a single job description or URL.")]
+    [SwaggerResponse(StatusCodes.Status200OK, "Job match computed successfully")]
+    [SwaggerResponse(StatusCodes.Status400BadRequest, "Invalid match job request")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    [ProducesResponseType(StatusCodes.Status400BadRequest)]
     public async Task<ActionResult<JobMatchResponse>> MatchJob([FromBody] MatchJobRequest request, CancellationToken ct)
     {
         try

cv-matcher-api/Controllers/HealthController.cs

@@ -1,4 +1,5 @@
 using Microsoft.AspNetCore.Mvc;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace Api.Controllers
 {
@@ -19,6 +20,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>
@@ -30,6 +34,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>
@@ -40,6 +47,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>
@@ -52,6 +62,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;