Skip to content

Add new schema filter to exclude nullable fields from required #23

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

Closed
wants to merge 1 commit into from
Closed

Add new schema filter to exclude nullable fields from required #23

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
10 changes: 9 additions & 1 deletion src/Bss.Platform.Api.Documentation/DependencyInjection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ public static IServiceCollection AddPlatformApiDocumentation(
this IServiceCollection services,
IWebHostEnvironment hostEnvironment,
string title = "API",
Action<SwaggerGenOptions>? setupAction = null)
Action<SwaggerGenOptions>? setupAction = null,
bool enableExperimentalRequiredFeature = false)
{
if (hostEnvironment.IsProduction())
{
Expand All @@ -32,6 +33,13 @@ public static IServiceCollection AddPlatformApiDocumentation(
{
x.SwaggerDoc("api", new OpenApiInfo { Title = title });
x.SchemaFilter<XEnumNamesSchemaFilter>();

if (enableExperimentalRequiredFeature)
{
x.SupportNonNullableReferenceTypes();
x.NonNullableReferenceTypesAsRequired();
x.SchemaFilter<ExcludeNullableFromRequiredSchemaFilter>();
}

x.AddSecurityDefinition(
AuthorizationScheme,
Expand Down
34 changes: 34 additions & 0 deletions src/Bss.Platform.Api.Documentation/SchemaFilters/ExcludeNullableFromRequiredSchemaFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
using Microsoft.OpenApi.Models;

using Swashbuckle.AspNetCore.SwaggerGen;

namespace Bss.Platform.Api.Documentation.SchemaFilters;

/// <summary>
/// Exclude nullable property from required.
/// Needed for supporting correct front-end code generation by GenGen https://github.com/Luxoft/gengen
/// Additional to https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2036
/// </summary>
public class ExcludeNullableFromRequiredSchemaFilter : ISchemaFilter
{
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
if (schema.Required.Count == 0)
{
return;
}

var nullableProperties = context.Type.GetProperties()
.Where(x => !x.IsNonNullableReferenceType())
.Select(x => x.Name);

var requiredNullableProperty = schema.Required
.Intersect(nullableProperties, StringComparer.OrdinalIgnoreCase)
.ToArray();

foreach (var property in requiredNullableProperty)
{
schema.Required.Remove(property);
}
}
}
6 changes: 3 additions & 3 deletions src/__SolutionItems/CommonAssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[assembly: AssemblyCompany("Luxoft")]
[assembly: AssemblyCopyright("Copyright © Luxoft 2024")]

[assembly: AssemblyVersion("1.5.7.0")]
[assembly: AssemblyFileVersion("1.5.7.0")]
[assembly: AssemblyInformationalVersion("1.5.7.0")]
[assembly: AssemblyVersion("1.5.8.0")]
[assembly: AssemblyFileVersion("1.5.8.0")]
[assembly: AssemblyInformationalVersion("1.5.8.0")]

#if DEBUG
[assembly: AssemblyConfiguration("Debug")]
Expand Down