From 4605c818951ada6f9f9a61fcf7bfe1efe4c9a302 Mon Sep 17 00:00:00 2001
From: Polianin Nikita <nikitkapolyanin@yandex.ru>
Date: Fri, 25 Oct 2024 04:43:18 +0300
Subject: [PATCH] docs: add some specification

---
 Endpoint/Controllers/V1/ScheduleController.cs            | 8 ++++++++
 .../Queries/GetProfessorDetails/GetProfessorInfoQuery.cs | 9 +++++++++
 2 files changed, 17 insertions(+)

diff --git a/Endpoint/Controllers/V1/ScheduleController.cs b/Endpoint/Controllers/V1/ScheduleController.cs
index a3fec0a..05931b1 100644
--- a/Endpoint/Controllers/V1/ScheduleController.cs
+++ b/Endpoint/Controllers/V1/ScheduleController.cs
@@ -21,10 +21,18 @@ namespace Mirea.Api.Endpoint.Controllers.V1;
 [CacheMaxAge(true)]
 public class ScheduleController(IMediator mediator, IOptionsSnapshot<GeneralConfig> config) : BaseController
 {
+    /// <summary>
+    /// Retrieves the start term for the schedule.
+    /// </summary>
+    /// <returns>The start term as a <see cref="DateOnly"/> value.</returns>
     [CacheMaxAge(1, 0)]
     [HttpGet("StartTerm")]
     public ActionResult<DateOnly> GetStartTerm() => config.Value.ScheduleSettings!.StartTerm;
 
+    /// <summary>
+    /// Retrieves the pair periods.
+    /// </summary>
+    /// <returns>A dictionary of pair periods, where the key is an integer identifier and the value is a <see cref="PairPeriodTime"/> object.</returns>
     [CacheMaxAge(1, 0)]
     [HttpGet("PairPeriod")]
     public ActionResult<Dictionary<int, PairPeriodTime>> GetPairPeriod() => config.Value.ScheduleSettings!.PairPeriod.ConvertToDto();
diff --git a/SqlData/Application/Cqrs/Professor/Queries/GetProfessorDetails/GetProfessorInfoQuery.cs b/SqlData/Application/Cqrs/Professor/Queries/GetProfessorDetails/GetProfessorInfoQuery.cs
index 93f1aa8..4fa0a25 100644
--- a/SqlData/Application/Cqrs/Professor/Queries/GetProfessorDetails/GetProfessorInfoQuery.cs
+++ b/SqlData/Application/Cqrs/Professor/Queries/GetProfessorDetails/GetProfessorInfoQuery.cs
@@ -2,7 +2,16 @@
 
 namespace Mirea.Api.DataAccess.Application.Cqrs.Professor.Queries.GetProfessorDetails;
 
+/// <summary>
+/// Represents a query to retrieve information about a professor.
+/// </summary>
+/// <remarks>
+/// This query can be used to fetch details of a professor by either their unique identifier.
+/// </remarks>
 public class GetProfessorInfoQuery : IRequest<ProfessorInfoVm>
 {
+    /// <summary>
+    /// The unique identifier for the professor.
+    /// </summary>
     public required int Id { get; set; }
 }
\ No newline at end of file