DTOs docs

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; }
 }

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; }
 }

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; }
 }

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;
 }

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; }
 }

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; }
 }

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; }
 }