Skip to content

add tag ordering transformer and update OpenAPI options #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HaikAsatryan merged 1 commit into from
Oct 18, 2025
Merged

add tag ordering transformer and update OpenAPI options #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/SharedKernel/OpenApi/OpenApiExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public static WebApplicationBuilder AddOpenApi(this WebApplicationBuilder builde
options.AddDocument(document, openApiConfiguration);
options.AddSchemaTransformer<EnumSchemaTransformer>();
options.UseApiSecuritySchemes(openApiConfiguration);
options.AddDocumentTransformer<TagOrderingTransformer>();
configureOptions?.Invoke(options);
});
}
Expand Down
52 changes: 52 additions & 0 deletions src/SharedKernel/OpenApi/TagOrderingTransformer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
using Microsoft.AspNetCore.OpenApi;
using Microsoft.OpenApi.Models;

namespace SharedKernel.OpenApi;

internal sealed class TagOrderingTransformer : IOpenApiDocumentTransformer
{
public Task TransformAsync(OpenApiDocument document,
OpenApiDocumentTransformerContext context,
CancellationToken cancellationToken)
{
var tags = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
foreach (var path in document.Paths.Values)
{
foreach (var op in path.Operations.Values)
{
foreach (var t in op.Tags ?? [])
{
tags.Add(t.Name);
}
}
}

var ordered = tags.OrderBy(t => t, StringComparer.OrdinalIgnoreCase)
.ToList();

document.Tags = ordered.Select(t => new OpenApiTag
{
Name = t
})
.ToList();

var index = document.Tags
.Select((t, i) => (t.Name, i))
.ToDictionary(x => x.Name, x => x.i, StringComparer.OrdinalIgnoreCase);

foreach (var path in document.Paths.Values)
{
foreach (var op in path.Operations.Values)
{
if (op.Tags is { Count: > 1 })
{
op.Tags = op.Tags
.OrderBy(t => index[t.Name])
.ToList();
}
}
}

return Task.CompletedTask;
}
}
1 change: 1 addition & 0 deletions src/SharedKernel/OpenApi/UiExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ internal static WebApplication MapScalarUi(this WebApplication app, OpenApiConfi
{
options.Theme = ScalarTheme.Kepler;
options.Favicon = "/swagger-resources/favicon.svg";
options.SortTagsAlphabetically();

foreach (var document in openApiConfigConfiguration.Documents)
{
Expand Down
69 changes: 34 additions & 35 deletions src/SharedKernel/SharedKernel.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,51 +14,50 @@
<PackageTags>Pandatech, shared kernel, library, OpenAPI, Swagger, utilities, scalar</PackageTags>
<Description>Pandatech.SharedKernel provides centralized configurations, utilities, and extensions for ASP.NET Core projects. For more information refere to readme.md document.</Description>
<RepositoryUrl>https://github.com/PandaTechAM/be-lib-sharedkernel</RepositoryUrl>
<PackageReleaseNotes>nuget updates</PackageReleaseNotes>
<PackageReleaseNotes>tag ordering added to open api</PackageReleaseNotes>
</PropertyGroup>

<ItemGroup>
<None Include="..\..\pandatech.png" Pack="true" PackagePath="\" />
<None Include="..\..\Readme.md" Pack="true" PackagePath="\" />
<None Include="..\..\pandatech.png" Pack="true" PackagePath="\"/>
<None Include="..\..\Readme.md" Pack="true" PackagePath="\"/>
</ItemGroup>

<ItemGroup>
<EmbeddedResource Include="OpenApi\UiAssets\**\*" />
<EmbeddedResource Include="OpenApi\UiAssets\**\*"/>
</ItemGroup>

<ItemGroup>
<PackageReference Include="AspNetCore.HealthChecks.Prometheus.Metrics" Version="9.0.0" />
<PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="9.0.0" />
<PackageReference Include="Elastic.CommonSchema.Serilog" Version="9.0.0" />
<PackageReference Include="FluentDateTime" Version="3.0.0" />
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.0.0" />
<PackageReference Include="HtmlSanitizer" Version="9.0.886" />
<PackageReference Include="MediatR" Version="[12.5.0]" />
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8" />
<PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="9.0.8" />
<PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="9.0.8" />
<PackageReference Include="Microsoft.AspNetCore.SignalR.StackExchangeRedis" Version="9.0.8" />
<PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="9.8.0" />
<PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.12.0" />
<PackageReference Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" Version="1.8.0-rc.1" />
<PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.12.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.12.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" Version="1.0.0-beta.12" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.12.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.12.0" />
<PackageReference Include="Pandatech.CommissionCalculator" Version="4.0.1" />
<PackageReference Include="AspNetCore.HealthChecks.Prometheus.Metrics" Version="9.0.0"/>
<PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="9.0.0"/>
<PackageReference Include="Elastic.CommonSchema.Serilog" Version="9.0.0"/>
<PackageReference Include="FluentDateTime" Version="3.0.0"/>
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.0.0"/>
<PackageReference Include="HtmlSanitizer" Version="9.0.886"/>
<PackageReference Include="MediatR" Version="[12.5.0]"/>
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8"/>
<PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="9.0.8"/>
<PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="9.0.8"/>
<PackageReference Include="Microsoft.AspNetCore.SignalR.StackExchangeRedis" Version="9.0.8"/>
<PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="9.8.0"/>
<PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.12.0"/>
<PackageReference Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" Version="1.8.0-rc.1"/>
<PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.12.0"/>
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.12.0"/>
<PackageReference Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" Version="1.0.0-beta.12"/>
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.12.0"/>
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.12.0"/>
<PackageReference Include="Pandatech.Crypto" Version="6.1.1" />
<PackageReference Include="Pandatech.DistributedCache" Version="4.0.9" />
<PackageReference Include="PandaTech.FileExporter" Version="4.1.2" />
<PackageReference Include="PandaTech.FluentImporter" Version="3.0.9" />
<PackageReference Include="Pandatech.FluentMinimalApiMapper" Version="2.0.4" />
<PackageReference Include="Pandatech.PandaVaultClient" Version="4.0.6" />
<PackageReference Include="Pandatech.ResponseCrafter" Version="5.2.2" />
<PackageReference Include="Scalar.AspNetCore" Version="2.8.5" />
<PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
<PackageReference Include="Serilog.Sinks.Async" Version="2.1.0" />
<PackageReference Include="Serilog.Sinks.Grafana.Loki" Version="8.3.1" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
<PackageReference Include="Pandatech.DistributedCache" Version="4.0.9"/>
<PackageReference Include="PandaTech.FileExporter" Version="4.1.2"/>
<PackageReference Include="PandaTech.FluentImporter" Version="3.0.9"/>
<PackageReference Include="Pandatech.FluentMinimalApiMapper" Version="2.0.4"/>
<PackageReference Include="Pandatech.PandaVaultClient" Version="4.0.6"/>
<PackageReference Include="Pandatech.ResponseCrafter" Version="5.2.2"/>
<PackageReference Include="Scalar.AspNetCore" Version="2.9.0" />
<PackageReference Include="Serilog.AspNetCore" Version="9.0.0"/>
<PackageReference Include="Serilog.Sinks.Async" Version="2.1.0"/>
<PackageReference Include="Serilog.Sinks.Grafana.Loki" Version="8.3.1"/>
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
</ItemGroup>

</Project>