doc

AsbCloudWebApi/AsbCloudWebApi.csproj

@@ -9,8 +9,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="6.0.5" />
-    <PackageReference Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="6.0.5" />
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="6.0.6" />
+    <PackageReference Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="6.0.6" />
     <PackageReference Include="protobuf-net" Version="3.1.4" />
     <PackageReference Include="protobuf-net.AspNetCore" Version="3.0.101" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.3.1" />

AsbCloudWebApi/Controllers/AdminClusterController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор кустов для админки
+    /// </summary>
     [Route("api/admin/cluster")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminCompanyController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор компаний для админки
+    /// </summary>
     [Route("api/admin/company")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminCompanyTypeController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор типов компаний для админки
+    /// </summary>
     [Route("api/admin/companyType")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminDepositController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор месторождений для админки
+    /// </summary>
     [Route("api/admin/deposit")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminPermissionController.cs

@@ -9,6 +9,9 @@ using System.Reflection;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор разрешений пользователей для админки
+    /// </summary>
     [Route("api/admin/permission")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminTelemetryController.cs

@@ -7,6 +7,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор телеметрий для админки
+    /// </summary>
     [Route("api/admin/telemetry")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminUserController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор пользователей для админки
+    /// </summary>
     [Route("api/admin/user")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminUserRoleController.cs

@@ -6,6 +6,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор ролей пользователей для админки
+    /// </summary>
     [Route("api/admin/role")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/AdminWellController.cs

@@ -7,6 +7,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Редактор скважин для админки
+    /// </summary>
     [Route("api/admin/well")]
     [ApiController]
     [Authorize]
@@ -18,7 +21,7 @@ namespace AsbCloudWebApi.Controllers
 
         [HttpPost("EnshureTimezonesIsSet")]
         [Permission]
-        public async Task<IActionResult> EnsureTimestamps(CancellationToken token)
+        public async Task<IActionResult> EnshureTimezonesIsSet(CancellationToken token)
         {
             await ((IWellService)service).EnshureTimezonesIsSetAsync(token);
             return Ok();

AsbCloudWebApi/Controllers/AuthController.cs

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Авторизация
+    /// </summary>
     [Route("/auth")]
     [ApiController]
     public class AuthController : ControllerBase

AsbCloudWebApi/Controllers/ClusterController.cs

@@ -9,7 +9,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер кустов
+    /// Инфо о кустах
     /// </summary>
     [Route("api/cluster")]
     [ApiController]

AsbCloudWebApi/Controllers/CrudWellRelatedController.cs

@@ -11,7 +11,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// CRUD контроллер для админки.
+    /// CRUD контроллер dto связных со скважиной для админки.
     /// </summary>
     /// <typeparam name="T"></typeparam>
     /// <typeparam name="TService"></typeparam>

AsbCloudWebApi/Controllers/DailyReportController.cs

@@ -10,6 +10,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Суточный рапорт
+    /// </summary>
     [Route("api/well/{idWell}/[controller]")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/DepositController.cs

@@ -9,7 +9,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер для месторождений
+    /// Инфо о месторождениях
     /// </summary>
     [Route("api/deposit")]
     [ApiController]

AsbCloudWebApi/Controllers/DrillFlowChartController.cs

@@ -10,7 +10,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер для коридоров бурения на панели
+    /// Коридоры бурения для панели бурильщика
     /// </summary>
     [ApiController]
     [Route("api/[controller]")]

AsbCloudWebApi/Controllers/DrillParamsController.cs

@@ -8,7 +8,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер для режимов бурения
+    /// Режимы бурения
     /// </summary>
     [Route("api/well/{idWell}/drillParams/")]
     [ApiController]

AsbCloudWebApi/Controllers/DrillerController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Справочник бурильщиков
+    /// </summary>
     [Route("api/driller")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/DrillingProgramController.cs

@@ -11,6 +11,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Формирование программы бурения
+    /// </summary>
     [Route("api/well/{idWell}/drillingProgram")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/FileController.cs

@@ -10,6 +10,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Хранение файлов
+    /// </summary>
     [Route("api/well/{idWell}/files")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/MeasureController.cs

@@ -7,6 +7,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Измерения
+    /// </summary>
     [ApiController]
     [Authorize]
     [Route("api/well/{idWell}/measure")]

AsbCloudWebApi/Controllers/OperationStatController.cs

@@ -10,7 +10,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер статистики по операциям на скважине
+    /// Статистика по операциям (заведенным вручную) на скважине
     /// </summary>
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/OperationValueController.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Целевые и нормативные значения по глубине
+    /// </summary>
     [Route("api/operationValue")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/ProtobufController.cs

@@ -6,7 +6,7 @@ using System.Linq;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// контроллер схем ProtoBuf
+    /// Схемы ProtoBuf
     /// </summary>
     [Route("api/proto")]
     [ApiController]

AsbCloudWebApi/Controllers/ReportController.cs

@@ -11,7 +11,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер отчетов по буровым скважинам
+    /// Отчет (временная диаграмма с сообщениями)
     /// </summary>
     [Route("api/well/{idWell}/report")]
     [ApiController]

AsbCloudWebApi/Controllers/RequestTrackerController.cs

@@ -6,6 +6,9 @@ using System.Collections.Generic;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Мониторинг запросов, ошибок, пользователей
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/SAUB/MessageController.cs

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers.SAUB
 {
+    /// <summary>
+    /// Сообщения панели бурильщика
+    /// </summary>
     [Route("api/well/{idWell}/message")]
     [ApiController]
     public class MessageController : ControllerBase

AsbCloudWebApi/Controllers/SAUB/SetpointsController.cs

@@ -9,6 +9,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers.SAUB
 {
+    /// <summary>
+    /// Рекомендация уставок бурильщику
+    /// </summary>
     [ApiController]
     [Authorize]
     public class SetpointsController : ControllerBase

AsbCloudWebApi/Controllers/SAUB/TelemetryController.cs

@@ -12,7 +12,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers.SAUB
 {
     /// <summary>
-    /// Контроллер сбора данных от буровых
+    /// Инфо о передающих телеметрию устройствах
     /// </summary>
     [Route("api/telemetry")]
     [ApiController]

AsbCloudWebApi/Controllers/SAUB/TelemetryDataSaubController.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.SAUB
 {
+    /// <summary>
+    /// Данные АКБ
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class TelemetryDataSaubController : TelemetryDataBaseController<TelemetryDataSaubDto>

AsbCloudWebApi/Controllers/SAUB/TelemetryDataSpinController.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.SAUB
 {
+    /// <summary>
+    /// Данные осциллятора и демпфера
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class TelemetryDataSpinController : TelemetryDataBaseController<TelemetryDataSpinDto>

AsbCloudWebApi/Controllers/SAUB/TelemetryWirelineRunOutController.cs

@@ -7,6 +7,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.SAUB
 {
+    /// <summary>
+    /// Наработка талевого каната
+    /// </summary>
     [ApiController]
     [Authorize]
     [Route("api/[controller]")]

AsbCloudWebApi/Controllers/ScheduleController.cs

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Расписание бурильщиков
+    /// </summary>
     [Route("api/schedule")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/WITS/WitsInfoController.cs

@@ -4,6 +4,9 @@ using System.Collections.Generic;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// Инфо о WITS параметрах
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsInfoController : ControllerBase

AsbCloudWebApi/Controllers/WITS/WitsRecord1Controller.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// WITS записи id = 1
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsRecord1Controller : WitsControllerAbstract<Record1Dto>

AsbCloudWebApi/Controllers/WITS/WitsRecord50Controller.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// WITS записи id = 50 (SIB receiver)
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsRecord50Controller : WitsControllerAbstract<Record50Dto>

AsbCloudWebApi/Controllers/WITS/WitsRecord60Controller.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// WITS записи id = 60 (SIB receiver)
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsRecord60Controller : WitsControllerAbstract<Record60Dto>

AsbCloudWebApi/Controllers/WITS/WitsRecord61Controller.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// WITS записи id = 61 (SIB receiver)
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsRecord61Controller : WitsControllerAbstract<Record61Dto>

AsbCloudWebApi/Controllers/WITS/WitsRecord7Controller.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// WITS записи id = 7
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsRecord7Controller : WitsControllerAbstract<Record7Dto>

AsbCloudWebApi/Controllers/WITS/WitsRecord8Controller.cs

@@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR;
 
 namespace AsbCloudWebApi.Controllers.WITS
 {
+    /// <summary>
+    /// WITS записи id = 8
+    /// </summary>
     [Route("api/[controller]")]
     [ApiController]
     public class WitsRecord8Controller : WitsControllerAbstract<Record8Dto>

AsbCloudWebApi/Controllers/WellCompositeController.cs

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Композитная скважина
+    /// </summary>
     [Route("api/well/{idWell}/composite")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/WellController.cs

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace AsbCloudWebApi.Controllers
 {
+    /// <summary>
+    /// Инфо о скважине
+    /// </summary>
     [Route("api/well")]
     [ApiController]
     [Authorize]

AsbCloudWebApi/Controllers/WellOperationController.cs

@@ -12,7 +12,7 @@ using System.Threading.Tasks;
 namespace AsbCloudWebApi.Controllers
 {
     /// <summary>
-    /// Контроллер вручную внесенных операций на скважине
+    /// Буровые операции (вводимые вручную)
     /// </summary>
     [Route("api/well/{idWell}/wellOperations")]
     [ApiController]

AsbCloudWebApi/DependencyInjection.cs

@@ -3,9 +3,11 @@ using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.IdentityModel.Tokens;
 using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
 
@@ -52,9 +54,9 @@ namespace AsbCloudWebApi
 
                 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
-                c.IncludeXmlComments(xmlPath);
-                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "AsbCloudApp.xml"));
-
+                var includeControllerXmlComment = true;
+                c.IncludeXmlComments(xmlPath, includeControllerXmlComment);
+                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "AsbCloudApp.xml"), includeControllerXmlComment);
             });
         }
 

AsbCloudWebApi/Startup.cs

@@ -93,6 +93,8 @@ namespace AsbCloudWebApi
             {
                 c.SwaggerEndpoint("/swagger/v1/swagger.json", "V1");
                 c.EnablePersistAuthorization();
+                c.EnableFilter();
+                c.DisplayOperationId();
             });
 
             if (env.IsDevelopment())