Declare Data properties as members instead of via base type

bkoelman · bkoelman · commit 1ec31d23570b · 2024-03-30T00:21:23.000+01:00
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/NullableResourceIdentifierResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/NullableResourceIdentifierResponseDocument.cs
@@ -7,10 +7,10 @@
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
-// Types in the current namespace are never touched by ASP.NET ModelState validation, therefore using a non-nullable reference type for a property does not
+// Types in the JsonApiObjects namespace are never touched by ASP.NET ModelState validation, therefore using a non-nullable reference type for a property does not
 // imply this property is required. Instead, we use [Required] explicitly, because this is how Swashbuckle is instructed to mark properties as required.
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class NullableResourceIdentifierResponseDocument<TResource> : NullableSingleData<ResourceIdentifier<TResource>>
+internal sealed class NullableResourceIdentifierResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -20,6 +20,10 @@ internal sealed class NullableResourceIdentifierResponseDocument<TResource> : Nu
     [JsonPropertyName("links")]
     public ResourceIdentifierTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceIdentifier<TResource>? Data { get; set; }
+
     [JsonPropertyName("meta")]
     public IDictionary<string, object> Meta { get; set; } = null!;
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/NullableSecondaryResourceResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/NullableSecondaryResourceResponseDocument.cs
@@ -8,7 +8,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class NullableSecondaryResourceResponseDocument<TResource> : NullableSingleData<ResourceDataInResponse<TResource>>
+internal sealed class NullableSecondaryResourceResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -18,6 +18,10 @@ internal sealed class NullableSecondaryResourceResponseDocument<TResource> : Nul
     [JsonPropertyName("links")]
     public ResourceTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceDataInResponse<TResource>? Data { get; set; }
+
     [JsonPropertyName("included")]
     public IList<ResourceData> Included { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/PrimaryResourceResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/PrimaryResourceResponseDocument.cs
@@ -8,7 +8,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class PrimaryResourceResponseDocument<TResource> : SingleData<ResourceDataInResponse<TResource>>
+internal sealed class PrimaryResourceResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -18,6 +18,10 @@ internal sealed class PrimaryResourceResponseDocument<TResource> : SingleData<Re
     [JsonPropertyName("links")]
     public ResourceTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceDataInResponse<TResource> Data { get; set; } = null!;
+
     [JsonPropertyName("included")]
     public IList<ResourceData> Included { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceCollectionResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceCollectionResponseDocument.cs
@@ -8,7 +8,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ResourceCollectionResponseDocument<TResource> : ManyData<ResourceDataInResponse<TResource>>
+internal sealed class ResourceCollectionResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -18,6 +18,10 @@ internal sealed class ResourceCollectionResponseDocument<TResource> : ManyData<R
     [JsonPropertyName("links")]
     public ResourceCollectionTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ICollection<ResourceDataInResponse<TResource>> Data { get; set; } = null!;
+
     [JsonPropertyName("included")]
     public IList<ResourceData> Included { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceIdentifierCollectionResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceIdentifierCollectionResponseDocument.cs
@@ -8,7 +8,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ResourceIdentifierCollectionResponseDocument<TResource> : ManyData<ResourceIdentifier<TResource>>
+internal sealed class ResourceIdentifierCollectionResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -18,6 +18,10 @@ internal sealed class ResourceIdentifierCollectionResponseDocument<TResource> :
     [JsonPropertyName("links")]
     public ResourceIdentifierCollectionTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ICollection<ResourceIdentifier<TResource>> Data { get; set; } = null!;
+
     [JsonPropertyName("meta")]
     public IDictionary<string, object> Meta { get; set; } = null!;
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceIdentifierResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceIdentifierResponseDocument.cs
@@ -8,7 +8,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ResourceIdentifierResponseDocument<TResource> : SingleData<ResourceIdentifier<TResource>>
+internal sealed class ResourceIdentifierResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -18,6 +18,10 @@ internal sealed class ResourceIdentifierResponseDocument<TResource> : SingleData
     [JsonPropertyName("links")]
     public ResourceIdentifierTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceIdentifier<TResource> Data { get; set; } = null!;
+
     [JsonPropertyName("meta")]
     public IDictionary<string, object> Meta { get; set; } = null!;
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePatchRequestDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePatchRequestDocument.cs
@@ -1,9 +1,16 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ResourcePatchRequestDocument<TResource> : SingleData<ResourceDataInPatchRequest<TResource>>
-    where TResource : IIdentifiable;
+internal sealed class ResourcePatchRequestDocument<TResource>
+    where TResource : IIdentifiable
+{
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceDataInPatchRequest<TResource> Data { get; set; } = null!;
+}
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePostRequestDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePostRequestDocument.cs
@@ -1,9 +1,16 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ResourcePostRequestDocument<TResource> : SingleData<ResourceDataInPostRequest<TResource>>
-    where TResource : IIdentifiable;
+internal sealed class ResourcePostRequestDocument<TResource>
+    where TResource : IIdentifiable
+{
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceDataInPostRequest<TResource> Data { get; set; } = null!;
+}
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/SecondaryResourceResponseDocument.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/SecondaryResourceResponseDocument.cs
@@ -8,7 +8,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class SecondaryResourceResponseDocument<TResource> : SingleData<ResourceDataInResponse<TResource>>
+internal sealed class SecondaryResourceResponseDocument<TResource>
     where TResource : IIdentifiable
 {
     [JsonPropertyName("jsonapi")]
@@ -18,6 +18,10 @@ internal sealed class SecondaryResourceResponseDocument<TResource> : SingleData<
     [JsonPropertyName("links")]
     public ResourceTopLevelLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceDataInResponse<TResource> Data { get; set; } = null!;
+
     [JsonPropertyName("included")]
     public IList<ResourceData> Included { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ManyData.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ManyData.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/NullableSingleData.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/NullableSingleData.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInRequest.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInRequest.cs
@@ -1,9 +1,16 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class NullableToOneRelationshipInRequest<TResource> : NullableSingleData<ResourceIdentifier<TResource>>
-    where TResource : IIdentifiable;
+internal sealed class NullableToOneRelationshipInRequest<TResource>
+    where TResource : IIdentifiable
+{
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceIdentifier<TResource>? Data { get; set; }
+}
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInResponse.cs
@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Links;
@@ -7,13 +8,17 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class NullableToOneRelationshipInResponse<TResource> : NullableSingleData<ResourceIdentifier<TResource>>
+internal sealed class NullableToOneRelationshipInResponse<TResource>
     where TResource : IIdentifiable
 {
     // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public RelationshipLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceIdentifier<TResource>? Data { get; set; }
+
     [JsonPropertyName("meta")]
     public IDictionary<string, object> Meta { get; set; } = null!;
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInRequest.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInRequest.cs
@@ -1,9 +1,16 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ToManyRelationshipInRequest<TResource> : ManyData<ResourceIdentifier<TResource>>
-    where TResource : IIdentifiable;
+internal sealed class ToManyRelationshipInRequest<TResource>
+    where TResource : IIdentifiable
+{
+    [Required]
+    [JsonPropertyName("data")]
+    public ICollection<ResourceIdentifier<TResource>> Data { get; set; } = null!;
+}
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInResponse.cs
@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Links;
@@ -7,13 +8,17 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ToManyRelationshipInResponse<TResource> : ManyData<ResourceIdentifier<TResource>>
+internal sealed class ToManyRelationshipInResponse<TResource>
     where TResource : IIdentifiable
 {
     // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public RelationshipLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ICollection<ResourceIdentifier<TResource>> Data { get; set; } = null!;
+
     [JsonPropertyName("meta")]
     public IDictionary<string, object> Meta { get; set; } = null!;
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInRequest.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInRequest.cs
@@ -1,9 +1,16 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ToOneRelationshipInRequest<TResource> : SingleData<ResourceIdentifier<TResource>>
-    where TResource : IIdentifiable;
+internal sealed class ToOneRelationshipInRequest<TResource>
+    where TResource : IIdentifiable
+{
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceIdentifier<TResource> Data { get; set; } = null!;
+}
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInResponse.cs
@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Links;
@@ -7,13 +8,17 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-internal sealed class ToOneRelationshipInResponse<TResource> : SingleData<ResourceIdentifier<TResource>>
+internal sealed class ToOneRelationshipInResponse<TResource>
     where TResource : IIdentifiable
 {
     // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public RelationshipLinks Links { get; set; } = null!;
 
+    [Required]
+    [JsonPropertyName("data")]
+    public ResourceIdentifier<TResource> Data { get; set; } = null!;
+
     [JsonPropertyName("meta")]
     public IDictionary<string, object> Meta { get; set; } = null!;
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/SingleData.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/SingleData.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiPropertyName.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiPropertyName.cs
@@ -11,7 +11,5 @@ internal static class JsonApiPropertyName
     public const string Id = "id";
     public const string Attributes = "attributes";
     public const string Relationships = "relationships";
-    public const string Errors = "errors";
-    public const string Included = "included";
     public const string Meta = "meta";
 }
diff --git a/src/JsonApiDotNetCore.OpenApi/OpenApiSchemaExtensions.cs b/src/JsonApiDotNetCore.OpenApi/OpenApiSchemaExtensions.cs
@@ -4,29 +4,6 @@ namespace JsonApiDotNetCore.OpenApi;
 
 internal static class OpenApiSchemaExtensions
 {
-    public static void ReorderProperties(this OpenApiSchema fullSchema, IEnumerable<string> propertyNamesInOrder)
-    {
-        ArgumentGuard.NotNull(fullSchema);
-        ArgumentGuard.NotNull(propertyNamesInOrder);
-
-        var propertiesInOrder = new Dictionary<string, OpenApiSchema>();
-
-        foreach (string propertyName in propertyNamesInOrder)
-        {
-            if (fullSchema.Properties.TryGetValue(propertyName, out OpenApiSchema? schema))
-            {
-                propertiesInOrder.Add(propertyName, schema);
-            }
-        }
-
-        if (fullSchema.Properties.Count != propertiesInOrder.Count)
-        {
-            throw new UnreachableCodeException();
-        }
-
-        fullSchema.Properties = propertiesInOrder;
-    }
-
     public static OpenApiSchema UnwrapExtendedReferenceSchema(this OpenApiSchema source)
     {
         ArgumentGuard.NotNull(source);
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/DocumentSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/DocumentSchemaGenerator.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiDataContractResolver.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiDataContractResolver.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceDataSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceDataSchemaGenerator.cs
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldSchemaBuilder.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldSchemaBuilder.cs
