From fb3320fe183632af439f06129d559bf037583f39 Mon Sep 17 00:00:00 2001
From: shept <sheptikhinv@gmail.com>
Date: Sun, 27 Apr 2025 15:58:51 +0500
Subject: [PATCH] add controllers docs

---
 .../Controllers/AuthController.cs             |  7 +++++
 .../Controllers/QuestionController.cs         | 15 ++++++++++
 .../Controllers/SurveyController.cs           | 30 +++++++++++++++++++
 .../Controllers/TestController.cs             |  3 ++
 4 files changed, 55 insertions(+)

diff --git a/SurveyBackend/SurveyBackend.API/Controllers/AuthController.cs b/SurveyBackend/SurveyBackend.API/Controllers/AuthController.cs
index f840248..a4ee704 100644
--- a/SurveyBackend/SurveyBackend.API/Controllers/AuthController.cs
+++ b/SurveyBackend/SurveyBackend.API/Controllers/AuthController.cs
@@ -6,12 +6,19 @@ using IAuthorizationService = SurveyBackend.Core.Services.IAuthorizationService;
 
 namespace SurveyBackend.Controllers;
 
+/// <summary>
+/// Контроллер для всего связанного с авторизацией пользователей
+/// </summary>
 [ApiController]
 [Route("api/auth")]
 public class AuthController : ControllerBase
 {
     private readonly IAuthorizationService _authorizationService;
 
+    /// <summary>
+    /// Нет ну вы прикалываетесь что ли мне ща каждый контроллер описывать?
+    /// </summary>
+    /// <param name="authorizationService"></param>
     public AuthController(IAuthorizationService authorizationService)
     {
         _authorizationService = authorizationService;
diff --git a/SurveyBackend/SurveyBackend.API/Controllers/QuestionController.cs b/SurveyBackend/SurveyBackend.API/Controllers/QuestionController.cs
index a8b5764..e9ac6a0 100644
--- a/SurveyBackend/SurveyBackend.API/Controllers/QuestionController.cs
+++ b/SurveyBackend/SurveyBackend.API/Controllers/QuestionController.cs
@@ -7,17 +7,25 @@ using SurveyLib.Core.Services;
 
 namespace SurveyBackend.Controllers;
 
+/// <inheritdoc />
 [ApiController]
 [Route("api/surveys/{surveyId}/questions")]
 public class QuestionController : ControllerBase
 {
     private readonly IQuestionService _questionService;
 
+    /// <inheritdoc />
     public QuestionController(IQuestionService questionService, IUserContext userContext)
     {
         _questionService = questionService;
     }
 
+    /// <summary>
+    /// Возвращает список вопросов из опроса по его ID
+    /// </summary>
+    /// <remarks>Получение вопросов по ID опроса. В случае отсутствия опроса с таким идентификатором выкидывает 404</remarks>
+    /// <param name="surveyId"></param>
+    /// <returns></returns>
     [AllowAnonymous]
     [HttpGet]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
@@ -29,6 +37,13 @@ public class QuestionController : ControllerBase
         return Ok(result);
     }
 
+    /// <summary>
+    /// Добавить вопрос к опросу
+    /// </summary>
+    /// <remarks>К опросу с указанным ID добавляет вопрос. Если я правильно написал, при отсутствии такого опроса кинет 404</remarks>
+    /// <param name="dto"></param>
+    /// <param name="surveyId"></param>
+    /// <returns></returns>
     [Authorize]
     [HttpPost]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
diff --git a/SurveyBackend/SurveyBackend.API/Controllers/SurveyController.cs b/SurveyBackend/SurveyBackend.API/Controllers/SurveyController.cs
index d471152..24f1cd2 100644
--- a/SurveyBackend/SurveyBackend.API/Controllers/SurveyController.cs
+++ b/SurveyBackend/SurveyBackend.API/Controllers/SurveyController.cs
@@ -10,6 +10,7 @@ using SurveyLib.Core.Services;
 
 namespace SurveyBackend.Controllers;
 
+/// <inheritdoc />
 [ApiController]
 [Route("api/surveys")]
 public class SurveyController : ControllerBase
@@ -17,12 +18,18 @@ public class SurveyController : ControllerBase
     private readonly ISurveyService _surveyService;
     private readonly IUserContext _userContext;
 
+    /// <inheritdoc />
     public SurveyController(ISurveyService surveyService, IUserContext userContext)
     {
         _surveyService = surveyService;
         _userContext = userContext;
     }
 
+    /// <summary>
+    /// Получить ВСЕ опросы
+    /// </summary>
+    /// <remarks>Возвращает массив вообще всех опросов</remarks>
+    /// <returns></returns>
     [AllowAnonymous]
     [HttpGet]
     [ProducesResponseType(typeof(List<OutputSurveyDto>), StatusCodes.Status200OK)]
@@ -33,6 +40,12 @@ public class SurveyController : ControllerBase
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получить опрос по ID
+    /// </summary>
+    /// <remarks>А что тут говорить то</remarks>
+    /// <param name="id"></param>
+    /// <returns></returns>
     [AllowAnonymous]
     [HttpGet("{id}")]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
@@ -44,6 +57,12 @@ public class SurveyController : ControllerBase
         return Ok(result);
     }
 
+    /// <summary>
+    /// Добавить новый опрос
+    /// </summary>
+    /// <remarks></remarks>
+    /// <param name="dto"></param>
+    /// <returns></returns>
     [Authorize]
     [HttpPost]
     [ProducesResponseType(StatusCodes.Status201Created)]
@@ -56,6 +75,12 @@ public class SurveyController : ControllerBase
         return Created();
     }
 
+    /// <summary>
+    /// Удалить опрос по ID
+    /// </summary>
+    /// <remarks>Опрос должен быть создан тобой чтоб его удалить</remarks>
+    /// <param name="id"></param>
+    /// <returns></returns>
     [Authorize]
     [HttpDelete("{id}")]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
@@ -67,6 +92,11 @@ public class SurveyController : ControllerBase
         return Ok();
     }
 
+    /// <summary>
+    /// Получить МОИ опроса
+    /// </summary>
+    /// <remarks>Возвращает только опросы созданные нынешним юзером</remarks>
+    /// <returns></returns>
     [Authorize]
     [HttpGet("my")]
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]
diff --git a/SurveyBackend/SurveyBackend.API/Controllers/TestController.cs b/SurveyBackend/SurveyBackend.API/Controllers/TestController.cs
index cbf5688..2d7a6ca 100644
--- a/SurveyBackend/SurveyBackend.API/Controllers/TestController.cs
+++ b/SurveyBackend/SurveyBackend.API/Controllers/TestController.cs
@@ -3,6 +3,9 @@ using SurveyLib.Core.Services;
 
 namespace SurveyBackend.Controllers;
 
+/// <summary>
+/// Удалим когда-нибудь
+/// </summary>
 [ApiController]
 [Route("api/test")]
 public class TestController : ControllerBase