From 6512a7e75222b33105cb00db27657644113aa9a1 Mon Sep 17 00:00:00 2001 From: ngfrolov Date: Thu, 16 Jun 2022 17:37:10 +0500 Subject: [PATCH] doc --- AsbCloudWebApi/AsbCloudWebApi.csproj | 4 ++-- AsbCloudWebApi/Controllers/AdminClusterController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminCompanyController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminCompanyTypeController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminDepositController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminPermissionController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminTelemetryController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminUserController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminUserRoleController.cs | 3 +++ AsbCloudWebApi/Controllers/AdminWellController.cs | 5 ++++- AsbCloudWebApi/Controllers/AuthController.cs | 3 +++ AsbCloudWebApi/Controllers/ClusterController.cs | 2 +- AsbCloudWebApi/Controllers/CrudWellRelatedController.cs | 2 +- AsbCloudWebApi/Controllers/DailyReportController.cs | 3 +++ AsbCloudWebApi/Controllers/DepositController.cs | 2 +- AsbCloudWebApi/Controllers/DrillFlowChartController.cs | 2 +- AsbCloudWebApi/Controllers/DrillParamsController.cs | 2 +- AsbCloudWebApi/Controllers/DrillerController.cs | 3 +++ AsbCloudWebApi/Controllers/DrillingProgramController.cs | 3 +++ AsbCloudWebApi/Controllers/FileController.cs | 3 +++ AsbCloudWebApi/Controllers/MeasureController.cs | 3 +++ AsbCloudWebApi/Controllers/OperationStatController.cs | 2 +- AsbCloudWebApi/Controllers/OperationValueController.cs | 3 +++ AsbCloudWebApi/Controllers/ProtobufController.cs | 2 +- AsbCloudWebApi/Controllers/ReportController.cs | 2 +- AsbCloudWebApi/Controllers/RequestTrackerController.cs | 3 +++ AsbCloudWebApi/Controllers/SAUB/MessageController.cs | 3 +++ AsbCloudWebApi/Controllers/SAUB/SetpointsController.cs | 3 +++ AsbCloudWebApi/Controllers/SAUB/TelemetryController.cs | 2 +- .../Controllers/SAUB/TelemetryDataSaubController.cs | 3 +++ .../Controllers/SAUB/TelemetryDataSpinController.cs | 3 +++ .../Controllers/SAUB/TelemetryWirelineRunOutController.cs | 3 +++ AsbCloudWebApi/Controllers/ScheduleController.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsInfoController.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsRecord1Controller.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsRecord50Controller.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsRecord60Controller.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsRecord61Controller.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsRecord7Controller.cs | 3 +++ AsbCloudWebApi/Controllers/WITS/WitsRecord8Controller.cs | 3 +++ AsbCloudWebApi/Controllers/WellCompositeController.cs | 3 +++ AsbCloudWebApi/Controllers/WellController.cs | 3 +++ AsbCloudWebApi/Controllers/WellOperationController.cs | 2 +- AsbCloudWebApi/DependencyInjection.cs | 8 +++++--- AsbCloudWebApi/Startup.cs | 2 ++ 45 files changed, 116 insertions(+), 16 deletions(-) diff --git a/AsbCloudWebApi/AsbCloudWebApi.csproj b/AsbCloudWebApi/AsbCloudWebApi.csproj index e317510e..820753a6 100644 --- a/AsbCloudWebApi/AsbCloudWebApi.csproj +++ b/AsbCloudWebApi/AsbCloudWebApi.csproj @@ -9,8 +9,8 @@ - - + + diff --git a/AsbCloudWebApi/Controllers/AdminClusterController.cs b/AsbCloudWebApi/Controllers/AdminClusterController.cs index a2a69cb3..2f8d927a 100644 --- a/AsbCloudWebApi/Controllers/AdminClusterController.cs +++ b/AsbCloudWebApi/Controllers/AdminClusterController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор кустов для админки + /// [Route("api/admin/cluster")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminCompanyController.cs b/AsbCloudWebApi/Controllers/AdminCompanyController.cs index 09853a0e..04f6109f 100644 --- a/AsbCloudWebApi/Controllers/AdminCompanyController.cs +++ b/AsbCloudWebApi/Controllers/AdminCompanyController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор компаний для админки + /// [Route("api/admin/company")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminCompanyTypeController.cs b/AsbCloudWebApi/Controllers/AdminCompanyTypeController.cs index a2c3bb81..60c3ea22 100644 --- a/AsbCloudWebApi/Controllers/AdminCompanyTypeController.cs +++ b/AsbCloudWebApi/Controllers/AdminCompanyTypeController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор типов компаний для админки + /// [Route("api/admin/companyType")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminDepositController.cs b/AsbCloudWebApi/Controllers/AdminDepositController.cs index 571290de..c35be313 100644 --- a/AsbCloudWebApi/Controllers/AdminDepositController.cs +++ b/AsbCloudWebApi/Controllers/AdminDepositController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор месторождений для админки + /// [Route("api/admin/deposit")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminPermissionController.cs b/AsbCloudWebApi/Controllers/AdminPermissionController.cs index 007cfe0d..ffbfe213 100644 --- a/AsbCloudWebApi/Controllers/AdminPermissionController.cs +++ b/AsbCloudWebApi/Controllers/AdminPermissionController.cs @@ -9,6 +9,9 @@ using System.Reflection; namespace AsbCloudWebApi.Controllers { + /// + /// + /// [Route("api/admin/permission")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminTelemetryController.cs b/AsbCloudWebApi/Controllers/AdminTelemetryController.cs index 7e8c3d43..1daad23c 100644 --- a/AsbCloudWebApi/Controllers/AdminTelemetryController.cs +++ b/AsbCloudWebApi/Controllers/AdminTelemetryController.cs @@ -7,6 +7,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор телеметрий для админки + /// [Route("api/admin/telemetry")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminUserController.cs b/AsbCloudWebApi/Controllers/AdminUserController.cs index 142a88b6..e515d370 100644 --- a/AsbCloudWebApi/Controllers/AdminUserController.cs +++ b/AsbCloudWebApi/Controllers/AdminUserController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор пользователей для админки + /// [Route("api/admin/user")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminUserRoleController.cs b/AsbCloudWebApi/Controllers/AdminUserRoleController.cs index 39b91721..cd54cff5 100644 --- a/AsbCloudWebApi/Controllers/AdminUserRoleController.cs +++ b/AsbCloudWebApi/Controllers/AdminUserRoleController.cs @@ -6,6 +6,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор ролей пользователей для админки + /// [Route("api/admin/role")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/AdminWellController.cs b/AsbCloudWebApi/Controllers/AdminWellController.cs index 82161e1d..3441af43 100644 --- a/AsbCloudWebApi/Controllers/AdminWellController.cs +++ b/AsbCloudWebApi/Controllers/AdminWellController.cs @@ -7,6 +7,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Редактор скважин для админки + /// [Route("api/admin/well")] [ApiController] [Authorize] @@ -18,7 +21,7 @@ namespace AsbCloudWebApi.Controllers [HttpPost("EnshureTimezonesIsSet")] [Permission] - public async Task EnsureTimestamps(CancellationToken token) + public async Task EnshureTimezonesIsSet(CancellationToken token) { await ((IWellService)service).EnshureTimezonesIsSetAsync(token); return Ok(); diff --git a/AsbCloudWebApi/Controllers/AuthController.cs b/AsbCloudWebApi/Controllers/AuthController.cs index 49cfe68f..6245313f 100644 --- a/AsbCloudWebApi/Controllers/AuthController.cs +++ b/AsbCloudWebApi/Controllers/AuthController.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Авторизация + /// [Route("/auth")] [ApiController] public class AuthController : ControllerBase diff --git a/AsbCloudWebApi/Controllers/ClusterController.cs b/AsbCloudWebApi/Controllers/ClusterController.cs index 16b2ba09..981dd5b6 100644 --- a/AsbCloudWebApi/Controllers/ClusterController.cs +++ b/AsbCloudWebApi/Controllers/ClusterController.cs @@ -9,7 +9,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер кустов + /// Инфо о кустах /// [Route("api/cluster")] [ApiController] diff --git a/AsbCloudWebApi/Controllers/CrudWellRelatedController.cs b/AsbCloudWebApi/Controllers/CrudWellRelatedController.cs index a8042d15..4d8e7642 100644 --- a/AsbCloudWebApi/Controllers/CrudWellRelatedController.cs +++ b/AsbCloudWebApi/Controllers/CrudWellRelatedController.cs @@ -11,7 +11,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// CRUD контроллер для админки. + /// CRUD контроллер dto связных со скважиной для админки. /// /// /// diff --git a/AsbCloudWebApi/Controllers/DailyReportController.cs b/AsbCloudWebApi/Controllers/DailyReportController.cs index 4381f308..7cfb03de 100644 --- a/AsbCloudWebApi/Controllers/DailyReportController.cs +++ b/AsbCloudWebApi/Controllers/DailyReportController.cs @@ -10,6 +10,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Суточный рапорт + /// [Route("api/well/{idWell}/[controller]")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/DepositController.cs b/AsbCloudWebApi/Controllers/DepositController.cs index 44a0f4a0..9fd4d03f 100644 --- a/AsbCloudWebApi/Controllers/DepositController.cs +++ b/AsbCloudWebApi/Controllers/DepositController.cs @@ -9,7 +9,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер для месторождений + /// Инфо о месторождениях /// [Route("api/deposit")] [ApiController] diff --git a/AsbCloudWebApi/Controllers/DrillFlowChartController.cs b/AsbCloudWebApi/Controllers/DrillFlowChartController.cs index 6d0fc44d..6737b9dc 100644 --- a/AsbCloudWebApi/Controllers/DrillFlowChartController.cs +++ b/AsbCloudWebApi/Controllers/DrillFlowChartController.cs @@ -10,7 +10,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер для коридоров бурения на панели + /// Коридоры бурения для панели бурильщика /// [ApiController] [Route("api/[controller]")] diff --git a/AsbCloudWebApi/Controllers/DrillParamsController.cs b/AsbCloudWebApi/Controllers/DrillParamsController.cs index 2b99f0c6..eacd3843 100644 --- a/AsbCloudWebApi/Controllers/DrillParamsController.cs +++ b/AsbCloudWebApi/Controllers/DrillParamsController.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер для режимов бурения + /// Режимы бурения /// [Route("api/well/{idWell}/drillParams/")] [ApiController] diff --git a/AsbCloudWebApi/Controllers/DrillerController.cs b/AsbCloudWebApi/Controllers/DrillerController.cs index ba397b15..8f85e934 100644 --- a/AsbCloudWebApi/Controllers/DrillerController.cs +++ b/AsbCloudWebApi/Controllers/DrillerController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Справочник бурильщиков + /// [Route("api/driller")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/DrillingProgramController.cs b/AsbCloudWebApi/Controllers/DrillingProgramController.cs index fd0fc41c..5b7f2c99 100644 --- a/AsbCloudWebApi/Controllers/DrillingProgramController.cs +++ b/AsbCloudWebApi/Controllers/DrillingProgramController.cs @@ -11,6 +11,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Формирование программы бурения + /// [Route("api/well/{idWell}/drillingProgram")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/FileController.cs b/AsbCloudWebApi/Controllers/FileController.cs index d6622cf4..46f9d589 100644 --- a/AsbCloudWebApi/Controllers/FileController.cs +++ b/AsbCloudWebApi/Controllers/FileController.cs @@ -10,6 +10,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Хранение файлов + /// [Route("api/well/{idWell}/files")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/MeasureController.cs b/AsbCloudWebApi/Controllers/MeasureController.cs index d936e090..bbfebcf6 100644 --- a/AsbCloudWebApi/Controllers/MeasureController.cs +++ b/AsbCloudWebApi/Controllers/MeasureController.cs @@ -7,6 +7,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Измерения + /// [ApiController] [Authorize] [Route("api/well/{idWell}/measure")] diff --git a/AsbCloudWebApi/Controllers/OperationStatController.cs b/AsbCloudWebApi/Controllers/OperationStatController.cs index d7125ff7..e9409e1d 100644 --- a/AsbCloudWebApi/Controllers/OperationStatController.cs +++ b/AsbCloudWebApi/Controllers/OperationStatController.cs @@ -10,7 +10,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер статистики по операциям на скважине + /// Статистика по операциям (заведенным вручную) на скважине /// [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/OperationValueController.cs b/AsbCloudWebApi/Controllers/OperationValueController.cs index 7f4d344a..a4c2fbe4 100644 --- a/AsbCloudWebApi/Controllers/OperationValueController.cs +++ b/AsbCloudWebApi/Controllers/OperationValueController.cs @@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc; namespace AsbCloudWebApi.Controllers { + /// + /// Целевые и нормативные значения по глубине + /// [Route("api/operationValue")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/ProtobufController.cs b/AsbCloudWebApi/Controllers/ProtobufController.cs index f6620e6e..cc60fa14 100644 --- a/AsbCloudWebApi/Controllers/ProtobufController.cs +++ b/AsbCloudWebApi/Controllers/ProtobufController.cs @@ -6,7 +6,7 @@ using System.Linq; namespace AsbCloudWebApi.Controllers { /// - /// контроллер схем ProtoBuf + /// Схемы ProtoBuf /// [Route("api/proto")] [ApiController] diff --git a/AsbCloudWebApi/Controllers/ReportController.cs b/AsbCloudWebApi/Controllers/ReportController.cs index b5e02333..03897582 100644 --- a/AsbCloudWebApi/Controllers/ReportController.cs +++ b/AsbCloudWebApi/Controllers/ReportController.cs @@ -11,7 +11,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер отчетов по буровым скважинам + /// Отчет (временная диаграмма с сообщениями) /// [Route("api/well/{idWell}/report")] [ApiController] diff --git a/AsbCloudWebApi/Controllers/RequestTrackerController.cs b/AsbCloudWebApi/Controllers/RequestTrackerController.cs index 1e5bd8f5..33bfb0c7 100644 --- a/AsbCloudWebApi/Controllers/RequestTrackerController.cs +++ b/AsbCloudWebApi/Controllers/RequestTrackerController.cs @@ -6,6 +6,9 @@ using System.Collections.Generic; namespace AsbCloudWebApi.Controllers { + /// + /// Мониторинг запросов, ошибок, пользователей + /// [Route("api/[controller]")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/SAUB/MessageController.cs b/AsbCloudWebApi/Controllers/SAUB/MessageController.cs index 1be99b19..00f6fd6e 100644 --- a/AsbCloudWebApi/Controllers/SAUB/MessageController.cs +++ b/AsbCloudWebApi/Controllers/SAUB/MessageController.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers.SAUB { + /// + /// Сообщения панели бурильщика + /// [Route("api/well/{idWell}/message")] [ApiController] public class MessageController : ControllerBase diff --git a/AsbCloudWebApi/Controllers/SAUB/SetpointsController.cs b/AsbCloudWebApi/Controllers/SAUB/SetpointsController.cs index 547e9c7f..3b88c063 100644 --- a/AsbCloudWebApi/Controllers/SAUB/SetpointsController.cs +++ b/AsbCloudWebApi/Controllers/SAUB/SetpointsController.cs @@ -9,6 +9,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers.SAUB { + /// + /// Рекомендация уставок бурильщику + /// [ApiController] [Authorize] public class SetpointsController : ControllerBase diff --git a/AsbCloudWebApi/Controllers/SAUB/TelemetryController.cs b/AsbCloudWebApi/Controllers/SAUB/TelemetryController.cs index 65d074ee..33750bdd 100644 --- a/AsbCloudWebApi/Controllers/SAUB/TelemetryController.cs +++ b/AsbCloudWebApi/Controllers/SAUB/TelemetryController.cs @@ -12,7 +12,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers.SAUB { /// - /// Контроллер сбора данных от буровых + /// Инфо о передающих телеметрию устройствах /// [Route("api/telemetry")] [ApiController] diff --git a/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSaubController.cs b/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSaubController.cs index 2ac22774..b9ff1d88 100644 --- a/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSaubController.cs +++ b/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSaubController.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.SAUB { + /// + /// Данные АКБ + /// [Route("api/[controller]")] [ApiController] public class TelemetryDataSaubController : TelemetryDataBaseController diff --git a/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSpinController.cs b/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSpinController.cs index 5ee57ffe..35875fa5 100644 --- a/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSpinController.cs +++ b/AsbCloudWebApi/Controllers/SAUB/TelemetryDataSpinController.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.SAUB { + /// + /// Данные осциллятора и демпфера + /// [Route("api/[controller]")] [ApiController] public class TelemetryDataSpinController : TelemetryDataBaseController diff --git a/AsbCloudWebApi/Controllers/SAUB/TelemetryWirelineRunOutController.cs b/AsbCloudWebApi/Controllers/SAUB/TelemetryWirelineRunOutController.cs index 787670ab..2dc3d5e7 100644 --- a/AsbCloudWebApi/Controllers/SAUB/TelemetryWirelineRunOutController.cs +++ b/AsbCloudWebApi/Controllers/SAUB/TelemetryWirelineRunOutController.cs @@ -7,6 +7,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.SAUB { + /// + /// Наработка талевого каната + /// [ApiController] [Authorize] [Route("api/[controller]")] diff --git a/AsbCloudWebApi/Controllers/ScheduleController.cs b/AsbCloudWebApi/Controllers/ScheduleController.cs index 7c47346f..4e4a9a58 100644 --- a/AsbCloudWebApi/Controllers/ScheduleController.cs +++ b/AsbCloudWebApi/Controllers/ScheduleController.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Расписание бурильщиков + /// [Route("api/schedule")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/WITS/WitsInfoController.cs b/AsbCloudWebApi/Controllers/WITS/WitsInfoController.cs index 7aee64ac..c1298cfb 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsInfoController.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsInfoController.cs @@ -4,6 +4,9 @@ using System.Collections.Generic; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// Инфо о WITS параметрах + /// [Route("api/[controller]")] [ApiController] public class WitsInfoController : ControllerBase diff --git a/AsbCloudWebApi/Controllers/WITS/WitsRecord1Controller.cs b/AsbCloudWebApi/Controllers/WITS/WitsRecord1Controller.cs index a0b3f33c..59191dfb 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsRecord1Controller.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsRecord1Controller.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// WITS записи id = 1 + /// [Route("api/[controller]")] [ApiController] public class WitsRecord1Controller : WitsControllerAbstract diff --git a/AsbCloudWebApi/Controllers/WITS/WitsRecord50Controller.cs b/AsbCloudWebApi/Controllers/WITS/WitsRecord50Controller.cs index 96d991b2..0cef1bcc 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsRecord50Controller.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsRecord50Controller.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// WITS записи id = 50 (SIB receiver) + /// [Route("api/[controller]")] [ApiController] public class WitsRecord50Controller : WitsControllerAbstract diff --git a/AsbCloudWebApi/Controllers/WITS/WitsRecord60Controller.cs b/AsbCloudWebApi/Controllers/WITS/WitsRecord60Controller.cs index 292cb0a6..08c796d6 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsRecord60Controller.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsRecord60Controller.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// WITS записи id = 60 (SIB receiver) + /// [Route("api/[controller]")] [ApiController] public class WitsRecord60Controller : WitsControllerAbstract diff --git a/AsbCloudWebApi/Controllers/WITS/WitsRecord61Controller.cs b/AsbCloudWebApi/Controllers/WITS/WitsRecord61Controller.cs index c9a9df55..dc4715c5 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsRecord61Controller.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsRecord61Controller.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// WITS записи id = 61 (SIB receiver) + /// [Route("api/[controller]")] [ApiController] public class WitsRecord61Controller : WitsControllerAbstract diff --git a/AsbCloudWebApi/Controllers/WITS/WitsRecord7Controller.cs b/AsbCloudWebApi/Controllers/WITS/WitsRecord7Controller.cs index 0e32a5f2..05784984 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsRecord7Controller.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsRecord7Controller.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// WITS записи id = 7 + /// [Route("api/[controller]")] [ApiController] public class WitsRecord7Controller : WitsControllerAbstract diff --git a/AsbCloudWebApi/Controllers/WITS/WitsRecord8Controller.cs b/AsbCloudWebApi/Controllers/WITS/WitsRecord8Controller.cs index 08bb7a22..67d59ec8 100644 --- a/AsbCloudWebApi/Controllers/WITS/WitsRecord8Controller.cs +++ b/AsbCloudWebApi/Controllers/WITS/WitsRecord8Controller.cs @@ -6,6 +6,9 @@ using Microsoft.AspNetCore.SignalR; namespace AsbCloudWebApi.Controllers.WITS { + /// + /// WITS записи id = 8 + /// [Route("api/[controller]")] [ApiController] public class WitsRecord8Controller : WitsControllerAbstract diff --git a/AsbCloudWebApi/Controllers/WellCompositeController.cs b/AsbCloudWebApi/Controllers/WellCompositeController.cs index ee3314c5..398530d5 100644 --- a/AsbCloudWebApi/Controllers/WellCompositeController.cs +++ b/AsbCloudWebApi/Controllers/WellCompositeController.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Композитная скважина + /// [Route("api/well/{idWell}/composite")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/WellController.cs b/AsbCloudWebApi/Controllers/WellController.cs index d7c7ef58..f7c57726 100644 --- a/AsbCloudWebApi/Controllers/WellController.cs +++ b/AsbCloudWebApi/Controllers/WellController.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { + /// + /// Инфо о скважине + /// [Route("api/well")] [ApiController] [Authorize] diff --git a/AsbCloudWebApi/Controllers/WellOperationController.cs b/AsbCloudWebApi/Controllers/WellOperationController.cs index 494cf347..e73bb7f0 100644 --- a/AsbCloudWebApi/Controllers/WellOperationController.cs +++ b/AsbCloudWebApi/Controllers/WellOperationController.cs @@ -12,7 +12,7 @@ using System.Threading.Tasks; namespace AsbCloudWebApi.Controllers { /// - /// Контроллер вручную внесенных операций на скважине + /// Буровые операции (вводимые вручную) /// [Route("api/well/{idWell}/wellOperations")] [ApiController] diff --git a/AsbCloudWebApi/DependencyInjection.cs b/AsbCloudWebApi/DependencyInjection.cs index c6442461..f25a5494 100644 --- a/AsbCloudWebApi/DependencyInjection.cs +++ b/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); }); } diff --git a/AsbCloudWebApi/Startup.cs b/AsbCloudWebApi/Startup.cs index 7b536723..0aee0fae 100644 --- a/AsbCloudWebApi/Startup.cs +++ b/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())