Small refactor (#1116)

* Renamed variables and types to be consistent with JSON:API spec, where the vocabulary is 'RelationshipsObject' with its members being a 'Relationship'.

* Process review feedback, fixed culture issue in test

* fix variable name

* Introduced types for attributes and relationships in resource objects

* Reintroduced 'data' in schema names of resource objects.

Author: maurei

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<ResourceResponseObject<TResource>>
+    internal sealed class NullableSecondaryResourceResponseDocument<TResource> : NullableSingleData<ResourceObjectInResponse<TResource>>
         where TResource : IIdentifiable
     {
         public IDictionary<string, object> Meta { get; set; } = null!;

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/PrimaryResourceResponseDocument.cs

@@ -10,7 +10,7 @@ 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
     // 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 PrimaryResourceResponseDocument<TResource> : SingleData<ResourceResponseObject<TResource>>
+    internal sealed class PrimaryResourceResponseDocument<TResource> : SingleData<ResourceObjectInResponse<TResource>>
         where TResource : IIdentifiable
     {
         public IDictionary<string, object> Meta { get; set; } = null!;

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<ResourceResponseObject<TResource>>
+    internal sealed class ResourceCollectionResponseDocument<TResource> : ManyData<ResourceObjectInResponse<TResource>>
         where TResource : IIdentifiable
     {
         public IDictionary<string, object> Meta { get; set; } = null!;

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePatchRequestDocument.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ResourcePatchRequestDocument<TResource> : SingleData<ResourcePatchRequestObject<TResource>>
+    internal sealed class ResourcePatchRequestDocument<TResource> : SingleData<ResourceObjectInPatchRequest<TResource>>
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePostRequestDocument.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ResourcePostRequestDocument<TResource> : SingleData<ResourcePostRequestObject<TResource>>
+    internal sealed class ResourcePostRequestDocument<TResource> : SingleData<ResourceObjectInPostRequest<TResource>>
         where TResource : IIdentifiable
     {
     }

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<ResourceResponseObject<TResource>>
+    internal sealed class SecondaryResourceResponseDocument<TResource> : SingleData<ResourceObjectInResponse<TResource>>
         where TResource : IIdentifiable
     {
         public IDictionary<string, object> Meta { get; set; } = null!;

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/NonPrimaryDocumentTypeFactory.cs

@@ -1,6 +1,6 @@
 using System;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
-using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
+using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 using JsonApiDotNetCore.Resources.Annotations;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects
@@ -10,8 +10,8 @@ internal sealed class NonPrimaryDocumentTypeFactory
         private static readonly DocumentOpenTypes SecondaryResponseDocumentOpenTypes = new(typeof(ResourceCollectionResponseDocument<>),
             typeof(NullableSecondaryResourceResponseDocument<>), typeof(SecondaryResourceResponseDocument<>));
 
-        private static readonly DocumentOpenTypes RelationshipRequestDocumentOpenTypes = new(typeof(ToManyRelationshipRequestData<>),
-            typeof(NullableToOneRelationshipRequestData<>), typeof(ToOneRelationshipRequestData<>));
+        private static readonly DocumentOpenTypes RelationshipRequestDocumentOpenTypes = new(typeof(ToManyRelationshipInRequest<>),
+            typeof(NullableToOneRelationshipInRequest<>), typeof(ToOneRelationshipInRequest<>));
 
         private static readonly DocumentOpenTypes RelationshipResponseDocumentOpenTypes = new(typeof(ResourceIdentifierCollectionResponseDocument<>),
             typeof(NullableResourceIdentifierResponseDocument<>), typeof(ResourceIdentifierResponseDocument<>));

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipDataTypeFactory.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipTypeFactory.cs

@@ -1,14 +1,14 @@
 using System;
-using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
+using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 using JsonApiDotNetCore.Resources.Annotations;
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects
 {
-    internal sealed class RelationshipDataTypeFactory
+    internal sealed class RelationshipTypeFactory
     {
-        public static RelationshipDataTypeFactory Instance { get; } = new();
+        public static RelationshipTypeFactory Instance { get; } = new();
 
-        private RelationshipDataTypeFactory()
+        private RelationshipTypeFactory()
         {
         }
 
@@ -26,10 +26,10 @@ public Type GetForResponse(RelationshipAttribute relationship)
             // @formatter:nested_ternary_style expanded
 
             Type relationshipDataOpenType = relationship is HasManyAttribute
-                ? typeof(ToManyRelationshipResponseData<>)
+                ? typeof(ToManyRelationshipInResponse<>)
                 : relationship.IsNullable()
-                    ? typeof(NullableToOneRelationshipResponseData<>)
-                    : typeof(ToOneRelationshipResponseData<>);
+                    ? typeof(NullableToOneRelationshipInResponse<>)
+                    : typeof(ToOneRelationshipInResponse<>);
 
             // @formatter:nested_ternary_style restore
 

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/NullableToOneRelationshipRequestData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInRequest.cs

@@ -2,10 +2,10 @@
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
-namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class NullableToOneRelationshipRequestData<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
+    internal sealed class NullableToOneRelationshipInRequest<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/NullableToOneRelationshipResponseData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInResponse.cs

@@ -5,10 +5,10 @@
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
-namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class NullableToOneRelationshipResponseData<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
+    internal sealed class NullableToOneRelationshipInResponse<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
         where TResource : IIdentifiable
     {
         [Required]

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToManyRelationshipRequestData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInRequest.cs

@@ -2,10 +2,10 @@
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
-namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ToManyRelationshipRequestData<TResource> : ManyData<ResourceIdentifierObject<TResource>>
+    internal sealed class ToManyRelationshipInRequest<TResource> : ManyData<ResourceIdentifierObject<TResource>>
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToManyRelationshipResponseData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInResponse.cs

@@ -5,10 +5,10 @@
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
-namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ToManyRelationshipResponseData<TResource> : ManyData<ResourceIdentifierObject<TResource>>
+    internal sealed class ToManyRelationshipInResponse<TResource> : ManyData<ResourceIdentifierObject<TResource>>
         where TResource : IIdentifiable
     {
         [Required]

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToOneRelationshipRequestData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInRequest.cs

@@ -2,10 +2,10 @@
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
-namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ToOneRelationshipRequestData<TResource> : SingleData<ResourceIdentifierObject<TResource>>
+    internal sealed class ToOneRelationshipInRequest<TResource> : SingleData<ResourceIdentifierObject<TResource>>
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToOneRelationshipResponseData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInResponse.cs

@@ -5,10 +5,10 @@
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources;
 
-namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ToOneRelationshipResponseData<TResource> : SingleData<ResourceIdentifierObject<TResource>>
+    internal sealed class ToOneRelationshipInResponse<TResource> : SingleData<ResourceIdentifierObject<TResource>>
         where TResource : IIdentifiable
     {
         [Required]

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/AttributesInPatchRequest.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
+{
+    // ReSharper disable once UnusedTypeParameter
+    internal sealed class AttributesInPatchRequest<TResource>
+        where TResource : IIdentifiable
+    {
+    }
+}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourcePostRequestObject.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/AttributesInPostRequest.cs

@@ -2,7 +2,8 @@
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
 {
-    internal sealed class ResourcePostRequestObject<TResource> : ResourceObject<TResource>
+    // ReSharper disable once UnusedTypeParameter
+    internal sealed class AttributesInPostRequest<TResource>
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourcePatchRequestObject.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/AttributesInResponse.cs

@@ -2,7 +2,8 @@
 
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
 {
-    internal sealed class ResourcePatchRequestObject<TResource> : ResourceObject<TResource>
+    // ReSharper disable once UnusedTypeParameter
+    internal sealed class AttributesInResponse<TResource>
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/RelationshipsInPatchRequest.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
+{
+    // ReSharper disable once UnusedTypeParameter
+    internal sealed class RelationshipsInPatchRequest<TResource>
+        where TResource : IIdentifiable
+    {
+    }
+}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/RelationshipsInPostRequest.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
+{
+    // ReSharper disable once UnusedTypeParameter
+    internal sealed class RelationshipsInPostRequest<TResource>
+        where TResource : IIdentifiable
+    {
+    }
+}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/RelationshipsInResponse.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
+{
+    // ReSharper disable once UnusedTypeParameter
+    internal sealed class RelationshipsInResponse<TResource>
+        where TResource : IIdentifiable
+    {
+    }
+}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceIdentifierObject.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
 {
     // ReSharper disable once UnusedTypeParameter
-    internal class ResourceIdentifierObject<TResource> : ResourceIdentifierObject
+    internal sealed class ResourceIdentifierObject<TResource> : ResourceIdentifierObject
         where TResource : IIdentifiable
     {
     }

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceObject.cs

@@ -0,0 +1,14 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
+{
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
+    internal sealed class ResourceObjectInPatchRequest<TResource> : ResourceIdentifierObject
+        where TResource : IIdentifiable
+    {
+        public AttributesInPatchRequest<TResource> Attributes { get; set; } = null!;
+
+        public RelationshipsInPatchRequest<TResource> Relationships { get; set; } = null!;
+    }
+}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceObjectInPatchRequest.cs

@@ -0,0 +1,14 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
+{
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
+    internal sealed class ResourceObjectInPostRequest<TResource> : ResourceIdentifierObject
+        where TResource : IIdentifiable
+    {
+        public AttributesInPostRequest<TResource> Attributes { get; set; } = null!;
+
+        public RelationshipsInPostRequest<TResource> Relationships { get; set; } = null!;
+    }
+}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceObjectInPostRequest.cs

@@ -7,9 +7,13 @@
 namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    internal sealed class ResourceResponseObject<TResource> : ResourceObject<TResource>
+    internal sealed class ResourceObjectInResponse<TResource> : ResourceIdentifierObject
         where TResource : IIdentifiable
     {
+        public AttributesInResponse<TResource> Attributes { get; set; } = null!;
+
+        public RelationshipsInResponse<TResource> Relationships { get; set; } = null!;
+
         [Required]
         public LinksInResourceObject Links { get; set; } = null!;
 

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceResponseObject.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceObjectInResponse.cs

@@ -6,7 +6,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
-using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
+using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.AspNetCore.Mvc.Controllers;
@@ -32,9 +32,9 @@ internal sealed class JsonApiOperationIdSelector
             [typeof(ResourceIdentifierCollectionResponseDocument<>)] = RelationshipOperationIdTemplate,
             [typeof(ResourceIdentifierResponseDocument<>)] = RelationshipOperationIdTemplate,
             [typeof(NullableResourceIdentifierResponseDocument<>)] = RelationshipOperationIdTemplate,
-            [typeof(ToOneRelationshipRequestData<>)] = RelationshipOperationIdTemplate,
-            [typeof(NullableToOneRelationshipRequestData<>)] = RelationshipOperationIdTemplate,
-            [typeof(ToManyRelationshipRequestData<>)] = RelationshipOperationIdTemplate
+            [typeof(ToOneRelationshipInRequest<>)] = RelationshipOperationIdTemplate,
+            [typeof(NullableToOneRelationshipInRequest<>)] = RelationshipOperationIdTemplate,
+            [typeof(ToManyRelationshipInRequest<>)] = RelationshipOperationIdTemplate
         };
 
         private readonly IControllerResourceMapping _controllerResourceMapping;

src/JsonApiDotNetCore.OpenApi/JsonApiOperationIdSelector.cs

@@ -4,7 +4,7 @@
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
-using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
+using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.AspNetCore.Mvc.Formatters;
 using Microsoft.Net.Http.Headers;
@@ -15,9 +15,9 @@ internal sealed class JsonApiRequestFormatMetadataProvider : IInputFormatter, IA
     {
         private static readonly Type[] JsonApiRequestObjectOpenType =
         {
-            typeof(ToManyRelationshipRequestData<>),
-            typeof(ToOneRelationshipRequestData<>),
-            typeof(NullableToOneRelationshipRequestData<>),
+            typeof(ToManyRelationshipInRequest<>),
+            typeof(ToOneRelationshipInRequest<>),
+            typeof(NullableToOneRelationshipInRequest<>),
             typeof(ResourcePostRequestDocument<>),
             typeof(ResourcePatchRequestDocument<>)
         };