chore: finishing touches comments serialization

Author: maurei

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -13,6 +13,7 @@
 using JsonApiDotNetCore.Serialization;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
+
 namespace JsonApiDotNetCore.Data
 {
     /// <summary>

src/JsonApiDotNetCore/DependencyInjection/ServiceLocator.cs

@@ -218,7 +218,7 @@ public static void AddJsonApiInternals(
             services.AddScoped<IFieldsToSerialize, FieldsToSerialize>();
 
             AddServerSerialization(services);
-            AddClientSerialization(services);
+
             if (jsonApiOptions.EnableResourceHooks)
                 AddResourceHooks(services);
 
@@ -244,11 +244,15 @@ private static void AddServerSerialization(IServiceCollection services)
             services.AddScoped(typeof(IMetaBuilder<>), typeof(MetaBuilder<>));
             services.AddScoped(typeof(ResponseSerializer<>));
             services.AddScoped(sp => sp.GetRequiredService<IJsonApiSerializerFactory>().GetSerializer());
-
             services.AddScoped<IResourceObjectBuilder, ResponseResourceObjectBuilder>();
         }
 
-        private static void AddClientSerialization(IServiceCollection services)
+        /// <summary>
+        /// Enables client serializers for sending requests and receiving responses
+        /// in json:api format. Internally only used for testing.
+        /// Will be extended in the future to be part of a JsonApiClientDotNetCore package.
+        /// </summary>
+        public static void AddClientSerialization(this IServiceCollection services)
         {
             services.AddScoped<IResponseDeserializer, ResponseDeserializer>();
 

src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs

@@ -12,7 +12,7 @@ namespace JsonApiDotNetCore.Formatters
     /// <summary>
     /// Formats the response data used  https://docs.microsoft.com/en-us/aspnet/core/web-api/advanced/formatting?view=aspnetcore-3.0.
     /// It was intended to have as little dependencies as possible in formatting layer for greater extensibility.
-    /// It onls depends on <see cref="IJsonApiSerializerFactory"/>.
+    /// It onls depends on <see cref="IJsonApiSerializer"/>.
     /// </summary>
     public class JsonApiWriter : IJsonApiWriter
     {

src/JsonApiDotNetCore/Formatters/JsonApiWriter.cs

@@ -55,11 +55,6 @@
     <Folder Include="Serialization\Server\Builders\" />
     <Folder Include="Query\Contracts\" />
     <Folder Include="Query\Common\" />
-  </ItemGroup>
-  <ItemGroup>
-    <Compile Remove="Serialization\Client\RequestResourceObjectBuilder.cs" />
-  </ItemGroup>
-  <ItemGroup>
-    <None Include="Serialization\Client\RequestResourceObjectBuilder.cs" Condition=" '$(EnableDefaultCompileItems)' == 'true' " />
+    <Folder Include="Serialization\Server\Contracts\" />
   </ItemGroup>
 </Project>

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

@@ -3,7 +3,6 @@
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Managers.Contracts;
-using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.Primitives;

src/JsonApiDotNetCore/Middleware/RequestMiddleware.cs

@@ -9,11 +9,8 @@
 
 namespace JsonApiDotNetCore.Serialization.Client
 {
-
     /// <summary>
     /// Client serializer implementation of <see cref="BaseDocumentBuilder"/>
-    /// Note that this implementation does not override the default implementation
-    /// of <see cref="ResourceObjectBuilder.GetRelationshipData"/>.
     /// </summary>
     public class RequestSerializer : BaseDocumentBuilder, IRequestSerializer
     {

src/JsonApiDotNetCore/Serialization/Client/IRequestResourceObjectBuilder.cs

@@ -6,8 +6,8 @@
 namespace JsonApiDotNetCore.Serialization
 {
     /// <summary>
-    /// Abstract base class for serialization that extends <see cref="ResourceObjectBuilder"/>.
-    /// Converts entities in to <see cref="ResourceObject"/>s and wraps them in a <see cref="Document"/>.
+    /// Abstract base class for serialization.
+    /// Uses <see cref="IResourceObjectBuilder"/> to convert entities in to <see cref="ResourceObject"/>s and wraps them in a <see cref="Document"/>.
     /// </summary>
     public abstract class BaseDocumentBuilder
     {