[reword] Use naming convention for null value schema

maurei · maurei · commit 68f41faf3a27 · 2021-11-26T10:12:24.000+01:00
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiSchemaIdSelector.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiSchemaIdSelector.cs
@@ -31,7 +31,6 @@ internal sealed class JsonApiSchemaIdSelector
             [typeof(ResourceIdentifierObject<>)] = "[ResourceName] Identifier"
         };
 
-        private readonly ResourceNameFormatter _formatter;
         private readonly JsonNamingPolicy _namingPolicy;
         private readonly IResourceGraph _resourceGraph;
 
@@ -42,7 +41,6 @@ public JsonApiSchemaIdSelector(JsonNamingPolicy namingPolicy, IResourceGraph res
 
             _namingPolicy = namingPolicy;
             _resourceGraph = resourceGraph;
-            _formatter = new ResourceNameFormatter(namingPolicy);
         }
 
         public string GetSchemaId(Type type)
@@ -58,18 +56,14 @@ public string GetSchemaId(Type type)
 
             if (type.IsConstructedGenericType && OpenTypeToSchemaTemplateMap.ContainsKey(type.GetGenericTypeDefinition()))
             {
-                Type resourceType = type.GetGenericArguments().First();
-                string resourceName = _formatter.FormatResourceName(resourceType).Singularize();
-
                 string pascalCaseSchemaIdTemplate = OpenTypeToSchemaTemplateMap[type.GetGenericTypeDefinition()];
+                Type resourceType = type.GetGenericArguments().First();
 
                 // @formatter:wrap_chained_method_calls chop_always
                 // @formatter:keep_existing_linebreaks true
 
-                string capitalizedResourceName = Capitalize(resourceName);
-
                 string pascalCaseSchemaId = pascalCaseSchemaIdTemplate
-                    .Replace("[ResourceName]", capitalizedResourceName)
+                    .Replace("[ResourceName]", resourceType.Name)
                     .Replace(" ", "");
 
                 // @formatter:keep_existing_linebreaks restore
@@ -79,7 +73,7 @@ public string GetSchemaId(Type type)
             }
 
             // Used for a fixed set of types, such as jsonapi-object, links-in-many-resource-document etc.
-            return _formatter.FormatResourceName(type).Singularize();
+            return _namingPolicy.ConvertName(type.Name);
         }
 
         private static string Capitalize(string term)
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiSchemaGenerator.cs
@@ -47,7 +47,7 @@ public JsonApiSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceG
             ArgumentGuard.NotNull(options, nameof(options));
 
             _defaultSchemaGenerator = defaultSchemaGenerator;
-            _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(_schemaRepositoryAccessor);
+            _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(_schemaRepositoryAccessor, options.SerializerOptions.PropertyNamingPolicy);
             _jsonApiObjectNullabilityProcessor = new JsonApiObjectNullabilityProcessor(_schemaRepositoryAccessor);
             _resourceObjectSchemaGenerator = new ResourceObjectSchemaGenerator(defaultSchemaGenerator, resourceGraph, options, _schemaRepositoryAccessor);
         }
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/NullableReferenceSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/NullableReferenceSchemaGenerator.cs
@@ -1,24 +1,27 @@
 using System;
 using System.Collections.Generic;
+using System.Text.Json;
 using Microsoft.OpenApi.Models;
 
 namespace JsonApiDotNetCore.OpenApi.SwaggerComponents
 {
     internal sealed class NullableReferenceSchemaGenerator
     {
-        private const string NullableSchemaReferenceId = "null-value";
+        private const string NullableSchemaReferenceIdTemplate = "Null Value";
+        private readonly string _nullableSchemaReferenceId;
 
         private static readonly NullableReferenceSchemaStrategy NullableReferenceStrategy =
             Enum.Parse<NullableReferenceSchemaStrategy>(NullableReferenceSchemaStrategy.Implicit.ToString());
 
         private static OpenApiSchema _referenceSchemaForExplicitNullValue;
         private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
 
-        public NullableReferenceSchemaGenerator(ISchemaRepositoryAccessor schemaRepositoryAccessor)
+        public NullableReferenceSchemaGenerator(ISchemaRepositoryAccessor schemaRepositoryAccessor, JsonNamingPolicy namingPolicy)
         {
             ArgumentGuard.NotNull(schemaRepositoryAccessor, nameof(schemaRepositoryAccessor));
 
             _schemaRepositoryAccessor = schemaRepositoryAccessor;
+            _nullableSchemaReferenceId = namingPolicy.ConvertName(NullableSchemaReferenceIdTemplate);
         }
 
         public OpenApiSchema GenerateSchema(OpenApiSchema referenceSchema)
@@ -53,15 +56,15 @@ private OpenApiSchema GetImplicitNullSchema()
             {
                 Reference = new OpenApiReference
                 {
-                    Id = NullableSchemaReferenceId,
+                    Id = _nullableSchemaReferenceId,
                     Type = ReferenceType.Schema
                 }
             };
         }
 
         private void EnsureFullSchemaForNullValueExists()
         {
-            if (!_schemaRepositoryAccessor.Current.Schemas.ContainsKey(NullableSchemaReferenceId))
+            if (!_schemaRepositoryAccessor.Current.Schemas.ContainsKey(_nullableSchemaReferenceId))
             {
                 var fullSchemaForNullValue = new OpenApiSchema
                 {
@@ -95,7 +98,7 @@ private void EnsureFullSchemaForNullValueExists()
                     }
                 };
 
-                _schemaRepositoryAccessor.Current.AddDefinition(NullableSchemaReferenceId, fullSchemaForNullValue);
+                _schemaRepositoryAccessor.Current.AddDefinition(_nullableSchemaReferenceId, fullSchemaForNullValue);
             }
         }
     }
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs
@@ -3,6 +3,7 @@
 using System.ComponentModel.DataAnnotations;
 using System.Linq;
 using System.Reflection;
+using System.Text.Json;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
 using JsonApiDotNetCore.Resources.Annotations;
@@ -23,7 +24,8 @@ internal sealed class ResourceFieldObjectSchemaBuilder
         private readonly IDictionary<string, OpenApiSchema> _schemasForResourceFields;
 
         public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISchemaRepositoryAccessor schemaRepositoryAccessor,
-            SchemaGenerator defaultSchemaGenerator, JsonApiSchemaIdSelector jsonApiSchemaIdSelector, ResourceTypeSchemaGenerator resourceTypeSchemaGenerator, SchemaRepository resourceSchemaRepository)
+            SchemaGenerator defaultSchemaGenerator, JsonApiSchemaIdSelector jsonApiSchemaIdSelector, ResourceTypeSchemaGenerator resourceTypeSchemaGenerator,
+            SchemaRepository resourceSchemaRepository, JsonNamingPolicy namingPolicy)
         {
             ArgumentGuard.NotNull(resourceTypeInfo, nameof(resourceTypeInfo));
             ArgumentGuard.NotNull(schemaRepositoryAccessor, nameof(schemaRepositoryAccessor));
@@ -39,7 +41,7 @@ public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISche
             _resourceTypeSchemaGenerator = resourceTypeSchemaGenerator;
             _resourceSchemaRepository = resourceSchemaRepository;
 
-            _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(schemaRepositoryAccessor);
+            _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(schemaRepositoryAccessor, namingPolicy);
             _schemasForResourceFields = GetFieldSchemas();
         }
 
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectSchemaGenerator.cs
@@ -44,7 +44,7 @@ private static Func<ResourceTypeInfo, ResourceFieldObjectSchemaBuilder> CreateFi
             var jsonApiSchemaIdSelector = new JsonApiSchemaIdSelector(namingPolicy, resourceGraph);
 
             return resourceTypeInfo => new ResourceFieldObjectSchemaBuilder(resourceTypeInfo, schemaRepositoryAccessor, defaultSchemaGenerator,
-                jsonApiSchemaIdSelector, resourceTypeSchemaGenerator, resourceSchemaRepository);
+                jsonApiSchemaIdSelector, resourceTypeSchemaGenerator, resourceSchemaRepository, namingPolicy);
         }
 
         public OpenApiSchema GenerateSchema(Type resourceObjectType)

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public JsonApiSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceG`
`47`	`47`	`ArgumentGuard.NotNull(options, nameof(options));`
`48`	`48`
`49`	`49`	`_defaultSchemaGenerator = defaultSchemaGenerator;`
`50`		`- _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(_schemaRepositoryAccessor);`
	`50`	`+ _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(_schemaRepositoryAccessor, options.SerializerOptions.PropertyNamingPolicy);`
`51`	`51`	`_jsonApiObjectNullabilityProcessor = new JsonApiObjectNullabilityProcessor(_schemaRepositoryAccessor);`
`52`	`52`	`_resourceObjectSchemaGenerator = new ResourceObjectSchemaGenerator(defaultSchemaGenerator, resourceGraph, options, _schemaRepositoryAccessor);`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,24 +1,27 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using System.Text.Json;`
`3`	`4`	`using Microsoft.OpenApi.Models;`
`4`	`5`
`5`	`6`	`namespace JsonApiDotNetCore.OpenApi.SwaggerComponents`
`6`	`7`	`{`
`7`	`8`	`internal sealed class NullableReferenceSchemaGenerator`
`8`	`9`	`{`
`9`		`- private const string NullableSchemaReferenceId = "null-value";`
	`10`	`+ private const string NullableSchemaReferenceIdTemplate = "Null Value";`
	`11`	`+ private readonly string _nullableSchemaReferenceId;`
`10`	`12`
`11`	`13`	`private static readonly NullableReferenceSchemaStrategy NullableReferenceStrategy =`
`12`	`14`	`Enum.Parse<NullableReferenceSchemaStrategy>(NullableReferenceSchemaStrategy.Implicit.ToString());`
`13`	`15`
`14`	`16`	`private static OpenApiSchema _referenceSchemaForExplicitNullValue;`
`15`	`17`	`private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;`
`16`	`18`
`17`		`- public NullableReferenceSchemaGenerator(ISchemaRepositoryAccessor schemaRepositoryAccessor)`
	`19`	`+ public NullableReferenceSchemaGenerator(ISchemaRepositoryAccessor schemaRepositoryAccessor, JsonNamingPolicy namingPolicy)`
`18`	`20`	`{`
`19`	`21`	`ArgumentGuard.NotNull(schemaRepositoryAccessor, nameof(schemaRepositoryAccessor));`
`20`	`22`
`21`	`23`	`_schemaRepositoryAccessor = schemaRepositoryAccessor;`
	`24`	`+ _nullableSchemaReferenceId = namingPolicy.ConvertName(NullableSchemaReferenceIdTemplate);`
`22`	`25`	`}`
`23`	`26`
`24`	`27`	`public OpenApiSchema GenerateSchema(OpenApiSchema referenceSchema)`
`@@ -53,15 +56,15 @@ private OpenApiSchema GetImplicitNullSchema()`
`53`	`56`	`{`
`54`	`57`	`Reference = new OpenApiReference`
`55`	`58`	`{`
`56`		`- Id = NullableSchemaReferenceId,`
	`59`	`+ Id = _nullableSchemaReferenceId,`
`57`	`60`	`Type = ReferenceType.Schema`
`58`	`61`	`}`
`59`	`62`	`};`
`60`	`63`	`}`
`61`	`64`
`62`	`65`	`private void EnsureFullSchemaForNullValueExists()`
`63`	`66`	`{`
`64`		`- if (!_schemaRepositoryAccessor.Current.Schemas.ContainsKey(NullableSchemaReferenceId))`
	`67`	`+ if (!_schemaRepositoryAccessor.Current.Schemas.ContainsKey(_nullableSchemaReferenceId))`
`65`	`68`	`{`
`66`	`69`	`var fullSchemaForNullValue = new OpenApiSchema`
`67`	`70`	`{`
`@@ -95,7 +98,7 @@ private void EnsureFullSchemaForNullValueExists()`
`95`	`98`	`}`
`96`	`99`	`};`
`97`	`100`
`98`		`- _schemaRepositoryAccessor.Current.AddDefinition(NullableSchemaReferenceId, fullSchemaForNullValue);`
	`101`	`+ _schemaRepositoryAccessor.Current.AddDefinition(_nullableSchemaReferenceId, fullSchemaForNullValue);`
`99`	`102`	`}`
`100`	`103`	`}`
`101`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ private static Func<ResourceTypeInfo, ResourceFieldObjectSchemaBuilder> CreateFi`
`44`	`44`	`var jsonApiSchemaIdSelector = new JsonApiSchemaIdSelector(namingPolicy, resourceGraph);`
`45`	`45`
`46`	`46`	`return resourceTypeInfo => new ResourceFieldObjectSchemaBuilder(resourceTypeInfo, schemaRepositoryAccessor, defaultSchemaGenerator,`
`47`		`- jsonApiSchemaIdSelector, resourceTypeSchemaGenerator, resourceSchemaRepository);`
	`47`	`+ jsonApiSchemaIdSelector, resourceTypeSchemaGenerator, resourceSchemaRepository, namingPolicy);`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`public OpenApiSchema GenerateSchema(Type resourceObjectType)`