Merge pull request #85 from TransactionProcessing/task/#81_swaggerreview

Add xml comments to swagger

Author: StuartFerguson

TransactionProcessorACL.BusinessLogic/TransactionProcessorACL.BusinessLogic.csproj

@@ -6,9 +6,9 @@
 
   <ItemGroup>
     <PackageReference Include="MediatR" Version="9.0.0" />
-    <PackageReference Include="SecurityService.Client" Version="1.0.5" />
+    <PackageReference Include="SecurityService.Client" Version="1.0.5.1" />
     <PackageReference Include="Shared" Version="1.0.5" />
-    <PackageReference Include="TransactionProcessor.Client" Version="1.0.11.1" />
+    <PackageReference Include="TransactionProcessor.Client" Version="1.0.11.2" />
   </ItemGroup>
 
   <ItemGroup>

TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.csproj

@@ -4,6 +4,10 @@
 	  <TargetFrameworks>net5.0;netstandard2.0</TargetFrameworks>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|net5.0|AnyCPU'">
+    <DocumentationFile>D:\Projects\StuartFerguson\TransactionProcessorACL\TransactionProcessorACL.DataTransferObjects\TransactionProcessorACL.DataTransferObjects.xml</DocumentationFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
   </ItemGroup>

TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.xml

@@ -9,20 +9,20 @@
   <ItemGroup>
     <PackageReference Include="ClientProxyBase" Version="1.0.5" />
     <PackageReference Include="Ductus.FluentDocker" Version="2.7.3" />
-    <PackageReference Include="EstateManagement.Client" Version="1.0.9" />
+    <PackageReference Include="EstateManagement.Client" Version="1.0.9.2" />
     <PackageReference Include="EstateReporting.Database" Version="1.0.12" />
     <PackageReference Include="EventStore.Client.Grpc.PersistentSubscriptions" Version="20.10.0" />
     <PackageReference Include="EventStore.Client.Grpc.ProjectionManagement" Version="20.10.0" />
     <PackageReference Include="Grpc.Net.Client" Version="2.35.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="5.0.2" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
-    <PackageReference Include="SecurityService.Client" Version="1.0.5" />
+    <PackageReference Include="SecurityService.Client" Version="1.0.5.1" />
     <PackageReference Include="Shared.IntegrationTesting" Version="1.0.5" />
     <PackageReference Include="Shouldly" Version="4.0.3" />
     <PackageReference Include="SpecFlow" Version="3.5.14" />
     <PackageReference Include="SpecFlow.Tools.MsBuild.Generation" Version="3.5.14" />
     <PackageReference Include="SpecFlow.xUnit" Version="3.5.14" />
-    <PackageReference Include="TransactionProcessor.Client" Version="1.0.11.1" />
+    <PackageReference Include="TransactionProcessor.Client" Version="1.0.11.2" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>

TransactionProcessorACL.IntegrationTests/TransactionProcessorACL.IntegrationTests.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="TransactionProcessor.Client" Version="1.0.11.1" />
+    <PackageReference Include="TransactionProcessor.Client" Version="1.0.11.2" />
   </ItemGroup>
 
   <ItemGroup>

TransactionProcessorACL.Testing/TransactionProcessorACL.Testing.csproj

@@ -132,6 +132,16 @@ private void ConfigureMiddlewareServices(IServiceCollection services)
                 // add a custom operation filter which sets default values
                 c.OperationFilter<SwaggerDefaultValues>();
                 c.ExampleFilters();
+
+                //Locate the XML files being generated by ASP.NET...
+                var directory = new DirectoryInfo(AppContext.BaseDirectory);
+                var xmlFiles = directory.GetFiles("*.xml");
+
+                //... and tell Swagger to use those XML comments.
+                foreach (FileInfo fileInfo in xmlFiles)
+                {
+                    c.IncludeXmlComments(fileInfo.FullName);
+                }
             });
 
             services.AddSwaggerExamplesFromAssemblyOf<SwaggerJsonConverter>();

TransactionProcessorACL/Startup.cs

@@ -5,6 +5,10 @@
     <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>D:\Projects\StuartFerguson\TransactionProcessorACL\TransactionProcessorACL\TransactionProcessorACL.xml</DocumentationFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="5.0.1" />
     <PackageReference Include="AspNetCore.HealthChecks.Uris" Version="5.0.1" />