Consistency renames of parameters for schema types

bkoelman · bkoelman · commit c9bb868f2a26 · 2025-03-24T01:26:50.000+01:00
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Components/DataContainerSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Components/DataContainerSchemaGenerator.cs
@@ -32,19 +32,19 @@ public OpenApiSchema GenerateSchemaForCommonResourceDataInResponse(SchemaReposit
         return _dataSchemaGenerator.GenerateSchemaForCommonData(typeof(ResourceInResponse), schemaRepository);
     }
 
-    public OpenApiSchema GenerateSchema(Type dataContainerConstructedType, ResourceType resourceType, bool forRequestSchema, bool canIncludeRelated,
+    public OpenApiSchema GenerateSchema(Type dataContainerSchemaType, ResourceType resourceType, bool forRequestSchema, bool canIncludeRelated,
         SchemaRepository schemaRepository)
     {
-        ArgumentNullException.ThrowIfNull(dataContainerConstructedType);
+        ArgumentNullException.ThrowIfNull(dataContainerSchemaType);
         ArgumentNullException.ThrowIfNull(resourceType);
         ArgumentNullException.ThrowIfNull(schemaRepository);
 
-        if (schemaRepository.TryLookupByType(dataContainerConstructedType, out OpenApiSchema referenceSchemaForData))
+        if (schemaRepository.TryLookupByType(dataContainerSchemaType, out OpenApiSchema referenceSchemaForData))
         {
             return referenceSchemaForData;
         }
 
-        Type dataConstructedType = GetElementTypeOfDataProperty(dataContainerConstructedType, resourceType);
+        Type dataConstructedType = GetElementTypeOfDataProperty(dataContainerSchemaType, resourceType);
 
         if (canIncludeRelated)
         {
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Components/LinksVisibilitySchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Components/LinksVisibilitySchemaGenerator.cs
@@ -70,12 +70,12 @@ public LinksVisibilitySchemaGenerator(IJsonApiOptions options, IResourceGraph re
         _lazyLinksVisibility = new Lazy<LinksVisibility>(() => new LinksVisibility(options, resourceGraph), LazyThreadSafetyMode.ExecutionAndPublication);
     }
 
-    public void UpdateSchemaForTopLevel(Type modelType, OpenApiSchema fullSchemaForLinksContainer, SchemaRepository schemaRepository)
+    public void UpdateSchemaForTopLevel(Type schemaType, OpenApiSchema fullSchemaForLinksContainer, SchemaRepository schemaRepository)
     {
-        ArgumentNullException.ThrowIfNull(modelType);
+        ArgumentNullException.ThrowIfNull(schemaType);
         ArgumentNullException.ThrowIfNull(fullSchemaForLinksContainer);
 
-        Type lookupType = modelType.ConstructedToOpenType();
+        Type lookupType = schemaType.ConstructedToOpenType();
 
         if (LinksInJsonApiSchemaTypes.TryGetValue(lookupType, out LinkTypes possibleLinkTypes))
         {
@@ -94,12 +94,12 @@ public void UpdateSchemaForResource(ResourceSchemaType resourceSchemaType, OpenA
         }
     }
 
-    public void UpdateSchemaForRelationship(Type modelType, OpenApiSchema fullSchemaForRelationship, SchemaRepository schemaRepository)
+    public void UpdateSchemaForRelationship(Type schemaType, OpenApiSchema fullSchemaForRelationship, SchemaRepository schemaRepository)
     {
-        ArgumentNullException.ThrowIfNull(modelType);
+        ArgumentNullException.ThrowIfNull(schemaType);
         ArgumentNullException.ThrowIfNull(fullSchemaForRelationship);
 
-        Type lookupType = modelType.ConstructedToOpenType();
+        Type lookupType = schemaType.ConstructedToOpenType();
 
         if (LinksInJsonApiSchemaTypes.TryGetValue(lookupType, out LinkTypes possibleLinkTypes))
         {
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/JsonApiSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/JsonApiSchemaGenerator.cs
@@ -23,19 +23,19 @@ public JsonApiSchemaGenerator(ResourceIdSchemaGenerator resourceIdSchemaGenerato
         _documentSchemaGenerators = documentSchemaGenerators as DocumentSchemaGenerator[] ?? documentSchemaGenerators.ToArray();
     }
 
-    public OpenApiSchema GenerateSchema(Type modelType, SchemaRepository schemaRepository, MemberInfo? memberInfo = null, ParameterInfo? parameterInfo = null,
+    public OpenApiSchema GenerateSchema(Type schemaType, SchemaRepository schemaRepository, MemberInfo? memberInfo = null, ParameterInfo? parameterInfo = null,
         ApiParameterRouteInfo? routeInfo = null)
     {
-        ArgumentNullException.ThrowIfNull(modelType);
+        ArgumentNullException.ThrowIfNull(schemaType);
         ArgumentNullException.ThrowIfNull(schemaRepository);
 
         if (parameterInfo is { Name: "id" } && IsJsonApiParameter(parameterInfo))
         {
-            return _resourceIdSchemaGenerator.GenerateSchema(modelType, schemaRepository);
+            return _resourceIdSchemaGenerator.GenerateSchema(schemaType, schemaRepository);
         }
 
-        DocumentSchemaGenerator schemaGenerator = GetDocumentSchemaGenerator(modelType);
-        OpenApiSchema referenceSchema = schemaGenerator.GenerateSchema(modelType, schemaRepository);
+        DocumentSchemaGenerator schemaGenerator = GetDocumentSchemaGenerator(schemaType);
+        OpenApiSchema referenceSchema = schemaGenerator.GenerateSchema(schemaType, schemaRepository);
 
         if (memberInfo != null || parameterInfo != null)
         {
@@ -52,11 +52,11 @@ private static bool IsJsonApiParameter(ParameterInfo parameter)
         return parameter.Member.DeclaringType != null && parameter.Member.DeclaringType.IsAssignableTo(typeof(CoreJsonApiController));
     }
 
-    private DocumentSchemaGenerator GetDocumentSchemaGenerator(Type modelType)
+    private DocumentSchemaGenerator GetDocumentSchemaGenerator(Type schemaType)
     {
         foreach (DocumentSchemaGenerator documentSchemaGenerator in _documentSchemaGenerators)
         {
-            if (documentSchemaGenerator.CanGenerate(modelType))
+            if (documentSchemaGenerator.CanGenerate(schemaType))
             {
                 return documentSchemaGenerator;
             }

Original file line number	Diff line number	Diff line change
`@@ -32,19 +32,19 @@ public OpenApiSchema GenerateSchemaForCommonResourceDataInResponse(SchemaReposit`
`32`	`32`	`return _dataSchemaGenerator.GenerateSchemaForCommonData(typeof(ResourceInResponse), schemaRepository);`
`33`	`33`	`}`
`34`	`34`
`35`		`- public OpenApiSchema GenerateSchema(Type dataContainerConstructedType, ResourceType resourceType, bool forRequestSchema, bool canIncludeRelated,`
	`35`	`+ public OpenApiSchema GenerateSchema(Type dataContainerSchemaType, ResourceType resourceType, bool forRequestSchema, bool canIncludeRelated,`
`36`	`36`	`SchemaRepository schemaRepository)`
`37`	`37`	`{`
`38`		`- ArgumentNullException.ThrowIfNull(dataContainerConstructedType);`
	`38`	`+ ArgumentNullException.ThrowIfNull(dataContainerSchemaType);`
`39`	`39`	`ArgumentNullException.ThrowIfNull(resourceType);`
`40`	`40`	`ArgumentNullException.ThrowIfNull(schemaRepository);`
`41`	`41`
`42`		`- if (schemaRepository.TryLookupByType(dataContainerConstructedType, out OpenApiSchema referenceSchemaForData))`
	`42`	`+ if (schemaRepository.TryLookupByType(dataContainerSchemaType, out OpenApiSchema referenceSchemaForData))`
`43`	`43`	`{`
`44`	`44`	`return referenceSchemaForData;`
`45`	`45`	`}`
`46`	`46`
`47`		`- Type dataConstructedType = GetElementTypeOfDataProperty(dataContainerConstructedType, resourceType);`
	`47`	`+ Type dataConstructedType = GetElementTypeOfDataProperty(dataContainerSchemaType, resourceType);`
`48`	`48`
`49`	`49`	`if (canIncludeRelated)`
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -70,12 +70,12 @@ public LinksVisibilitySchemaGenerator(IJsonApiOptions options, IResourceGraph re`
`70`	`70`	`_lazyLinksVisibility = new Lazy<LinksVisibility>(() => new LinksVisibility(options, resourceGraph), LazyThreadSafetyMode.ExecutionAndPublication);`
`71`	`71`	`}`
`72`	`72`
`73`		`- public void UpdateSchemaForTopLevel(Type modelType, OpenApiSchema fullSchemaForLinksContainer, SchemaRepository schemaRepository)`
	`73`	`+ public void UpdateSchemaForTopLevel(Type schemaType, OpenApiSchema fullSchemaForLinksContainer, SchemaRepository schemaRepository)`
`74`	`74`	`{`
`75`		`- ArgumentNullException.ThrowIfNull(modelType);`
	`75`	`+ ArgumentNullException.ThrowIfNull(schemaType);`
`76`	`76`	`ArgumentNullException.ThrowIfNull(fullSchemaForLinksContainer);`
`77`	`77`
`78`		`- Type lookupType = modelType.ConstructedToOpenType();`
	`78`	`+ Type lookupType = schemaType.ConstructedToOpenType();`
`79`	`79`
`80`	`80`	`if (LinksInJsonApiSchemaTypes.TryGetValue(lookupType, out LinkTypes possibleLinkTypes))`
`81`	`81`	`{`
`@@ -94,12 +94,12 @@ public void UpdateSchemaForResource(ResourceSchemaType resourceSchemaType, OpenA`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`
`97`		`- public void UpdateSchemaForRelationship(Type modelType, OpenApiSchema fullSchemaForRelationship, SchemaRepository schemaRepository)`
	`97`	`+ public void UpdateSchemaForRelationship(Type schemaType, OpenApiSchema fullSchemaForRelationship, SchemaRepository schemaRepository)`
`98`	`98`	`{`
`99`		`- ArgumentNullException.ThrowIfNull(modelType);`
	`99`	`+ ArgumentNullException.ThrowIfNull(schemaType);`
`100`	`100`	`ArgumentNullException.ThrowIfNull(fullSchemaForRelationship);`
`101`	`101`
`102`		`- Type lookupType = modelType.ConstructedToOpenType();`
	`102`	`+ Type lookupType = schemaType.ConstructedToOpenType();`
`103`	`103`
`104`	`104`	`if (LinksInJsonApiSchemaTypes.TryGetValue(lookupType, out LinkTypes possibleLinkTypes))`
`105`	`105`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,19 +23,19 @@ public JsonApiSchemaGenerator(ResourceIdSchemaGenerator resourceIdSchemaGenerato`
`23`	`23`	`_documentSchemaGenerators = documentSchemaGenerators as DocumentSchemaGenerator[] ?? documentSchemaGenerators.ToArray();`
`24`	`24`	`}`
`25`	`25`
`26`		`- public OpenApiSchema GenerateSchema(Type modelType, SchemaRepository schemaRepository, MemberInfo? memberInfo = null, ParameterInfo? parameterInfo = null,`
	`26`	`+ public OpenApiSchema GenerateSchema(Type schemaType, SchemaRepository schemaRepository, MemberInfo? memberInfo = null, ParameterInfo? parameterInfo = null,`
`27`	`27`	`ApiParameterRouteInfo? routeInfo = null)`
`28`	`28`	`{`
`29`		`- ArgumentNullException.ThrowIfNull(modelType);`
	`29`	`+ ArgumentNullException.ThrowIfNull(schemaType);`
`30`	`30`	`ArgumentNullException.ThrowIfNull(schemaRepository);`
`31`	`31`
`32`	`32`	`if (parameterInfo is { Name: "id" } && IsJsonApiParameter(parameterInfo))`
`33`	`33`	`{`
`34`		`- return _resourceIdSchemaGenerator.GenerateSchema(modelType, schemaRepository);`
	`34`	`+ return _resourceIdSchemaGenerator.GenerateSchema(schemaType, schemaRepository);`
`35`	`35`	`}`
`36`	`36`
`37`		`- DocumentSchemaGenerator schemaGenerator = GetDocumentSchemaGenerator(modelType);`
`38`		`- OpenApiSchema referenceSchema = schemaGenerator.GenerateSchema(modelType, schemaRepository);`
	`37`	`+ DocumentSchemaGenerator schemaGenerator = GetDocumentSchemaGenerator(schemaType);`
	`38`	`+ OpenApiSchema referenceSchema = schemaGenerator.GenerateSchema(schemaType, schemaRepository);`
`39`	`39`
`40`	`40`	`if (memberInfo != null \|\| parameterInfo != null)`
`41`	`41`	`{`
`@@ -52,11 +52,11 @@ private static bool IsJsonApiParameter(ParameterInfo parameter)`
`52`	`52`	`return parameter.Member.DeclaringType != null && parameter.Member.DeclaringType.IsAssignableTo(typeof(CoreJsonApiController));`
`53`	`53`	`}`
`54`	`54`
`55`		`- private DocumentSchemaGenerator GetDocumentSchemaGenerator(Type modelType)`
	`55`	`+ private DocumentSchemaGenerator GetDocumentSchemaGenerator(Type schemaType)`
`56`	`56`	`{`
`57`	`57`	`foreach (DocumentSchemaGenerator documentSchemaGenerator in _documentSchemaGenerators)`
`58`	`58`	`{`
`59`		`- if (documentSchemaGenerator.CanGenerate(modelType))`
	`59`	`+ if (documentSchemaGenerator.CanGenerate(schemaType))`
`60`	`60`	`{`
`61`	`61`	`return documentSchemaGenerator;`
`62`	`62`	`}`