Generate documentation for JSON:API resource types and attributes

bkoelman · bkoelman · commit 469752914b97 · 2023-10-26T18:48:35.000+02:00
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs
@@ -39,6 +39,7 @@ internal sealed class ResourceFieldObjectSchemaBuilder
     private readonly IDictionary<string, OpenApiSchema> _schemasForResourceFields;
     private readonly ResourceFieldValidationMetadataProvider _resourceFieldValidationMetadataProvider;
     private readonly RelationshipTypeFactory _relationshipTypeFactory;
+    private readonly ResourceObjectDocumentationReader _resourceObjectDocumentationReader;
 
     public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISchemaRepositoryAccessor schemaRepositoryAccessor,
         SchemaGenerator defaultSchemaGenerator, ResourceTypeSchemaGenerator resourceTypeSchemaGenerator, JsonNamingPolicy? namingPolicy,
@@ -59,6 +60,7 @@ public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISche
         _nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(schemaRepositoryAccessor, namingPolicy);
         _relationshipTypeFactory = new RelationshipTypeFactory(resourceFieldValidationMetadataProvider);
         _schemasForResourceFields = GetFieldSchemas();
+        _resourceObjectDocumentationReader = new ResourceObjectDocumentationReader();
     }
 
     private IDictionary<string, OpenApiSchema> GetFieldSchemas()
@@ -92,6 +94,8 @@ public void SetMembersOfAttributesObject(OpenApiSchema fullSchemaForAttributesOb
                 {
                     fullSchemaForAttributesObject.Required.Add(matchingAttribute.PublicName);
                 }
+
+                resourceFieldSchema.Description = _resourceObjectDocumentationReader.GetDocumentationForAttribute(matchingAttribute);
             }
         }
     }
@@ -131,14 +135,18 @@ public void SetMembersOfRelationshipsObject(OpenApiSchema fullSchemaForRelations
     {
         ArgumentGuard.NotNull(fullSchemaForRelationshipsObject);
 
-        foreach (string fieldName in _schemasForResourceFields.Keys)
+        foreach ((string fieldName, OpenApiSchema resourceFieldSchema) in _schemasForResourceFields)
         {
             RelationshipAttribute? matchingRelationship = _resourceTypeInfo.ResourceType.FindRelationshipByPublicName(fieldName);
 
             if (matchingRelationship != null)
             {
                 EnsureResourceIdentifierObjectSchemaExists(matchingRelationship);
                 AddRelationshipSchemaToResourceObject(matchingRelationship, fullSchemaForRelationshipsObject);
+
+                // This currently has no effect because $ref cannot be combined with other elements in OAS 3.0.
+                // This can be worked around by using the allOf operator. See https://github.com/OAI/OpenAPI-Specification/issues/1514.
+                resourceFieldSchema.Description = _resourceObjectDocumentationReader.GetDocumentationForRelationship(matchingRelationship);
             }
         }
     }
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectDocumentationReader.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectDocumentationReader.cs
@@ -0,0 +1,87 @@
+using System.Collections.Concurrent;
+using System.Reflection;
+using System.Xml.XPath;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Resources.Annotations;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace JsonApiDotNetCore.OpenApi.SwaggerComponents;
+
+internal sealed class ResourceObjectDocumentationReader
+{
+    private static readonly ConcurrentDictionary<string, XPathNavigator?> NavigatorsByAssemblyPath = new();
+
+    public string? GetDocumentationForType(ResourceType resourceType)
+    {
+        ArgumentGuard.NotNull(resourceType);
+
+        XPathNavigator? navigator = GetNavigator(resourceType.ClrType.Assembly);
+
+        if (navigator != null)
+        {
+            string typeMemberName = XmlCommentsNodeNameHelper.GetMemberNameForType(resourceType.ClrType);
+            return GetSummary(navigator, typeMemberName);
+        }
+
+        return null;
+    }
+
+    public string? GetDocumentationForAttribute(AttrAttribute attribute)
+    {
+        ArgumentGuard.NotNull(attribute);
+
+        XPathNavigator? navigator = GetNavigator(attribute.Type.ClrType.Assembly);
+
+        if (navigator != null)
+        {
+            string propertyMemberName = XmlCommentsNodeNameHelper.GetMemberNameForFieldOrProperty(attribute.Property);
+            return GetSummary(navigator, propertyMemberName);
+        }
+
+        return null;
+    }
+
+    public string? GetDocumentationForRelationship(RelationshipAttribute relationship)
+    {
+        ArgumentGuard.NotNull(relationship);
+
+        XPathNavigator? navigator = GetNavigator(relationship.Type.ClrType.Assembly);
+
+        if (navigator != null)
+        {
+            string propertyMemberName = XmlCommentsNodeNameHelper.GetMemberNameForFieldOrProperty(relationship.Property);
+            return GetSummary(navigator, propertyMemberName);
+        }
+
+        return null;
+    }
+
+    private static XPathNavigator? GetNavigator(Assembly assembly)
+    {
+        string assemblyPath = assembly.Location;
+
+        if (!string.IsNullOrEmpty(assemblyPath))
+        {
+            return NavigatorsByAssemblyPath.GetOrAdd(assemblyPath, path =>
+            {
+                string documentationPath = Path.ChangeExtension(path, ".xml");
+
+                if (File.Exists(documentationPath))
+                {
+                    var document = new XPathDocument(documentationPath);
+                    return document.CreateNavigator();
+                }
+
+                return null;
+            });
+        }
+
+        return null;
+    }
+
+    private string? GetSummary(XPathNavigator navigator, string memberName)
+    {
+        XPathNavigator? summaryNode = navigator.SelectSingleNode($"/doc/members/member[@name='{memberName}']/summary");
+        return summaryNode != null ? XmlCommentsTextHelper.Humanize(summaryNode.InnerXml) : null;
+    }
+}
diff --git a/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectSchemaGenerator.cs b/src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectSchemaGenerator.cs
@@ -23,6 +23,7 @@ internal sealed class ResourceObjectSchemaGenerator
     private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
     private readonly ResourceTypeSchemaGenerator _resourceTypeSchemaGenerator;
     private readonly Func<ResourceTypeInfo, ResourceFieldObjectSchemaBuilder> _resourceFieldObjectSchemaBuilderFactory;
+    private readonly ResourceObjectDocumentationReader _resourceObjectDocumentationReader;
 
     public ResourceObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceGraph resourceGraph, IJsonApiOptions options,
         ISchemaRepositoryAccessor schemaRepositoryAccessor, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider)
@@ -42,6 +43,8 @@ public ResourceObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IRe
 
         _resourceFieldObjectSchemaBuilderFactory = resourceTypeInfo => new ResourceFieldObjectSchemaBuilder(resourceTypeInfo, schemaRepositoryAccessor,
             defaultSchemaGenerator, _resourceTypeSchemaGenerator, options.SerializerOptions.PropertyNamingPolicy, resourceFieldValidationMetadataProvider);
+
+        _resourceObjectDocumentationReader = new ResourceObjectDocumentationReader();
     }
 
     public OpenApiSchema GenerateSchema(Type resourceObjectType)
@@ -55,7 +58,7 @@ public OpenApiSchema GenerateSchema(Type resourceObjectType)
 
         RemoveResourceIdIfPostResourceObject(resourceTypeInfo, fullSchemaForResourceObject);
 
-        SetResourceType(fullSchemaForResourceObject, resourceTypeInfo.ResourceType.ClrType);
+        SetResourceType(fullSchemaForResourceObject, resourceTypeInfo.ResourceType);
 
         SetResourceAttributes(fullSchemaForResourceObject, fieldObjectBuilder);
 
@@ -96,9 +99,11 @@ private void RemoveResourceIdIfPostResourceObject(ResourceTypeInfo resourceTypeI
         }
     }
 
-    private void SetResourceType(OpenApiSchema fullSchemaForResourceObject, Type resourceType)
+    private void SetResourceType(OpenApiSchema fullSchemaForResourceObject, ResourceType resourceType)
     {
-        fullSchemaForResourceObject.Properties[JsonApiPropertyName.Type] = _resourceTypeSchemaGenerator.Get(resourceType);
+        fullSchemaForResourceObject.Properties[JsonApiPropertyName.Type] = _resourceTypeSchemaGenerator.Get(resourceType.ClrType);
+
+        fullSchemaForResourceObject.Description = _resourceObjectDocumentationReader.GetDocumentationForType(resourceType);
     }
 
     private void SetResourceAttributes(OpenApiSchema fullSchemaForResourceObject, ResourceFieldObjectSchemaBuilder builder)
diff --git a/test/OpenApiClientTests/LegacyClient/swagger.g.json b/test/OpenApiClientTests/LegacyClient/swagger.g.json
@@ -2259,7 +2259,8 @@
           "LufthansaGroup",
           "AirFranceKlm"
         ],
-        "type": "string"
+        "type": "string",
+        "description": "Lists the various airlines used in this API."
       },
       "airplane-attributes-in-patch-request": {
         "type": "object",
@@ -2349,6 +2350,7 @@
           },
           "manufactured-at": {
             "type": "string",
+            "description": "Gets the day on which this airplane was manufactured.",
             "format": "date-time"
           },
           "is-in-maintenance": {
diff --git a/test/OpenApiTests/DocComments/DocCommentsStartup.cs b/test/OpenApiTests/DocComments/DocCommentsStartup.cs
@@ -28,5 +28,7 @@ protected override void SetupSwaggerGenAction(SwaggerGenOptions options)
                 Url = new Uri("https://licenses.nuget.org/MIT")
             }
         });
+
+        base.SetupSwaggerGenAction(options);
     }
 }
diff --git a/test/OpenApiTests/DocComments/DocCommentsTests.cs b/test/OpenApiTests/DocComments/DocCommentsTests.cs
@@ -15,6 +15,8 @@ public DocCommentsTests(OpenApiTestContext<DocCommentsStartup<DocCommentsDbConte
         _testContext = testContext;
 
         testContext.UseController<SkyscrapersController>();
+        testContext.UseController<ElevatorsController>();
+        testContext.UseController<SpacesController>();
     }
 
     [Fact]
@@ -422,4 +424,63 @@ public async Task Endpoints_are_documented()
             });
         });
     }
+
+    [Fact]
+    public async Task Resource_types_are_documented()
+    {
+        // Act
+        JsonElement document = await _testContext.GetSwaggerDocumentAsync();
+
+        // Assert
+        document.Should().ContainPath("components.schemas").With(schemasElement =>
+        {
+            schemasElement.Should().HaveProperty("elevatorDataInPatchRequest.description", "An elevator within a skyscraper.");
+            schemasElement.Should().HaveProperty("elevatorDataInPostRequest.description", "An elevator within a skyscraper.");
+            schemasElement.Should().HaveProperty("elevatorDataInResponse.description", "An elevator within a skyscraper.");
+
+            schemasElement.Should().HaveProperty("skyscraperDataInPatchRequest.description", "A tall, continuously habitable building having multiple floors.");
+            schemasElement.Should().HaveProperty("skyscraperDataInPostRequest.description", "A tall, continuously habitable building having multiple floors.");
+            schemasElement.Should().HaveProperty("skyscraperDataInResponse.description", "A tall, continuously habitable building having multiple floors.");
+
+            schemasElement.Should().HaveProperty("spaceDataInPatchRequest.description", "A space within a skyscraper, such as an office, hotel, residential space, or retail space.");
+            schemasElement.Should().HaveProperty("spaceDataInPostRequest.description", "A space within a skyscraper, such as an office, hotel, residential space, or retail space.");
+            schemasElement.Should().HaveProperty("spaceDataInResponse.description", "A space within a skyscraper, such as an office, hotel, residential space, or retail space.");
+        });
+    }
+
+    [Fact]
+    public async Task Resource_attributes_are_documented()
+    {
+        // Act
+        JsonElement document = await _testContext.GetSwaggerDocumentAsync();
+
+        // Assert
+        document.Should().ContainPath("components.schemas").With(schemasElement =>
+        {
+            schemasElement.Should().HaveProperty("elevatorAttributesInPatchRequest.properties.floorCount.description", "The number of floors this elevator provides access to.");
+            schemasElement.Should().HaveProperty("elevatorAttributesInPostRequest.properties.floorCount.description", "The number of floors this elevator provides access to.");
+            schemasElement.Should().HaveProperty("elevatorAttributesInResponse.properties.floorCount.description", "The number of floors this elevator provides access to.");
+
+            schemasElement.Should().HaveProperty("skyscraperAttributesInPatchRequest.properties.heightInMeters.description", "The height of this building, in meters.");
+            schemasElement.Should().HaveProperty("skyscraperAttributesInPostRequest.properties.heightInMeters.description", "The height of this building, in meters.");
+            schemasElement.Should().HaveProperty("skyscraperAttributesInResponse.properties.heightInMeters.description", "The height of this building, in meters.");
+
+            schemasElement.Should().HaveProperty("spaceAttributesInPatchRequest.properties.floorNumber.description", "The floor number on which this space resides.");
+            schemasElement.Should().HaveProperty("spaceAttributesInPostRequest.properties.floorNumber.description", "The floor number on which this space resides.");
+            schemasElement.Should().HaveProperty("spaceAttributesInResponse.properties.floorNumber.description", "The floor number on which this space resides.");
+        });
+    }
+
+    [Fact]
+    public async Task Enums_are_documented()
+    {
+        // Act
+        JsonElement document = await _testContext.GetSwaggerDocumentAsync();
+
+        // Assert
+        document.Should().ContainPath("components.schemas").With(schemasElement =>
+        {
+            schemasElement.Should().HaveProperty("spaceKind.description", "Lists the various kinds of spaces within a skyscraper.");
+        });
+    }
 }
diff --git a/test/OpenApiTests/DocComments/Space.cs b/test/OpenApiTests/DocComments/Space.cs
@@ -17,6 +17,12 @@ public sealed class Space : Identifiable<long>
     [Attr]
     public int FloorNumber { get; set; }
 
+    /// <summary>
+    /// The kind of this space.
+    /// </summary>
+    [Attr]
+    public SpaceKind Kind { get; set; }
+
     /// <summary>
     /// The skyscraper this space exists in.
     /// </summary>
diff --git a/test/OpenApiTests/DocComments/SpaceKind.cs b/test/OpenApiTests/DocComments/SpaceKind.cs
@@ -0,0 +1,15 @@
+using JetBrains.Annotations;
+
+namespace OpenApiTests.DocComments;
+
+/// <summary>
+/// Lists the various kinds of spaces within a skyscraper.
+/// </summary>
+[UsedImplicitly(ImplicitUseTargetFlags.Members)]
+public enum SpaceKind
+{
+    Office,
+    Hotel,
+    Residential,
+    Retail
+}
diff --git a/test/OpenApiTests/LegacyOpenApiIntegration/Airline.cs b/test/OpenApiTests/LegacyOpenApiIntegration/Airline.cs
@@ -2,6 +2,9 @@
 
 namespace OpenApiTests.LegacyOpenApiIntegration;
 
+/// <summary>
+/// Lists the various airlines used in this API.
+/// </summary>
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 public enum Airline : byte
 {
diff --git a/test/OpenApiTests/LegacyOpenApiIntegration/Airplane.cs b/test/OpenApiTests/LegacyOpenApiIntegration/Airplane.cs
@@ -23,6 +23,9 @@ public sealed class Airplane : Identifiable<string>
     [Attr(Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowCreate | AttrCapabilities.AllowChange)]
     public DateTime? LastServicedAt { get; set; }
 
+    /// <summary>
+    /// Gets the day on which this airplane was manufactured.
+    /// </summary>
     [Attr]
     public DateTime ManufacturedAt { get; set; }
 
diff --git a/test/OpenApiTests/LegacyOpenApiIntegration/swagger.json b/test/OpenApiTests/LegacyOpenApiIntegration/swagger.json
@@ -2259,7 +2259,8 @@
           "LufthansaGroup",
           "AirFranceKlm"
         ],
-        "type": "string"
+        "type": "string",
+        "description": "Lists the various airlines used in this API."
       },
       "airplane-attributes-in-patch-request": {
         "type": "object",
@@ -2349,6 +2350,7 @@
           },
           "manufactured-at": {
             "type": "string",
+            "description": "Gets the day on which this airplane was manufactured.",
             "format": "date-time"
           },
           "is-in-maintenance": {
diff --git a/test/OpenApiTests/OpenApiStartup.cs b/test/OpenApiTests/OpenApiStartup.cs
@@ -1,3 +1,4 @@
+using System.Reflection;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.OpenApi;
 using Microsoft.AspNetCore.Builder;
@@ -21,6 +22,8 @@ public override void ConfigureServices(IServiceCollection services)
 
     protected virtual void SetupSwaggerGenAction(SwaggerGenOptions options)
     {
+        string documentationPath = Path.ChangeExtension(Assembly.GetExecutingAssembly().Location, ".xml");
+        options.IncludeXmlComments(documentationPath);
     }
 
     public override void Configure(IApplicationBuilder app)

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ internal sealed class ResourceFieldObjectSchemaBuilder`
`39`	`39`	`private readonly IDictionary<string, OpenApiSchema> _schemasForResourceFields;`
`40`	`40`	`private readonly ResourceFieldValidationMetadataProvider _resourceFieldValidationMetadataProvider;`
`41`	`41`	`private readonly RelationshipTypeFactory _relationshipTypeFactory;`
	`42`	`+ private readonly ResourceObjectDocumentationReader _resourceObjectDocumentationReader;`
`42`	`43`
`43`	`44`	`public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISchemaRepositoryAccessor schemaRepositoryAccessor,`
`44`	`45`	`SchemaGenerator defaultSchemaGenerator, ResourceTypeSchemaGenerator resourceTypeSchemaGenerator, JsonNamingPolicy? namingPolicy,`
`@@ -59,6 +60,7 @@ public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISche`
`59`	`60`	`_nullableReferenceSchemaGenerator = new NullableReferenceSchemaGenerator(schemaRepositoryAccessor, namingPolicy);`
`60`	`61`	`_relationshipTypeFactory = new RelationshipTypeFactory(resourceFieldValidationMetadataProvider);`
`61`	`62`	`_schemasForResourceFields = GetFieldSchemas();`
	`63`	`+ _resourceObjectDocumentationReader = new ResourceObjectDocumentationReader();`
`62`	`64`	`}`
`63`	`65`
`64`	`66`	`private IDictionary<string, OpenApiSchema> GetFieldSchemas()`
`@@ -92,6 +94,8 @@ public void SetMembersOfAttributesObject(OpenApiSchema fullSchemaForAttributesOb`
`92`	`94`	`{`
`93`	`95`	`fullSchemaForAttributesObject.Required.Add(matchingAttribute.PublicName);`
`94`	`96`	`}`
	`97`	`+`
	`98`	`+ resourceFieldSchema.Description = _resourceObjectDocumentationReader.GetDocumentationForAttribute(matchingAttribute);`
`95`	`99`	`}`
`96`	`100`	`}`
`97`	`101`	`}`
`@@ -131,14 +135,18 @@ public void SetMembersOfRelationshipsObject(OpenApiSchema fullSchemaForRelations`
`131`	`135`	`{`
`132`	`136`	`ArgumentGuard.NotNull(fullSchemaForRelationshipsObject);`
`133`	`137`
`134`		`- foreach (string fieldName in _schemasForResourceFields.Keys)`
	`138`	`+ foreach ((string fieldName, OpenApiSchema resourceFieldSchema) in _schemasForResourceFields)`
`135`	`139`	`{`
`136`	`140`	`RelationshipAttribute? matchingRelationship = _resourceTypeInfo.ResourceType.FindRelationshipByPublicName(fieldName);`
`137`	`141`
`138`	`142`	`if (matchingRelationship != null)`
`139`	`143`	`{`
`140`	`144`	`EnsureResourceIdentifierObjectSchemaExists(matchingRelationship);`
`141`	`145`	`AddRelationshipSchemaToResourceObject(matchingRelationship, fullSchemaForRelationshipsObject);`
	`146`	`+`
	`147`	`+ // This currently has no effect because $ref cannot be combined with other elements in OAS 3.0.`
	`148`	`+ // This can be worked around by using the allOf operator. See https://github.com/OAI/OpenAPI-Specification/issues/1514.`
	`149`	`+ resourceFieldSchema.Description = _resourceObjectDocumentationReader.GetDocumentationForRelationship(matchingRelationship);`
`142`	`150`	`}`
`143`	`151`	`}`
`144`	`152`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ internal sealed class ResourceObjectSchemaGenerator`
`23`	`23`	`private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;`
`24`	`24`	`private readonly ResourceTypeSchemaGenerator _resourceTypeSchemaGenerator;`
`25`	`25`	`private readonly Func<ResourceTypeInfo, ResourceFieldObjectSchemaBuilder> _resourceFieldObjectSchemaBuilderFactory;`
	`26`	`+ private readonly ResourceObjectDocumentationReader _resourceObjectDocumentationReader;`
`26`	`27`
`27`	`28`	`public ResourceObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceGraph resourceGraph, IJsonApiOptions options,`
`28`	`29`	`ISchemaRepositoryAccessor schemaRepositoryAccessor, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider)`
`@@ -42,6 +43,8 @@ public ResourceObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IRe`
`42`	`43`
`43`	`44`	`_resourceFieldObjectSchemaBuilderFactory = resourceTypeInfo => new ResourceFieldObjectSchemaBuilder(resourceTypeInfo, schemaRepositoryAccessor,`
`44`	`45`	`defaultSchemaGenerator, _resourceTypeSchemaGenerator, options.SerializerOptions.PropertyNamingPolicy, resourceFieldValidationMetadataProvider);`
	`46`	`+`
	`47`	`+ _resourceObjectDocumentationReader = new ResourceObjectDocumentationReader();`
`45`	`48`	`}`
`46`	`49`
`47`	`50`	`public OpenApiSchema GenerateSchema(Type resourceObjectType)`
`@@ -55,7 +58,7 @@ public OpenApiSchema GenerateSchema(Type resourceObjectType)`
`55`	`58`
`56`	`59`	`RemoveResourceIdIfPostResourceObject(resourceTypeInfo, fullSchemaForResourceObject);`
`57`	`60`
`58`		`- SetResourceType(fullSchemaForResourceObject, resourceTypeInfo.ResourceType.ClrType);`
	`61`	`+ SetResourceType(fullSchemaForResourceObject, resourceTypeInfo.ResourceType);`
`59`	`62`
`60`	`63`	`SetResourceAttributes(fullSchemaForResourceObject, fieldObjectBuilder);`
`61`	`64`
`@@ -96,9 +99,11 @@ private void RemoveResourceIdIfPostResourceObject(ResourceTypeInfo resourceTypeI`
`96`	`99`	`}`
`97`	`100`	`}`
`98`	`101`
`99`		`- private void SetResourceType(OpenApiSchema fullSchemaForResourceObject, Type resourceType)`
	`102`	`+ private void SetResourceType(OpenApiSchema fullSchemaForResourceObject, ResourceType resourceType)`
`100`	`103`	`{`
`101`		`- fullSchemaForResourceObject.Properties[JsonApiPropertyName.Type] = _resourceTypeSchemaGenerator.Get(resourceType);`
	`104`	`+ fullSchemaForResourceObject.Properties[JsonApiPropertyName.Type] = _resourceTypeSchemaGenerator.Get(resourceType.ClrType);`
	`105`	`+`
	`106`	`+ fullSchemaForResourceObject.Description = _resourceObjectDocumentationReader.GetDocumentationForType(resourceType);`
`102`	`107`	`}`
`103`	`108`
`104`	`109`	`private void SetResourceAttributes(OpenApiSchema fullSchemaForResourceObject, ResourceFieldObjectSchemaBuilder builder)`
Original file line number	Diff line number	Diff line change
`@@ -28,5 +28,7 @@ protected override void SetupSwaggerGenAction(SwaggerGenOptions options)`
`28`	`28`	`Url = new Uri("https://licenses.nuget.org/MIT")`
`29`	`29`	`}`
`30`	`30`	`});`
	`31`	`+`
	`32`	`+ base.SetupSwaggerGenAction(options);`
`31`	`33`	`}`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace OpenApiTests.LegacyOpenApiIntegration;`
`4`	`4`
	`5`	`+/// <summary>`
	`6`	`+/// Lists the various airlines used in this API.`
	`7`	`+/// </summary>`
`5`	`8`	`[UsedImplicitly(ImplicitUseTargetFlags.Members)]`
`6`	`9`	`public enum Airline : byte`
`7`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System.Reflection;`
`1`	`2`	`using JsonApiDotNetCore.Configuration;`
`2`	`3`	`using JsonApiDotNetCore.OpenApi;`
`3`	`4`	`using Microsoft.AspNetCore.Builder;`
`@@ -21,6 +22,8 @@ public override void ConfigureServices(IServiceCollection services)`
`21`	`22`
`22`	`23`	`protected virtual void SetupSwaggerGenAction(SwaggerGenOptions options)`
`23`	`24`	`{`
	`25`	`+ string documentationPath = Path.ChangeExtension(Assembly.GetExecutingAssembly().Location, ".xml");`
	`26`	`+ options.IncludeXmlComments(documentationPath);`
`24`	`27`	`}`
`25`	`28`
`26`	`29`	`public override void Configure(IApplicationBuilder app)`