From d692a2e51933611b92b664e5b753ad64b75f8a6b Mon Sep 17 00:00:00 2001
From: shept <sheptikhinv@gmail.com>
Date: Sun, 27 Apr 2025 16:03:56 +0500
Subject: [PATCH] DTOs docs

---
 .../DTOs/Question/CreateQuestionDTO.cs        | 12 ++++++++++
 .../DTOs/Question/OutputAnswerVariantDTO.cs   | 12 ++++++++++
 .../DTOs/Question/OutputQuestionDto.cs        | 22 +++++++++++++++++
 .../DTOs/Survey/CreateSurveyDTO.cs            |  9 +++++++
 .../DTOs/Survey/OutputSurveyDto.cs            | 15 ++++++++++++
 .../SurveyBackend.API/DTOs/UserLoginDto.cs    |  9 +++++++
 .../DTOs/UserRegistrationDto.cs               | 24 ++++++++++++++++++-
 .../Filters/EndpointAuthRequirementFilter.cs  |  2 ++
 8 files changed, 104 insertions(+), 1 deletion(-)

diff --git a/SurveyBackend/SurveyBackend.API/DTOs/Question/CreateQuestionDTO.cs b/SurveyBackend/SurveyBackend.API/DTOs/Question/CreateQuestionDTO.cs
index 2379b73..5fc9692 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/Question/CreateQuestionDTO.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/Question/CreateQuestionDTO.cs
@@ -1,9 +1,21 @@
 namespace SurveyBackend.DTOs.Question;
 
+/// <summary>
+/// Схема для создания нового Question
+/// </summary>
 public class CreateQuestionDto
 {
+    /// <summary>
+    /// Название вопроса
+    /// </summary>
     public required string Title { get; set; }
+    /// <summary>
+    /// Тип вопроса
+    /// </summary>
     public required string QuestionType { get; set; }
 
+    /// <summary>
+    /// Варианты ответа (только если вопрос с выбором)
+    /// </summary>
     public List<string>? AnswerVariants { get; set; }
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputAnswerVariantDTO.cs b/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputAnswerVariantDTO.cs
index 9112795..ff1b77b 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputAnswerVariantDTO.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputAnswerVariantDTO.cs
@@ -1,8 +1,20 @@
 namespace SurveyBackend.DTOs.Question;
 
+/// <summary>
+/// Выходная схема вариантов ответа
+/// </summary>
 public class OutputAnswerVariantDto
 {
+    /// <summary>
+    /// ID варианта ответа
+    /// </summary>
     public required int Id { get; set; }
+    /// <summary>
+    /// ID родительского вопроса
+    /// </summary>
     public required int QuestionId { get; set; }
+    /// <summary>
+    /// Текст варианта ответа
+    /// </summary>
     public required string Text { get; set; }
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputQuestionDto.cs b/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputQuestionDto.cs
index bfae54c..f850365 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputQuestionDto.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/Question/OutputQuestionDto.cs
@@ -1,10 +1,32 @@
 namespace SurveyBackend.DTOs.Question;
 
+/// <summary>
+/// Выходнпя схема вопроса
+/// </summary>
 public class OutputQuestionDto
 {
+    /// <summary>
+    /// ID вопроса
+    /// </summary>
     public required int Id { get; set; }
+
+    /// <summary>
+    /// ID родительского опроса
+    /// </summary>
     public required int SurveyId { get; set; }
+
+    /// <summary>
+    /// Заголовок вопроса
+    /// </summary>
     public required string Title { get; set; }
+
+    /// <summary>
+    /// Тип вопроса
+    /// </summary>
     public required string QuestionType { get; set; }
+
+    /// <summary>
+    /// Варианты ответа
+    /// </summary>
     public List<OutputAnswerVariantDto>? AnswerVariants { get; set; }
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/DTOs/Survey/CreateSurveyDTO.cs b/SurveyBackend/SurveyBackend.API/DTOs/Survey/CreateSurveyDTO.cs
index 67bfaf6..0383257 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/Survey/CreateSurveyDTO.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/Survey/CreateSurveyDTO.cs
@@ -1,7 +1,16 @@
 namespace SurveyBackend.DTOs.Survey;
 
+/// <summary>
+/// Схема для создания нового опроса
+/// </summary>
 public class CreateSurveyDto
 {
+    /// <summary>
+    /// Название опроса
+    /// </summary>
     public required string Title { get; set; }
+    /// <summary>
+    /// Опциональное описание опроса
+    /// </summary>
     public string Description { get; set; } = string.Empty;
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/DTOs/Survey/OutputSurveyDto.cs b/SurveyBackend/SurveyBackend.API/DTOs/Survey/OutputSurveyDto.cs
index faec104..dea522b 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/Survey/OutputSurveyDto.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/Survey/OutputSurveyDto.cs
@@ -1,9 +1,24 @@
 namespace SurveyBackend.DTOs.Survey;
 
+/// <summary>
+/// Выходная схема опроса
+/// </summary>
 public class OutputSurveyDto
 {
+    /// <summary>
+    /// ID опроса
+    /// </summary>
     public required int Id { get; set; }
+    /// <summary>
+    /// Название опроса
+    /// </summary>
     public required string Title { get; set; }
+    /// <summary>
+    /// Описание опроса
+    /// </summary>
     public required string Description { get; set; }
+    /// <summary>
+    /// Создатель опроса (опционально)
+    /// </summary>
     public int? CreatedBy { get; set; }
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/DTOs/UserLoginDto.cs b/SurveyBackend/SurveyBackend.API/DTOs/UserLoginDto.cs
index 8e58ee2..2cf7002 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/UserLoginDto.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/UserLoginDto.cs
@@ -1,7 +1,16 @@
 namespace SurveyBackend.DTOs;
 
+/// <summary>
+/// Схема авторизации пользователя
+/// </summary>
 public record UserLoginDto
 {
+    /// <summary>
+    /// Почта
+    /// </summary>
     public required string Email { get; set; }
+    /// <summary>
+    /// Пароль
+    /// </summary>
     public required string Password { get; set; }
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/DTOs/UserRegistrationDto.cs b/SurveyBackend/SurveyBackend.API/DTOs/UserRegistrationDto.cs
index 3c0808d..b67622e 100644
--- a/SurveyBackend/SurveyBackend.API/DTOs/UserRegistrationDto.cs
+++ b/SurveyBackend/SurveyBackend.API/DTOs/UserRegistrationDto.cs
@@ -1,10 +1,32 @@
 namespace SurveyBackend.DTOs;
 
+/// <summary>
+/// Схема регистрации пользователя
+/// </summary>
 public record UserRegistrationDto
 {
-    public string Email { get; set; }
+    /// <summary>
+    /// Почта
+    /// </summary>
+    public required string Email { get; set; }
+
+    /// <summary>
+    /// Юзернейм
+    /// </summary>
     public string Username { get; set; }
+
+    /// <summary>
+    /// Имя
+    /// </summary>
     public string FirstName { get; set; }
+
+    /// <summary>
+    /// Фамилия
+    /// </summary>
     public string LastName { get; set; }
+
+    /// <summary>
+    /// Пароль
+    /// </summary>
     public string Password { get; set; }
 }
\ No newline at end of file
diff --git a/SurveyBackend/SurveyBackend.API/Filters/EndpointAuthRequirementFilter.cs b/SurveyBackend/SurveyBackend.API/Filters/EndpointAuthRequirementFilter.cs
index 37ff2a0..d93194f 100644
--- a/SurveyBackend/SurveyBackend.API/Filters/EndpointAuthRequirementFilter.cs
+++ b/SurveyBackend/SurveyBackend.API/Filters/EndpointAuthRequirementFilter.cs
@@ -5,8 +5,10 @@ using Swashbuckle.AspNetCore.SwaggerGen;
 
 namespace SurveyBackend.Filters;
 
+/// <inheritdoc />
 public class EndpointAuthRequirementFilter : IOperationFilter
 {
+    /// <inheritdoc />
     public void Apply(OpenApiOperation operation, OperationFilterContext context)
     {
         if (!context.ApiDescription