Комментарии к ChangeLogController

DD.Persistence.API/Controllers/ChangeLogController.cs

@@ -8,6 +8,9 @@ using Microsoft.AspNetCore.Mvc;
 using System.Net;
 using UuidExtensions;
 
+/// <summary>
+/// Контроллер по работе с журналом изменений 
+/// </summary>
 [ApiController]
 [Authorize]
 [Route("api/[controller]")]
@@ -24,6 +27,14 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         this.service = service;
     }
 
+    /// <summary>
+    /// Добавить записи в журнал изменений по дискриминатору
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="dtos"></param>
+    /// <param name="comment"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpPost("{idDiscriminator}")]
     [ProducesResponseType(typeof(int), (int)HttpStatusCode.Created)]
     public async Task<IActionResult> AddRange(
@@ -39,6 +50,13 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return CreatedAtAction(nameof(AddRange), result);
     }
 
+    /// <summary>
+    /// Удалить записи в журнале изменений
+    /// </summary>
+    /// <param name="ids"></param>
+    /// <param name="comment"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpDelete]
     [ProducesResponseType(typeof(int), (int)HttpStatusCode.OK)]
     public async Task<IActionResult> DeleteRange(IEnumerable<Guid> ids, string comment, CancellationToken token)
@@ -50,6 +68,15 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+
+    /// <summary>
+    /// Очистить все записи в журнале изменений (по дискриминатору) и добавить новые
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="dtos"></param>
+    /// <param name="comment"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpPost("replace/{idDiscriminator}")]
     [ProducesResponseType(typeof(int), (int)HttpStatusCode.OK)]
     public async Task<IActionResult> ClearAndAddRange(
@@ -64,6 +91,13 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// сохранить изменения в записях журнала изменений
+    /// </summary>
+    /// <param name="dtos"></param>
+    /// <param name="comment"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpPut]
     [ProducesResponseType(typeof(int), (int)HttpStatusCode.OK)]
     public async Task<IActionResult> UpdateRange(
@@ -78,6 +112,13 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получение актуальных записей (с пагинацией)
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="paginationRequest"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpGet("{idDiscriminator}")]
     [ProducesResponseType(typeof(PaginationContainer<ChangeLogValuesDto>), (int)HttpStatusCode.OK)]
     public async Task<IActionResult> GetCurrent(
@@ -91,6 +132,14 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получение записей на определенный момент времени (с пагинацией)
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="moment"></param>
+    /// <param name="paginationRequest"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpGet("moment/{idDiscriminator}")]
     [ProducesResponseType(typeof(PaginationContainer<ChangeLogValuesDto>), (int)HttpStatusCode.OK)]
     public async Task<IActionResult> GetByDate(
@@ -104,6 +153,14 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получение измененных записей за период времени
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="dateBegin"></param>
+    /// <param name="dateEnd"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpGet("history/{idDiscriminator}")]
     [ProducesResponseType(typeof(IEnumerable<ChangeLogDto>), (int)HttpStatusCode.OK)]
     [ProducesResponseType((int)HttpStatusCode.NoContent)]
@@ -118,6 +175,12 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получение списка дат, в которые происходили изменения (день, месяц, год, без времени)
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpGet("datesChange/{idDiscriminator}")]
     [ProducesResponseType(typeof(IEnumerable<DateOnly>), (int)HttpStatusCode.OK)]
     [ProducesResponseType((int)HttpStatusCode.NoContent)]
@@ -128,6 +191,14 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получение данных, начиная с определенной даты
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="dateBegin"></param>
+    /// <param name="take"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpGet("part/{idDiscriminator}")]
     [ProducesResponseType(typeof(IEnumerable<ChangeLogValuesDto>), (int)HttpStatusCode.OK)]
     [ProducesResponseType((int)HttpStatusCode.NoContent)]
@@ -138,6 +209,12 @@ public class ChangeLogController : ControllerBase, IChangeLogApi
         return Ok(result);
     }
 
+    /// <summary>
+    /// Получить диапазон дат, для которых есть данные в репозитории
+    /// </summary>
+    /// <param name="idDiscriminator"></param>
+    /// <param name="token"></param>
+    /// <returns></returns>
     [HttpGet("datesRange/{idDiscriminator}")]
     [ProducesResponseType(typeof(DatesRangeDto), (int)HttpStatusCode.OK)]
     [ProducesResponseType((int)HttpStatusCode.NoContent)]