From bdb30d21044814525d9799f71d2b958744c59f51 Mon Sep 17 00:00:00 2001
From: "Collin M. Barrett" <collinbarrett@users.noreply.github.com>
Date: Sun, 4 Oct 2020 16:10:05 -0500
Subject: [PATCH] =?UTF-8?q?docs(archival):=20=F0=9F=93=9D=20document=20end?=
 =?UTF-8?q?points?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 services/Archival/FilterLists.Archival.Api/.editorconfig    | 4 ++++
 .../FilterLists.Archival.Api/Controllers/PingController.cs  | 4 ++++
 .../FilterLists.Archival.Api.csproj                         | 1 +
 .../Archival/FilterLists.Archival.Api/SwaggerExtensions.cs  | 6 ++++++
 4 files changed, 15 insertions(+)
 create mode 100644 services/Archival/FilterLists.Archival.Api/.editorconfig

diff --git a/services/Archival/FilterLists.Archival.Api/.editorconfig b/services/Archival/FilterLists.Archival.Api/.editorconfig
new file mode 100644
index 000000000..bbc524b6f
--- /dev/null
+++ b/services/Archival/FilterLists.Archival.Api/.editorconfig
@@ -0,0 +1,4 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+
+[*.cs]
+dotnet_diagnostic.CS1591.severity = suggestion
\ No newline at end of file
diff --git a/services/Archival/FilterLists.Archival.Api/Controllers/PingController.cs b/services/Archival/FilterLists.Archival.Api/Controllers/PingController.cs
index 9759cc338..75555eba7 100644
--- a/services/Archival/FilterLists.Archival.Api/Controllers/PingController.cs
+++ b/services/Archival/FilterLists.Archival.Api/Controllers/PingController.cs
@@ -8,6 +8,10 @@ namespace FilterLists.Archival.Api.Controllers
     [Produces("application/json")]
     public class PingController : ControllerBase
     {
+        /// <summary>
+        /// A sample endpoint.
+        /// </summary>
+        /// <returns>Pong.</returns>
         [HttpGet]
         [ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
 #pragma warning disable CA1822 // Mark members as static
diff --git a/services/Archival/FilterLists.Archival.Api/FilterLists.Archival.Api.csproj b/services/Archival/FilterLists.Archival.Api/FilterLists.Archival.Api.csproj
index fe3ff2d78..c940621d9 100644
--- a/services/Archival/FilterLists.Archival.Api/FilterLists.Archival.Api.csproj
+++ b/services/Archival/FilterLists.Archival.Api/FilterLists.Archival.Api.csproj
@@ -4,6 +4,7 @@
         <TargetFramework>netcoreapp3.1</TargetFramework>
         <LangVersion>latest</LangVersion>
         <Nullable>enable</Nullable>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PublishReadyToRunShowWarnings>true</PublishReadyToRunShowWarnings>
         <RuntimeIdentifiers>alpine.3.12-x64;win10-x64</RuntimeIdentifiers>
     </PropertyGroup>
diff --git a/services/Archival/FilterLists.Archival.Api/SwaggerExtensions.cs b/services/Archival/FilterLists.Archival.Api/SwaggerExtensions.cs
index 765d5ef4d..8a0c92fdd 100644
--- a/services/Archival/FilterLists.Archival.Api/SwaggerExtensions.cs
+++ b/services/Archival/FilterLists.Archival.Api/SwaggerExtensions.cs
@@ -1,5 +1,7 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
+using System.Reflection;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Models;
@@ -25,6 +27,10 @@ public static void AddSwaggerGen(this IServiceCollection services)
                         Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE")
                     }
                 });
+
+                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
+                o.IncludeXmlComments(xmlPath);
             });
         }