removed JsonApiObjectNullabilityProcessor and enabled NRT support in …

…Swashbuckle.
json-api-dotnet · Nov 8, 2021 · f1d0bcd · f1d0bcd
1 parent bf841f9
commit f1d0bcd
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 166 deletions.
diff --git a/src/JsonApiDotNetCore.OpenApi/ServiceCollectionExtensions.cs b/src/JsonApiDotNetCore.OpenApi/ServiceCollectionExtensions.cs
@@ -66,6 +66,7 @@ private static void AddSwaggerGenerator(IServiceScope scope, IServiceCollection
 
             services.AddSwaggerGen(swaggerGenOptions =>
             {
+                swaggerGenOptions.SupportNonNullableReferenceTypes();
                 SetOperationInfo(swaggerGenOptions, controllerResourceMapping, namingPolicy);
                 SetSchemaIdSelector(swaggerGenOptions, resourceGraph, resourceNameFormatter);
                 swaggerGenOptions.DocumentFilter<EndpointOrderingFilter>();

diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiObjectNullabilityProcessor.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiObjectNullabilityProcessor.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiSchemaGenerator.cs
@@ -28,16 +28,9 @@ internal sealed class JsonApiSchemaGenerator : ISchemaGenerator
             typeof(SecondaryResourceResponseDocument<>)
         };
 
-        private static readonly Type[] JsonApiResourceIdentifierDocumentOpenTypes =
-        {
-            typeof(ResourceIdentifierCollectionResponseDocument<>),
-            typeof(ResourceIdentifierResponseDocument<>)
-        };
-
         private readonly ISchemaGenerator _defaultSchemaGenerator;
         private readonly ResourceObjectSchemaGenerator _resourceObjectSchemaGenerator;
         private readonly NullableReferenceSchemaGenerator _nullableReferenceSchemaGenerator;
-        private readonly JsonApiObjectNullabilityProcessor _jsonApiObjectNullabilityProcessor;
         private readonly SchemaRepositoryAccessor _schemaRepositoryAccessor = new();
 
         public JsonApiSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceGraph resourceGraph, IJsonApiOptions options)
@@ -48,7 +41,6 @@ public JsonApiSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceG
 
             _defaultSchemaGenerator = defaultSchemaGenerator;
             _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(_schemaRepositoryAccessor);
-            _jsonApiObjectNullabilityProcessor = new JsonApiObjectNullabilityProcessor(_schemaRepositoryAccessor);
             _resourceObjectSchemaGenerator = new ResourceObjectSchemaGenerator(defaultSchemaGenerator, resourceGraph, options, _schemaRepositoryAccessor);
         }
 
@@ -73,11 +65,6 @@ public OpenApiSchema GenerateSchema(Type type, SchemaRepository schemaRepository
                 SetDataObjectSchemaToNullable(schema);
             }
 
-            if (IsJsonApiDocument(type))
-            {
-                RemoveNotApplicableNullability(schema);
-            }
-
             return schema;
         }
 
@@ -86,16 +73,6 @@ private static bool IsJsonApiResourceDocument(Type type)
             return type.IsConstructedGenericType && JsonApiResourceDocumentOpenTypes.Contains(type.GetGenericTypeDefinition());
         }
 
-        private static bool IsJsonApiDocument(Type type)
-        {
-            return IsJsonApiResourceDocument(type) || IsJsonApiResourceIdentifierDocument(type);
-        }
-
-        private static bool IsJsonApiResourceIdentifierDocument(Type type)
-        {
-            return type.IsConstructedGenericType && JsonApiResourceIdentifierDocumentOpenTypes.Contains(type.GetGenericTypeDefinition());
-        }
-
         private OpenApiSchema GenerateResourceJsonApiDocumentSchema(Type type)
         {
             Type resourceObjectType = type.BaseType!.GenericTypeArguments[0];
@@ -141,10 +118,5 @@ private static OpenApiSchema CreateArrayTypeDataSchema(OpenApiSchema referenceSc
                 Type = "array"
             };
         }
-
-        private void RemoveNotApplicableNullability(OpenApiSchema schema)
-        {
-            _jsonApiObjectNullabilityProcessor.ClearDocumentProperties(schema);
-        }
     }
 }
diff --git a/test/OpenApiTests/LegacyOpenApiIntegration/Airplane.cs b/test/OpenApiTests/LegacyOpenApiIntegration/Airplane.cs
@@ -17,7 +17,7 @@ public sealed class Airplane : Identifiable<string>
 
         [Attr(Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowCreate | AttrCapabilities.AllowChange)]
         [MaxLength(16)]
-        public string SerialNumber { get; set; } = null!;
+        public string? SerialNumber { get; set; }
 
         [Attr(Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowCreate | AttrCapabilities.AllowChange)]
         public int? AirtimeInHours { get; set; }
@@ -33,7 +33,7 @@ public sealed class Airplane : Identifiable<string>
 
         [Attr(Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowChange)]
         [MaxLength(85)]
-        public string ManufacturedInCity { get; set; } = null!;
+        public string? ManufacturedInCity { get; set; }
 
         [Attr(Capabilities = AttrCapabilities.AllowView)]
         public AircraftKind Kind { get; set; }

diff --git a/test/OpenApiTests/LegacyOpenApiIntegration/Flight.cs b/test/OpenApiTests/LegacyOpenApiIntegration/Flight.cs
@@ -18,7 +18,7 @@ public sealed class Flight : Identifiable<string>
 
         [Attr(Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowChange)]
         [MaxLength(2000)]
-        public string StopOverDestination { get; set; } = null!;
+        public string? StopOverDestination { get; set; }
 
         [Attr(PublicName = "operated-by", Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowChange)]
         public Airline Airline { get; set; }
@@ -37,7 +37,7 @@ public sealed class Flight : Identifiable<string>
 
         [Attr]
         [NotMapped]
-        public ICollection<string> ServicesOnBoard { get; set; } = null!;
+        public ICollection<string>? ServicesOnBoard { get; set; }
 
         [HasMany]
         public ICollection<Passenger> Passengers { get; set; } = null!;

diff --git a/test/OpenApiTests/LegacyOpenApiIntegration/Passenger.cs b/test/OpenApiTests/LegacyOpenApiIntegration/Passenger.cs
@@ -14,7 +14,7 @@ public sealed class Passenger : Identifiable<string>
         public string PassportNumber { get; set; } = null!;
 
         [Attr]
-        public string FullName { get; set; } = null!;
+        public string? FullName { get; set; }
 
         [Attr]
         public CabinArea CabinArea { get; set; }