serega404/SfeduSchedule
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Фикс документации

Browse Source
This commit is contained in:
Sergey Karmanov
2025-09-22 22:51:22 +03:00
parent 36cc3ba242
commit 8cb78cd208
3 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
SfeduSchedule.Plugin.Abstractions/SfeduSchedule.Plugin.Abstractions.csproj
View File

@@ -7,4 +7,8 @@
<OutputType>Library</OutputType> <OutputType>Library</OutputType>
</PropertyGroup> </PropertyGroup>
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);CS1591;CS1573</NoWarn>
</PropertyGroup>
</Project> </Project>

2
SfeduSchedule/Controllers/SfeduController.cs
View File

@@ -16,7 +16,7 @@ namespace SfeduSchedule.Controllers
/// <summary> /// <summary>
/// Получить GUID пользователя через авторизацию Microsoft. /// Получить GUID пользователя через авторизацию Microsoft.
/// </summary> /// </summary>
/// <param name="redirectUri">Необязательный параметр. Если указан, произойдет редирект на указанный URI после получения GUID. (<url>/?guid=XXX)</param> /// <param name="redirectUri">Необязательный параметр. Если указан, произойдет редирект на указанный URI после получения GUID. ([url]/?guid=XXX)</param>
/// <returns>Строка GUID пользователя или редирект на указанный URI.</returns> /// <returns>Строка GUID пользователя или редирект на указанный URI.</returns>
/// <response code="200">Возвращает GUID пользователя</response> /// <response code="200">Возвращает GUID пользователя</response>
/// <response code="302">Редирект на указанный URI</response> /// <response code="302">Редирект на указанный URI</response>

10
SfeduSchedule/Program.cs
View File

@@ -92,9 +92,13 @@ if (string.IsNullOrEmpty(preinstalledJwtToken))
builder.Services.AddEndpointsApiExplorer(); builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(options => builder.Services.AddSwaggerGen(options =>
{ {
var xmlFile = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml"; var mainXmlFile = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); var mainXmlPath = Path.Combine(AppContext.BaseDirectory, mainXmlFile);
options.IncludeXmlComments(xmlPath); options.IncludeXmlComments(mainXmlPath);
var pluginXmlFile = "SfeduSchedule.Plugin.Abstractions.xml";
var pluginXmlPath = Path.Combine(AppContext.BaseDirectory, pluginXmlFile);
options.IncludeXmlComments(pluginXmlPath);
// Добавляем только схему авторизации по ApiKey // Добавляем только схему авторизации по ApiKey
options.AddSecurityDefinition(ApiKeyAuthenticationDefaults.Scheme, new Microsoft.OpenApi.Models.OpenApiSecurityScheme options.AddSecurityDefinition(ApiKeyAuthenticationDefaults.Scheme, new Microsoft.OpenApi.Models.OpenApiSecurityScheme