Rename schema generators for bodies to generators for documents

bkoelman · bkoelman · commit 84df39851eb2 · 2025-03-24T00:47:43.000+01:00
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/AtomicOperationsDocumentSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/AtomicOperationsDocumentSchemaGenerator.cs
@@ -12,12 +12,12 @@
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
-namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;
+namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;
 
 /// <summary>
-/// Generates the OpenAPI component schema for an atomic:operations request/response body.
+/// Generates the OpenAPI component schema for an atomic:operations request/response document.
 /// </summary>
-internal sealed class AtomicOperationsBodySchemaGenerator : BodySchemaGenerator
+internal sealed class AtomicOperationsDocumentSchemaGenerator : DocumentSchemaGenerator
 {
     private static readonly Type AtomicOperationAbstractType = typeof(AtomicOperation);
 
@@ -32,11 +32,12 @@ internal sealed class AtomicOperationsBodySchemaGenerator : BodySchemaGenerator
     private readonly ResourceFieldValidationMetadataProvider _resourceFieldValidationMetadataProvider;
     private readonly IResourceGraph _resourceGraph;
 
-    public AtomicOperationsBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator, AtomicOperationCodeSchemaGenerator atomicOperationCodeSchemaGenerator,
-        DataSchemaGenerator dataSchemaGenerator, RelationshipIdentifierSchemaGenerator relationshipIdentifierSchemaGenerator,
-        DataContainerSchemaGenerator dataContainerSchemaGenerator, MetaSchemaGenerator metaSchemaGenerator,
-        LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IAtomicOperationFilter atomicOperationFilter, JsonApiSchemaIdSelector schemaIdSelector,
-        ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider, IJsonApiOptions options, IResourceGraph resourceGraph)
+    public AtomicOperationsDocumentSchemaGenerator(SchemaGenerator defaultSchemaGenerator,
+        AtomicOperationCodeSchemaGenerator atomicOperationCodeSchemaGenerator, DataSchemaGenerator dataSchemaGenerator,
+        RelationshipIdentifierSchemaGenerator relationshipIdentifierSchemaGenerator, DataContainerSchemaGenerator dataContainerSchemaGenerator,
+        MetaSchemaGenerator metaSchemaGenerator, LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IAtomicOperationFilter atomicOperationFilter,
+        JsonApiSchemaIdSelector schemaIdSelector, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider, IJsonApiOptions options,
+        IResourceGraph resourceGraph)
         : base(metaSchemaGenerator, linksVisibilitySchemaGenerator, options)
     {
         ArgumentNullException.ThrowIfNull(defaultSchemaGenerator);
@@ -61,28 +62,28 @@ public AtomicOperationsBodySchemaGenerator(SchemaGenerator defaultSchemaGenerato
         _resourceGraph = resourceGraph;
     }
 
-    public override bool CanGenerate(Type modelType)
+    public override bool CanGenerate(Type schemaType)
     {
-        return modelType == typeof(OperationsRequestDocument) || modelType == typeof(OperationsResponseDocument);
+        return schemaType == typeof(OperationsRequestDocument) || schemaType == typeof(OperationsResponseDocument);
     }
 
-    protected override OpenApiSchema GenerateBodySchema(Type bodyType, SchemaRepository schemaRepository)
+    protected override OpenApiSchema GenerateDocumentSchema(Type schemaType, SchemaRepository schemaRepository)
     {
-        bool isRequestSchema = bodyType == typeof(OperationsRequestDocument);
+        bool isRequestSchema = schemaType == typeof(OperationsRequestDocument);
 
         if (isRequestSchema)
         {
-            GenerateSchemasForRequestBody(schemaRepository);
+            GenerateSchemasForRequestDocument(schemaRepository);
         }
         else
         {
-            GenerateSchemasForResponseBody(schemaRepository);
+            GenerateSchemasForResponseDocument(schemaRepository);
         }
 
-        return _defaultSchemaGenerator.GenerateSchema(bodyType, schemaRepository);
+        return _defaultSchemaGenerator.GenerateSchema(schemaType, schemaRepository);
     }
 
-    private void GenerateSchemasForRequestBody(SchemaRepository schemaRepository)
+    private void GenerateSchemasForRequestDocument(SchemaRepository schemaRepository)
     {
         _ = GenerateSchemaForAbstractOperation(schemaRepository);
 
@@ -412,7 +413,7 @@ private static bool IsToManyRelationshipEnabled(HasManyAttribute relationship, W
         return null;
     }
 
-    private void GenerateSchemasForResponseBody(SchemaRepository schemaRepository)
+    private void GenerateSchemasForResponseDocument(SchemaRepository schemaRepository)
     {
         _ = _dataContainerSchemaGenerator.GenerateSchemaForCommonResourceDataInResponse(schemaRepository);
 
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/DocumentSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/DocumentSchemaGenerator.cs
@@ -3,18 +3,18 @@
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
-namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;
+namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;
 
 /// <summary>
-/// Generates the OpenAPI component schema for a request and/or response body.
+/// Generates the OpenAPI component schema for a request and/or response document.
 /// </summary>
-internal abstract class BodySchemaGenerator
+internal abstract class DocumentSchemaGenerator
 {
     private readonly MetaSchemaGenerator _metaSchemaGenerator;
     private readonly LinksVisibilitySchemaGenerator _linksVisibilitySchemaGenerator;
     private readonly IJsonApiOptions _options;
 
-    protected BodySchemaGenerator(MetaSchemaGenerator metaSchemaGenerator, LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator,
+    protected DocumentSchemaGenerator(MetaSchemaGenerator metaSchemaGenerator, LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator,
         IJsonApiOptions options)
     {
         ArgumentNullException.ThrowIfNull(metaSchemaGenerator);
@@ -26,31 +26,31 @@ protected BodySchemaGenerator(MetaSchemaGenerator metaSchemaGenerator, LinksVisi
         _options = options;
     }
 
-    public abstract bool CanGenerate(Type modelType);
+    public abstract bool CanGenerate(Type schemaType);
 
-    public OpenApiSchema GenerateSchema(Type bodyType, SchemaRepository schemaRepository)
+    public OpenApiSchema GenerateSchema(Type schemaType, SchemaRepository schemaRepository)
     {
-        ArgumentNullException.ThrowIfNull(bodyType);
+        ArgumentNullException.ThrowIfNull(schemaType);
         ArgumentNullException.ThrowIfNull(schemaRepository);
 
-        if (schemaRepository.TryLookupByType(bodyType, out OpenApiSchema? referenceSchema))
+        if (schemaRepository.TryLookupByType(schemaType, out OpenApiSchema? referenceSchema))
         {
             return referenceSchema;
         }
 
         _metaSchemaGenerator.GenerateSchema(schemaRepository);
 
-        referenceSchema = GenerateBodySchema(bodyType, schemaRepository);
+        referenceSchema = GenerateDocumentSchema(schemaType, schemaRepository);
         OpenApiSchema fullSchema = schemaRepository.Schemas[referenceSchema.Reference.Id];
 
-        _linksVisibilitySchemaGenerator.UpdateSchemaForTopLevel(bodyType, fullSchema, schemaRepository);
+        _linksVisibilitySchemaGenerator.UpdateSchemaForTopLevel(schemaType, fullSchema, schemaRepository);
 
         SetJsonApiVersion(fullSchema, schemaRepository);
 
         return referenceSchema;
     }
 
-    protected abstract OpenApiSchema GenerateBodySchema(Type bodyType, SchemaRepository schemaRepository);
+    protected abstract OpenApiSchema GenerateDocumentSchema(Type schemaType, SchemaRepository schemaRepository);
 
     private void SetJsonApiVersion(OpenApiSchema fullSchema, SchemaRepository schemaRepository)
     {
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/ErrorResponseDocumentSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/ErrorResponseDocumentSchemaGenerator.cs
@@ -5,17 +5,17 @@
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
-namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;
+namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;
 
 /// <summary>
 /// Generates the OpenAPI component schema for an error document.
 /// </summary>
-internal sealed class ErrorResponseBodySchemaGenerator : BodySchemaGenerator
+internal sealed class ErrorResponseDocumentSchemaGenerator : DocumentSchemaGenerator
 {
     private readonly SchemaGenerator _defaultSchemaGenerator;
     private readonly MetaSchemaGenerator _metaSchemaGenerator;
 
-    public ErrorResponseBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator, MetaSchemaGenerator metaSchemaGenerator,
+    public ErrorResponseDocumentSchemaGenerator(SchemaGenerator defaultSchemaGenerator, MetaSchemaGenerator metaSchemaGenerator,
         LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IJsonApiOptions options)
         : base(metaSchemaGenerator, linksVisibilitySchemaGenerator, options)
     {
@@ -25,19 +25,19 @@ public ErrorResponseBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator,
         _metaSchemaGenerator = metaSchemaGenerator;
     }
 
-    public override bool CanGenerate(Type modelType)
+    public override bool CanGenerate(Type schemaType)
     {
-        return modelType == typeof(ErrorResponseDocument);
+        return schemaType == typeof(ErrorResponseDocument);
     }
 
-    protected override OpenApiSchema GenerateBodySchema(Type bodyType, SchemaRepository schemaRepository)
+    protected override OpenApiSchema GenerateDocumentSchema(Type schemaType, SchemaRepository schemaRepository)
     {
         OpenApiSchema referenceSchemaForErrorObject = _defaultSchemaGenerator.GenerateSchema(typeof(ErrorObject), schemaRepository);
         OpenApiSchema fullSchemaForErrorObject = schemaRepository.Schemas[referenceSchemaForErrorObject.Reference.Id];
 
         OpenApiSchema referenceSchemaForMeta = _metaSchemaGenerator.GenerateSchema(schemaRepository);
         fullSchemaForErrorObject.Properties[JsonApiPropertyName.Meta] = referenceSchemaForMeta.WrapInExtendedSchema();
 
-        return _defaultSchemaGenerator.GenerateSchema(bodyType, schemaRepository);
+        return _defaultSchemaGenerator.GenerateSchema(schemaType, schemaRepository);
     }
 }
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/ResourceOrRelationshipDocumentSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/Documents/ResourceOrRelationshipDocumentSchemaGenerator.cs
@@ -6,14 +6,14 @@
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
-namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;
+namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;
 
 /// <summary>
-/// Generates the OpenAPI component schema for a resource/relationship request/response body.
+/// Generates the OpenAPI component schema for a resource/relationship request/response document.
 /// </summary>
-internal sealed class ResourceOrRelationshipBodySchemaGenerator : BodySchemaGenerator
+internal sealed class ResourceOrRelationshipDocumentSchemaGenerator : DocumentSchemaGenerator
 {
-    private static readonly Type[] RequestBodySchemaTypes =
+    private static readonly Type[] RequestDocumentSchemaTypes =
     [
         typeof(CreateRequestDocument<>),
         typeof(UpdateRequestDocument<>),
@@ -22,7 +22,7 @@ internal sealed class ResourceOrRelationshipBodySchemaGenerator : BodySchemaGene
         typeof(ToManyInRequest<>)
     ];
 
-    private static readonly Type[] ResponseBodySchemaTypes =
+    private static readonly Type[] ResponseDocumentSchemaTypes =
     [
         typeof(CollectionResponseDocument<>),
         typeof(PrimaryResponseDocument<>),
@@ -37,7 +37,7 @@ internal sealed class ResourceOrRelationshipBodySchemaGenerator : BodySchemaGene
     private readonly DataContainerSchemaGenerator _dataContainerSchemaGenerator;
     private readonly IResourceGraph _resourceGraph;
 
-    public ResourceOrRelationshipBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator, DataContainerSchemaGenerator dataContainerSchemaGenerator,
+    public ResourceOrRelationshipDocumentSchemaGenerator(SchemaGenerator defaultSchemaGenerator, DataContainerSchemaGenerator dataContainerSchemaGenerator,
         MetaSchemaGenerator metaSchemaGenerator, LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IJsonApiOptions options,
         IResourceGraph resourceGraph)
         : base(metaSchemaGenerator, linksVisibilitySchemaGenerator, options)
@@ -51,35 +51,35 @@ public ResourceOrRelationshipBodySchemaGenerator(SchemaGenerator defaultSchemaGe
         _resourceGraph = resourceGraph;
     }
 
-    public override bool CanGenerate(Type modelType)
+    public override bool CanGenerate(Type schemaType)
     {
-        Type modelOpenType = modelType.ConstructedToOpenType();
-        return RequestBodySchemaTypes.Contains(modelOpenType) || ResponseBodySchemaTypes.Contains(modelOpenType);
+        Type schemaOpenType = schemaType.ConstructedToOpenType();
+        return RequestDocumentSchemaTypes.Contains(schemaOpenType) || ResponseDocumentSchemaTypes.Contains(schemaOpenType);
     }
 
-    protected override OpenApiSchema GenerateBodySchema(Type bodyType, SchemaRepository schemaRepository)
+    protected override OpenApiSchema GenerateDocumentSchema(Type schemaType, SchemaRepository schemaRepository)
     {
-        ArgumentNullException.ThrowIfNull(bodyType);
+        ArgumentNullException.ThrowIfNull(schemaType);
         ArgumentNullException.ThrowIfNull(schemaRepository);
 
-        if (schemaRepository.TryLookupByType(bodyType, out OpenApiSchema? referenceSchemaForBody))
+        if (schemaRepository.TryLookupByType(schemaType, out OpenApiSchema? referenceSchemaForDocument))
         {
-            return referenceSchemaForBody;
+            return referenceSchemaForDocument;
         }
 
-        var resourceSchemaType = ResourceSchemaType.Create(bodyType, _resourceGraph);
-        bool isRequestSchema = RequestBodySchemaTypes.Contains(resourceSchemaType.SchemaOpenType);
+        var resourceSchemaType = ResourceSchemaType.Create(schemaType, _resourceGraph);
+        bool isRequestSchema = RequestDocumentSchemaTypes.Contains(resourceSchemaType.SchemaOpenType);
 
-        _ = _dataContainerSchemaGenerator.GenerateSchema(bodyType, resourceSchemaType.ResourceType, isRequestSchema, !isRequestSchema, schemaRepository);
+        _ = _dataContainerSchemaGenerator.GenerateSchema(schemaType, resourceSchemaType.ResourceType, isRequestSchema, !isRequestSchema, schemaRepository);
 
-        referenceSchemaForBody = _defaultSchemaGenerator.GenerateSchema(bodyType, schemaRepository);
-        OpenApiSchema inlineSchemaForBody = schemaRepository.Schemas[referenceSchemaForBody.Reference.Id].UnwrapLastExtendedSchema();
+        referenceSchemaForDocument = _defaultSchemaGenerator.GenerateSchema(schemaType, schemaRepository);
+        OpenApiSchema inlineSchemaForDocument = schemaRepository.Schemas[referenceSchemaForDocument.Reference.Id].UnwrapLastExtendedSchema();
 
         if (JsonApiSchemaFacts.HasNullableDataProperty(resourceSchemaType.SchemaOpenType))
         {
-            inlineSchemaForBody.Properties[JsonApiPropertyName.Data].Nullable = true;
+            inlineSchemaForDocument.Properties[JsonApiPropertyName.Data].Nullable = true;
         }
 
-        return referenceSchemaForBody;
+        return referenceSchemaForDocument;
     }
 }
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/JsonApiSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/SchemaGenerators/JsonApiSchemaGenerator.cs
@@ -1,8 +1,8 @@
 using System.Diagnostics;
 using System.Reflection;
 using JsonApiDotNetCore.Controllers;
-using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;
 using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Components;
+using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
@@ -12,15 +12,15 @@ namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators;
 internal sealed class JsonApiSchemaGenerator : ISchemaGenerator
 {
     private readonly ResourceIdSchemaGenerator _resourceIdSchemaGenerator;
-    private readonly BodySchemaGenerator[] _bodySchemaGenerators;
+    private readonly DocumentSchemaGenerator[] _documentSchemaGenerators;
 
-    public JsonApiSchemaGenerator(ResourceIdSchemaGenerator resourceIdSchemaGenerator, IEnumerable<BodySchemaGenerator> bodySchemaGenerators)
+    public JsonApiSchemaGenerator(ResourceIdSchemaGenerator resourceIdSchemaGenerator, IEnumerable<DocumentSchemaGenerator> documentSchemaGenerators)
     {
         ArgumentNullException.ThrowIfNull(resourceIdSchemaGenerator);
-        ArgumentNullException.ThrowIfNull(bodySchemaGenerators);
+        ArgumentNullException.ThrowIfNull(documentSchemaGenerators);
 
         _resourceIdSchemaGenerator = resourceIdSchemaGenerator;
-        _bodySchemaGenerators = bodySchemaGenerators as BodySchemaGenerator[] ?? bodySchemaGenerators.ToArray();
+        _documentSchemaGenerators = documentSchemaGenerators as DocumentSchemaGenerator[] ?? documentSchemaGenerators.ToArray();
     }
 
     public OpenApiSchema GenerateSchema(Type modelType, SchemaRepository schemaRepository, MemberInfo? memberInfo = null, ParameterInfo? parameterInfo = null,
@@ -34,7 +34,7 @@ public OpenApiSchema GenerateSchema(Type modelType, SchemaRepository schemaRepos
             return _resourceIdSchemaGenerator.GenerateSchema(modelType, schemaRepository);
         }
 
-        BodySchemaGenerator schemaGenerator = GetBodySchemaGenerator(modelType);
+        DocumentSchemaGenerator schemaGenerator = GetDocumentSchemaGenerator(modelType);
         OpenApiSchema referenceSchema = schemaGenerator.GenerateSchema(modelType, schemaRepository);
 
         if (memberInfo != null || parameterInfo != null)
@@ -52,13 +52,13 @@ private static bool IsJsonApiParameter(ParameterInfo parameter)
         return parameter.Member.DeclaringType != null && parameter.Member.DeclaringType.IsAssignableTo(typeof(CoreJsonApiController));
     }
 
-    private BodySchemaGenerator GetBodySchemaGenerator(Type modelType)
+    private DocumentSchemaGenerator GetDocumentSchemaGenerator(Type modelType)
     {
-        foreach (BodySchemaGenerator bodySchemaGenerator in _bodySchemaGenerators)
+        foreach (DocumentSchemaGenerator documentSchemaGenerator in _documentSchemaGenerators)
         {
-            if (bodySchemaGenerator.CanGenerate(modelType))
+            if (documentSchemaGenerator.CanGenerate(modelType))
             {
-                return bodySchemaGenerator;
+                return documentSchemaGenerator;
             }
         }
 
diff --git a/src/JsonApiDotNetCore.OpenApi.Swashbuckle/ServiceCollectionExtensions.cs b/src/JsonApiDotNetCore.OpenApi.Swashbuckle/ServiceCollectionExtensions.cs
@@ -3,8 +3,8 @@
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.OpenApi.Swashbuckle.JsonApiMetadata;
 using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators;
-using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;
 using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Components;
+using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;
 using JsonApiDotNetCore.OpenApi.Swashbuckle.SwaggerComponents;
 using JsonApiDotNetCore.Serialization.Response;
 using Microsoft.AspNetCore.Mvc;
@@ -95,9 +95,9 @@ private static void AddSchemaGenerators(IServiceCollection services)
         services.TryAddSingleton<SchemaGenerator>();
         services.TryAddSingleton<ISchemaGenerator, JsonApiSchemaGenerator>();
 
-        services.TryAddEnumerable(ServiceDescriptor.Singleton<BodySchemaGenerator, ResourceOrRelationshipBodySchemaGenerator>());
-        services.TryAddEnumerable(ServiceDescriptor.Singleton<BodySchemaGenerator, AtomicOperationsBodySchemaGenerator>());
-        services.TryAddEnumerable(ServiceDescriptor.Singleton<BodySchemaGenerator, ErrorResponseBodySchemaGenerator>());
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<DocumentSchemaGenerator, ResourceOrRelationshipDocumentSchemaGenerator>());
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<DocumentSchemaGenerator, AtomicOperationsDocumentSchemaGenerator>());
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<DocumentSchemaGenerator, ErrorResponseDocumentSchemaGenerator>());
 
         services.TryAddSingleton<AtomicOperationCodeSchemaGenerator>();
         services.TryAddSingleton<ResourceTypeSchemaGenerator>();

Original file line number	Diff line number	Diff line change
`@@ -12,12 +12,12 @@`
`12`	`12`	`using Microsoft.OpenApi.Models;`
`13`	`13`	`using Swashbuckle.AspNetCore.SwaggerGen;`
`14`	`14`
`15`		`-namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;`
	`15`	`+namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;`
`16`	`16`
`17`	`17`	`/// <summary>`
`18`		`-/// Generates the OpenAPI component schema for an atomic:operations request/response body.`
	`18`	`+/// Generates the OpenAPI component schema for an atomic:operations request/response document.`
`19`	`19`	`/// </summary>`
`20`		`-internal sealed class AtomicOperationsBodySchemaGenerator : BodySchemaGenerator`
	`20`	`+internal sealed class AtomicOperationsDocumentSchemaGenerator : DocumentSchemaGenerator`
`21`	`21`	`{`
`22`	`22`	`private static readonly Type AtomicOperationAbstractType = typeof(AtomicOperation);`
`23`	`23`
`@@ -32,11 +32,12 @@ internal sealed class AtomicOperationsBodySchemaGenerator : BodySchemaGenerator`
`32`	`32`	`private readonly ResourceFieldValidationMetadataProvider _resourceFieldValidationMetadataProvider;`
`33`	`33`	`private readonly IResourceGraph _resourceGraph;`
`34`	`34`
`35`		`- public AtomicOperationsBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator, AtomicOperationCodeSchemaGenerator atomicOperationCodeSchemaGenerator,`
`36`		`- DataSchemaGenerator dataSchemaGenerator, RelationshipIdentifierSchemaGenerator relationshipIdentifierSchemaGenerator,`
`37`		`- DataContainerSchemaGenerator dataContainerSchemaGenerator, MetaSchemaGenerator metaSchemaGenerator,`
`38`		`- LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IAtomicOperationFilter atomicOperationFilter, JsonApiSchemaIdSelector schemaIdSelector,`
`39`		`- ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider, IJsonApiOptions options, IResourceGraph resourceGraph)`
	`35`	`+ public AtomicOperationsDocumentSchemaGenerator(SchemaGenerator defaultSchemaGenerator,`
	`36`	`+ AtomicOperationCodeSchemaGenerator atomicOperationCodeSchemaGenerator, DataSchemaGenerator dataSchemaGenerator,`
	`37`	`+ RelationshipIdentifierSchemaGenerator relationshipIdentifierSchemaGenerator, DataContainerSchemaGenerator dataContainerSchemaGenerator,`
	`38`	`+ MetaSchemaGenerator metaSchemaGenerator, LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IAtomicOperationFilter atomicOperationFilter,`
	`39`	`+ JsonApiSchemaIdSelector schemaIdSelector, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider, IJsonApiOptions options,`
	`40`	`+ IResourceGraph resourceGraph)`
`40`	`41`	`: base(metaSchemaGenerator, linksVisibilitySchemaGenerator, options)`
`41`	`42`	`{`
`42`	`43`	`ArgumentNullException.ThrowIfNull(defaultSchemaGenerator);`
`@@ -61,28 +62,28 @@ public AtomicOperationsBodySchemaGenerator(SchemaGenerator defaultSchemaGenerato`
`61`	`62`	`_resourceGraph = resourceGraph;`
`62`	`63`	`}`
`63`	`64`
`64`		`- public override bool CanGenerate(Type modelType)`
	`65`	`+ public override bool CanGenerate(Type schemaType)`
`65`	`66`	`{`
`66`		`- return modelType == typeof(OperationsRequestDocument) \|\| modelType == typeof(OperationsResponseDocument);`
	`67`	`+ return schemaType == typeof(OperationsRequestDocument) \|\| schemaType == typeof(OperationsResponseDocument);`
`67`	`68`	`}`
`68`	`69`
`69`		`- protected override OpenApiSchema GenerateBodySchema(Type bodyType, SchemaRepository schemaRepository)`
	`70`	`+ protected override OpenApiSchema GenerateDocumentSchema(Type schemaType, SchemaRepository schemaRepository)`
`70`	`71`	`{`
`71`		`- bool isRequestSchema = bodyType == typeof(OperationsRequestDocument);`
	`72`	`+ bool isRequestSchema = schemaType == typeof(OperationsRequestDocument);`
`72`	`73`
`73`	`74`	`if (isRequestSchema)`
`74`	`75`	`{`
`75`		`- GenerateSchemasForRequestBody(schemaRepository);`
	`76`	`+ GenerateSchemasForRequestDocument(schemaRepository);`
`76`	`77`	`}`
`77`	`78`	`else`
`78`	`79`	`{`
`79`		`- GenerateSchemasForResponseBody(schemaRepository);`
	`80`	`+ GenerateSchemasForResponseDocument(schemaRepository);`
`80`	`81`	`}`
`81`	`82`
`82`		`- return _defaultSchemaGenerator.GenerateSchema(bodyType, schemaRepository);`
	`83`	`+ return _defaultSchemaGenerator.GenerateSchema(schemaType, schemaRepository);`
`83`	`84`	`}`
`84`	`85`
`85`		`- private void GenerateSchemasForRequestBody(SchemaRepository schemaRepository)`
	`86`	`+ private void GenerateSchemasForRequestDocument(SchemaRepository schemaRepository)`
`86`	`87`	`{`
`87`	`88`	`_ = GenerateSchemaForAbstractOperation(schemaRepository);`
`88`	`89`
`@@ -412,7 +413,7 @@ private static bool IsToManyRelationshipEnabled(HasManyAttribute relationship, W`
`412`	`413`	`return null;`
`413`	`414`	`}`
`414`	`415`
`415`		`- private void GenerateSchemasForResponseBody(SchemaRepository schemaRepository)`
	`416`	`+ private void GenerateSchemasForResponseDocument(SchemaRepository schemaRepository)`
`416`	`417`	`{`
`417`	`418`	`_ = _dataContainerSchemaGenerator.GenerateSchemaForCommonResourceDataInResponse(schemaRepository);`
`418`	`419`
Original file line number	Diff line number	Diff line change
`@@ -5,17 +5,17 @@`
`5`	`5`	`using Microsoft.OpenApi.Models;`
`6`	`6`	`using Swashbuckle.AspNetCore.SwaggerGen;`
`7`	`7`
`8`		`-namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;`
	`8`	`+namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;`
`9`	`9`
`10`	`10`	`/// <summary>`
`11`	`11`	`/// Generates the OpenAPI component schema for an error document.`
`12`	`12`	`/// </summary>`
`13`		`-internal sealed class ErrorResponseBodySchemaGenerator : BodySchemaGenerator`
	`13`	`+internal sealed class ErrorResponseDocumentSchemaGenerator : DocumentSchemaGenerator`
`14`	`14`	`{`
`15`	`15`	`private readonly SchemaGenerator _defaultSchemaGenerator;`
`16`	`16`	`private readonly MetaSchemaGenerator _metaSchemaGenerator;`
`17`	`17`
`18`		`- public ErrorResponseBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator, MetaSchemaGenerator metaSchemaGenerator,`
	`18`	`+ public ErrorResponseDocumentSchemaGenerator(SchemaGenerator defaultSchemaGenerator, MetaSchemaGenerator metaSchemaGenerator,`
`19`	`19`	`LinksVisibilitySchemaGenerator linksVisibilitySchemaGenerator, IJsonApiOptions options)`
`20`	`20`	`: base(metaSchemaGenerator, linksVisibilitySchemaGenerator, options)`
`21`	`21`	`{`
`@@ -25,19 +25,19 @@ public ErrorResponseBodySchemaGenerator(SchemaGenerator defaultSchemaGenerator,`
`25`	`25`	`_metaSchemaGenerator = metaSchemaGenerator;`
`26`	`26`	`}`
`27`	`27`
`28`		`- public override bool CanGenerate(Type modelType)`
	`28`	`+ public override bool CanGenerate(Type schemaType)`
`29`	`29`	`{`
`30`		`- return modelType == typeof(ErrorResponseDocument);`
	`30`	`+ return schemaType == typeof(ErrorResponseDocument);`
`31`	`31`	`}`
`32`	`32`
`33`		`- protected override OpenApiSchema GenerateBodySchema(Type bodyType, SchemaRepository schemaRepository)`
	`33`	`+ protected override OpenApiSchema GenerateDocumentSchema(Type schemaType, SchemaRepository schemaRepository)`
`34`	`34`	`{`
`35`	`35`	`OpenApiSchema referenceSchemaForErrorObject = _defaultSchemaGenerator.GenerateSchema(typeof(ErrorObject), schemaRepository);`
`36`	`36`	`OpenApiSchema fullSchemaForErrorObject = schemaRepository.Schemas[referenceSchemaForErrorObject.Reference.Id];`
`37`	`37`
`38`	`38`	`OpenApiSchema referenceSchemaForMeta = _metaSchemaGenerator.GenerateSchema(schemaRepository);`
`39`	`39`	`fullSchemaForErrorObject.Properties[JsonApiPropertyName.Meta] = referenceSchemaForMeta.WrapInExtendedSchema();`
`40`	`40`
`41`		`- return _defaultSchemaGenerator.GenerateSchema(bodyType, schemaRepository);`
	`41`	`+ return _defaultSchemaGenerator.GenerateSchema(schemaType, schemaRepository);`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`using System.Diagnostics;`
`2`	`2`	`using System.Reflection;`
`3`	`3`	`using JsonApiDotNetCore.Controllers;`
`4`		`-using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Bodies;`
`5`	`4`	`using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Components;`
	`5`	`+using JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators.Documents;`
`6`	`6`	`using Microsoft.AspNetCore.Mvc.ApiExplorer;`
`7`	`7`	`using Microsoft.OpenApi.Models;`
`8`	`8`	`using Swashbuckle.AspNetCore.SwaggerGen;`
`@@ -12,15 +12,15 @@ namespace JsonApiDotNetCore.OpenApi.Swashbuckle.SchemaGenerators;`
`12`	`12`	`internal sealed class JsonApiSchemaGenerator : ISchemaGenerator`
`13`	`13`	`{`
`14`	`14`	`private readonly ResourceIdSchemaGenerator _resourceIdSchemaGenerator;`
`15`		`- private readonly BodySchemaGenerator[] _bodySchemaGenerators;`
	`15`	`+ private readonly DocumentSchemaGenerator[] _documentSchemaGenerators;`
`16`	`16`
`17`		`- public JsonApiSchemaGenerator(ResourceIdSchemaGenerator resourceIdSchemaGenerator, IEnumerable<BodySchemaGenerator> bodySchemaGenerators)`
	`17`	`+ public JsonApiSchemaGenerator(ResourceIdSchemaGenerator resourceIdSchemaGenerator, IEnumerable<DocumentSchemaGenerator> documentSchemaGenerators)`
`18`	`18`	`{`
`19`	`19`	`ArgumentNullException.ThrowIfNull(resourceIdSchemaGenerator);`
`20`		`- ArgumentNullException.ThrowIfNull(bodySchemaGenerators);`
	`20`	`+ ArgumentNullException.ThrowIfNull(documentSchemaGenerators);`
`21`	`21`
`22`	`22`	`_resourceIdSchemaGenerator = resourceIdSchemaGenerator;`
`23`		`- _bodySchemaGenerators = bodySchemaGenerators as BodySchemaGenerator[] ?? bodySchemaGenerators.ToArray();`
	`23`	`+ _documentSchemaGenerators = documentSchemaGenerators as DocumentSchemaGenerator[] ?? documentSchemaGenerators.ToArray();`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public OpenApiSchema GenerateSchema(Type modelType, SchemaRepository schemaRepository, MemberInfo? memberInfo = null, ParameterInfo? parameterInfo = null,`
`@@ -34,7 +34,7 @@ public OpenApiSchema GenerateSchema(Type modelType, SchemaRepository schemaRepos`
`34`	`34`	`return _resourceIdSchemaGenerator.GenerateSchema(modelType, schemaRepository);`
`35`	`35`	`}`
`36`	`36`
`37`		`- BodySchemaGenerator schemaGenerator = GetBodySchemaGenerator(modelType);`
	`37`	`+ DocumentSchemaGenerator schemaGenerator = GetDocumentSchemaGenerator(modelType);`
`38`	`38`	`OpenApiSchema referenceSchema = schemaGenerator.GenerateSchema(modelType, schemaRepository);`
`39`	`39`
`40`	`40`	`if (memberInfo != null \|\| parameterInfo != null)`
`@@ -52,13 +52,13 @@ 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 BodySchemaGenerator GetBodySchemaGenerator(Type modelType)`
	`55`	`+ private DocumentSchemaGenerator GetDocumentSchemaGenerator(Type modelType)`
`56`	`56`	`{`
`57`		`- foreach (BodySchemaGenerator bodySchemaGenerator in _bodySchemaGenerators)`
	`57`	`+ foreach (DocumentSchemaGenerator documentSchemaGenerator in _documentSchemaGenerators)`
`58`	`58`	`{`
`59`		`- if (bodySchemaGenerator.CanGenerate(modelType))`
	`59`	`+ if (documentSchemaGenerator.CanGenerate(modelType))`
`60`	`60`	`{`
`61`		`- return bodySchemaGenerator;`
	`61`	`+ return documentSchemaGenerator;`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`