[Swashbuckle] RequiredMemberEvaluator can be configured.

Author: PawelGerr

Directory.Build.props

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Copyright>(c) $([System.DateTime]::Now.Year), Pawel Gerr. All rights reserved.</Copyright>
-    <VersionPrefix>8.8.1</VersionPrefix>
+    <VersionPrefix>8.9.0</VersionPrefix>
     <Authors>Pawel Gerr</Authors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageProjectUrl>https://github.com/PawelGerr/Thinktecture.Runtime.Extensions</PackageProjectUrl>

samples/AspNetCore.Samples/Program.cs

@@ -169,6 +169,8 @@ private static Task StartMinimalWebApiAsync(ILoggerFactory loggerFactory)
 
       var app = builder.Build();
 
+      app.MapSwagger();
+
       var routeGroup = app.MapGroup("/api");
 
       routeGroup.MapGet("category/{category}", (ProductCategory category) => new { Value = category, category.IsValid });

src/Thinktecture.Runtime.Extensions.SourceGenerator/Extensions/NamedTypeSymbolExtensions.cs

@@ -62,7 +62,7 @@ public static IReadOnlyList<ContainingTypeState> GetContainingTypes(
       this INamedTypeSymbol type)
    {
       if (type.ContainingType is null)
-         return Array.Empty<ContainingTypeState>();
+         return [];
 
       var types = new List<ContainingTypeState>();
       var containingType = type.ContainingType;

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/ComplexValueObjects/AllRequiredMemberEvaluator.cs

@@ -0,0 +1,20 @@
+using System.Reflection;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace Thinktecture.Swashbuckle.Internal.ComplexValueObjects;
+
+/// <summary>
+/// This is an internal API that supports the Thinktecture.Runtime.Extensions infrastructure and not subject to
+/// the same compatibility standards as public APIs. It may be changed or removed without notice in
+/// any release. You should only use it directly in your code with extreme caution and knowing that
+/// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
+/// </summary>
+public class AllRequiredMemberEvaluator : IRequiredMemberEvaluator
+{
+   /// <inheritdoc />
+   public bool IsRequired(OpenApiSchema schema, SchemaFilterContext context, MemberInfo member)
+   {
+      return true;
+   }
+}

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/ComplexValueObjects/ComplexValueObjectSchemaFilter.cs

@@ -1,3 +1,8 @@
+using System.ComponentModel.DataAnnotations;
+using System.Reflection;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 using Thinktecture.Internal;
@@ -13,16 +18,21 @@ namespace Thinktecture.Swashbuckle.Internal.ComplexValueObjects;
 public class ComplexValueObjectSchemaFilter : IInternalComplexValueObjectSchemaFilter
 {
    private readonly IRequiredMemberEvaluator _requiredMemberEvaluator;
+   private readonly JsonSerializerOptions _jsonSerializerOptions;
 
    /// <summary>
    /// This is an internal API that supports the Thinktecture.Runtime.Extensions infrastructure and not subject to
    /// the same compatibility standards as public APIs. It may be changed or removed without notice in
    /// any release. You should only use it directly in your code with extreme caution and knowing that
    /// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
    /// </summary>
-   public ComplexValueObjectSchemaFilter(IRequiredMemberEvaluator requiredMemberEvaluator)
+   public ComplexValueObjectSchemaFilter(
+      IServiceProvider serviceProvider,
+      JsonSerializerOptionsResolver jsonSerializerOptionsResolver,
+      IOptions<ThinktectureSchemaFilterOptions> options)
    {
-      _requiredMemberEvaluator = requiredMemberEvaluator;
+      _requiredMemberEvaluator = options.Value.RequiredMemberEvaluator.CreateEvaluator(serviceProvider);
+      _jsonSerializerOptions = jsonSerializerOptionsResolver.JsonSerializerOptions;
    }
 
    /// <inheritdoc />
@@ -39,8 +49,14 @@ public void Apply(OpenApiSchema schema, SchemaFilterContext context, Metadata.Co
    {
       foreach (var memberInfo in metadata.AssignableMembers)
       {
-         if (_requiredMemberEvaluator.IsRequired(schema, context, memberInfo))
-            schema.Required.Add(memberInfo.Name);
+         if (memberInfo.GetCustomAttribute<RequiredAttribute>() is null && _requiredMemberEvaluator.IsRequired(schema, context, memberInfo))
+         {
+            var name = memberInfo.GetCustomAttribute<JsonPropertyNameAttribute>()?.Name
+                       ?? _jsonSerializerOptions.PropertyNamingPolicy?.ConvertName(memberInfo.Name)
+                       ?? memberInfo.Name;
+
+            schema.Required.Add(name);
+         }
       }
    }
 }

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/ComplexValueObjects/NoRequiredMemberEvaluator.cs

@@ -0,0 +1,20 @@
+using System.Reflection;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace Thinktecture.Swashbuckle.Internal.ComplexValueObjects;
+
+/// <summary>
+/// This is an internal API that supports the Thinktecture.Runtime.Extensions infrastructure and not subject to
+/// the same compatibility standards as public APIs. It may be changed or removed without notice in
+/// any release. You should only use it directly in your code with extreme caution and knowing that
+/// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
+/// </summary>
+public class NoRequiredMemberEvaluator : IRequiredMemberEvaluator
+{
+   /// <inheritdoc />
+   public bool IsRequired(OpenApiSchema schema, SchemaFilterContext context, MemberInfo member)
+   {
+      return false;
+   }
+}

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/SmartEnums/AllOfSmartEnumSchemaFilter.cs

@@ -1,3 +1,4 @@
+using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 
 namespace Thinktecture.Swashbuckle.Internal.SmartEnums;
@@ -17,9 +18,10 @@ public class AllOfSmartEnumSchemaFilter : SmartEnumSchemaFilterBase
    /// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
    /// </summary>
    public AllOfSmartEnumSchemaFilter(
+      IServiceProvider serviceProvider,
       IOpenApiValueFactoryProvider valueFactoryProvider,
-      ISmartEnumSchemaExtension extension)
-      : base(valueFactoryProvider, extension)
+      IOptions<ThinktectureSchemaFilterOptions> options)
+      : base(serviceProvider, valueFactoryProvider, options)
    {
    }
 

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/SmartEnums/AnyOfSmartEnumSchemaFilter.cs

@@ -1,3 +1,4 @@
+using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 
 namespace Thinktecture.Swashbuckle.Internal.SmartEnums;
@@ -17,9 +18,10 @@ public class AnyOfSmartEnumSchemaFilter : SmartEnumSchemaFilterBase
    /// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
    /// </summary>
    public AnyOfSmartEnumSchemaFilter(
+      IServiceProvider serviceProvider,
       IOpenApiValueFactoryProvider valueFactoryProvider,
-      ISmartEnumSchemaExtension extension)
-      : base(valueFactoryProvider, extension)
+      IOptions<ThinktectureSchemaFilterOptions> options)
+      : base(serviceProvider, valueFactoryProvider, options)
    {
    }
 

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/SmartEnums/DefaultSmartEnumSchemaFilter.cs

@@ -1,3 +1,4 @@
+using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 
 namespace Thinktecture.Swashbuckle.Internal.SmartEnums;
@@ -17,9 +18,10 @@ public class DefaultSmartEnumSchemaFilter : SmartEnumSchemaFilterBase
    /// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
    /// </summary>
    public DefaultSmartEnumSchemaFilter(
+      IServiceProvider serviceProvider,
       IOpenApiValueFactoryProvider valueFactoryProvider,
-      ISmartEnumSchemaExtension extension)
-      : base(valueFactoryProvider, extension)
+      IOptions<ThinktectureSchemaFilterOptions> options)
+      : base(serviceProvider, valueFactoryProvider, options)
    {
    }
 

src/Thinktecture.Runtime.Extensions.Swashbuckle/Swashbuckle/Internal/SmartEnums/OneOfSmartEnumSchemaFilter.cs

@@ -1,3 +1,4 @@
+using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 
 namespace Thinktecture.Swashbuckle.Internal.SmartEnums;
@@ -17,9 +18,10 @@ public class OneOfSmartEnumSchemaFilter : SmartEnumSchemaFilterBase
    /// doing so can result in application failures when updating to a new Thinktecture.Runtime.Extensions release.
    /// </summary>
    public OneOfSmartEnumSchemaFilter(
+      IServiceProvider serviceProvider,
       IOpenApiValueFactoryProvider valueFactoryProvider,
-      ISmartEnumSchemaExtension extension)
-      : base(valueFactoryProvider, extension)
+      IOptions<ThinktectureSchemaFilterOptions> options)
+      : base(serviceProvider, valueFactoryProvider, options)
    {
    }