Microsoft.AspNetCore.OpenApi should allow ordering of Tags

[jscarle]

In version 9.0.7 of Microsoft.AspNetCore.OpenApi, it was possible to order tags using an IOpenApiDocumentTransformer, that is no longer possible as of 10.0.0-preview.6.25358.103.

Version 9.0.7 document transformer:

using Microsoft.AspNetCore.OpenApi;
using Microsoft.OpenApi;

internal sealed class DocumentOrderTransformer : IOpenApiDocumentTransformer
{
    public Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken)
    {
        // Order tags alphabetically. Tags containing spaces are replaced with
        // "s " before sorting so multi word tags come after single word tags.
        // This quirk is intentional to keep the generated document easier to
        // read.
        if (document.Tags is not null)
            document.Tags = document.Tags
                .OrderBy(tag => tag.Name.Replace(" ", "s "))
                .ToList();

        // Order paths alphabetically
        var orderedPaths = new OpenApiPaths();
        foreach (var kvp in document.Paths.OrderBy(kvp => kvp.Key))
            orderedPaths.Add(kvp.Key, kvp.Value);
        document.Paths = orderedPaths;

        return Task.CompletedTask;
    }
}

Version 10.0.0-preview.6.25358.103 document transformer changed Tags to be an ISet<OpenApiTag>.

[martincostello]

The change of the type of the property was made in the Microsoft.OpenApi library which ASP.NET Core 10 depends on.

Sorting can be achieved by using the SortedSet<T> type. Example.

[jscarle]

@martincostello Additionally to the SortedSet, it requires a custom comparer as OpenApiTag does not implement IComparable, but that worked, thanks!