feat: Add swagger attribute for sorting

CleanArchitecture.Api/Controllers/TenantController.cs

@@ -1,10 +1,13 @@
 using System;
 using System.Threading.Tasks;
 using CleanArchitecture.Api.Models;
+using CleanArchitecture.Api.Swagger;
 using CleanArchitecture.Application.Interfaces;
+using CleanArchitecture.Application.SortProviders;
 using CleanArchitecture.Application.ViewModels;
 using CleanArchitecture.Application.ViewModels.Sorting;
 using CleanArchitecture.Application.ViewModels.Tenants;
+using CleanArchitecture.Domain.Entities;
 using CleanArchitecture.Domain.Notifications;
 using MediatR;
 using Microsoft.AspNetCore.Authorization;
@@ -34,7 +37,7 @@ public sealed class TenantController : ApiController
         [FromQuery] PageQuery query,
         [FromQuery] string searchTerm = "",
         [FromQuery] bool includeDeleted = false,
-        [FromQuery] SortQuery? sortQuery = null)
+        [FromQuery, SortableFieldsAttribute<TenantViewModelSortProvider, TenantViewModel, Tenant>] SortQuery? sortQuery = null)
     {
         var tenants = await _tenantService.GetAllTenantsAsync(
             query,

CleanArchitecture.Api/Controllers/UserController.cs

@@ -1,10 +1,13 @@
 using System;
 using System.Threading.Tasks;
 using CleanArchitecture.Api.Models;
+using CleanArchitecture.Api.Swagger;
 using CleanArchitecture.Application.Interfaces;
+using CleanArchitecture.Application.SortProviders;
 using CleanArchitecture.Application.ViewModels;
 using CleanArchitecture.Application.ViewModels.Sorting;
 using CleanArchitecture.Application.ViewModels.Users;
+using CleanArchitecture.Domain.Entities;
 using CleanArchitecture.Domain.Notifications;
 using MediatR;
 using Microsoft.AspNetCore.Authorization;
@@ -34,7 +37,7 @@ public sealed class UserController : ApiController
         [FromQuery] PageQuery query,
         [FromQuery] string searchTerm = "",
         [FromQuery] bool includeDeleted = false,
-        [FromQuery] SortQuery? sortQuery = null)
+        [FromQuery, SortableFieldsAttribute<UserViewModelSortProvider, UserViewModel, User>] SortQuery? sortQuery = null)
     {
         var users = await _userService.GetAllUsersAsync(
             query,

CleanArchitecture.Api/Extensions/ServiceCollectionExtension.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using System.Text;
+using CleanArchitecture.Api.Swagger;
 using CleanArchitecture.Domain.Settings;
 using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.Extensions.Configuration;
@@ -34,6 +35,10 @@ public static class ServiceCollectionExtension
                 Scheme = "bearer"
             });
 
+            c.ParameterFilter<SortableFieldsAttributeFilter>();
+
+            c.SupportNonNullableReferenceTypes();
+
             c.AddSecurityRequirement(new OpenApiSecurityRequirement
             {
                 {

CleanArchitecture.Api/Swagger/SortableFieldsAttribute.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using CleanArchitecture.Application.ViewModels.Sorting;
+
+namespace CleanArchitecture.Api.Swagger;
+
+[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false)]
+public sealed class SortableFieldsAttribute<TSortingProvider, TViewModel, TEntity>
+    : SwaggerSortableFieldsAttribute
+    where TSortingProvider : ISortingExpressionProvider<TViewModel, TEntity>, new()
+{
+    public override IEnumerable<string> GetFields()
+    {
+        return new TSortingProvider().GetSortingExpressions().Keys;
+    }
+}

CleanArchitecture.Api/Swagger/SortableFieldsAttributeFilter.cs

@@ -0,0 +1,32 @@
+using System.Linq;
+using System.Reflection;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace CleanArchitecture.Api.Swagger;
+
+public sealed class SortableFieldsAttributeFilter : IParameterFilter
+{
+    public void Apply(OpenApiParameter parameter, ParameterFilterContext context)
+    {
+        if (context.ParameterInfo is null)
+        {
+            return;
+        }
+
+        var attribute = context.ParameterInfo
+            .GetCustomAttributes<SwaggerSortableFieldsAttribute>()
+            .SingleOrDefault();
+
+        if (attribute is null)
+        {
+            return;
+        }
+
+        var description = string.Join("<br/>", attribute.GetFields().Order());
+
+        parameter.Description = $"{parameter.Description}<br/><br/>" +
+            $"**Allowed values:**<br/>{description}";
+    }
+}
+

CleanArchitecture.Api/Swagger/SwaggerSortableFieldsAttribute.cs

@@ -0,0 +1,9 @@
+using System;
+using System.Collections.Generic;
+
+namespace CleanArchitecture.Api.Swagger;
+
+public abstract class SwaggerSortableFieldsAttribute : Attribute
+{
+    public abstract IEnumerable<string> GetFields();
+}

CleanArchitecture.Application/ViewModels/Sorting/SortQuery.cs

@@ -10,6 +10,7 @@ public sealed class SortQuery
 
     public ReadOnlyCollection<SortParameter> Parameters { get; private set; } = new(Array.Empty<SortParameter>());
 
+
     [FromQuery(Name = "order_by")]
     public string? Query
     {