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