Added XML comments to Swagger documentation

Author: rxtur

src/App/Startup.cs

@@ -13,7 +13,9 @@
 using Microsoft.Extensions.DependencyInjection;
 using Serilog;
 using Serilog.Events;
+using System;
 using System.Globalization;
+using System.IO;
 using System.Reflection;
 
 namespace App
@@ -109,6 +111,7 @@ public void ConfigureServices(IServiceCollection services)
                         Title = "Blogifier API",
                         Version = "1"
                     });
+                setupAction.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "CoreAPI.xml"));
             });
 
             services.AddAppServices();

src/Core/Api/AssetsController.cs

@@ -23,6 +23,13 @@ public AssetsController(IDataService data, IStorageService store)
             _store = store;
         }
 
+        /// <summary>
+        /// Get list of assets - user saved images and files
+        /// </summary>
+        /// <param name="page">Page number</param>
+        /// <param name="filter">filterImages or filterAttachments</param>
+        /// <param name="search">Search term</param>
+        /// <returns>Model containing collection of assets and Pager object</returns>
         [HttpGet]
         public async Task<AssetsModel> Get(int page = 1, string filter = "", string search = "")
         {
@@ -59,6 +66,13 @@ public async Task<AssetsModel> Get(int page = 1, string filter = "", string sear
             };
         }
 
+        /// <summary>
+        /// Select an asset in the File Manager to include in the post
+        /// </summary>
+        /// <param name="type">Type of asset (post cover, logo, avatar or post image/attachment)</param>
+        /// <param name="asset">Selected asset</param>
+        /// <param name="post">Post ID</param>
+        /// <returns>Asset Item</returns>
         [HttpGet("pick")]
         public async Task<AssetItem> Pick(string type, string asset, string post)
         {
@@ -95,6 +109,11 @@ public async Task<AssetItem> Pick(string type, string asset, string post)
             return item.FirstOrDefault();
         }
 
+        /// <summary>
+        /// Upload file(s) to user data store
+        /// </summary>
+        /// <param name="files">Selected files</param>
+        /// <returns>Success or internal error</returns>
         [HttpPost("upload")]
         public async Task<IActionResult> Upload(ICollection<IFormFile> files)
         {
@@ -112,6 +131,11 @@ public async Task<IActionResult> Upload(ICollection<IFormFile> files)
             }
         }
 
+        /// <summary>
+        /// Remove file from user data store, authentication required
+        /// </summary>
+        /// <param name="url">Relative URL of the file to remove</param>
+        /// <returns></returns>
         [HttpDelete("remove")]
         public IActionResult Remove(string url)
         {

src/Core/Core.csproj

@@ -2,7 +2,12 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.2</TargetFramework>
-    <Version>2.3.1.2</Version>
+    <Version>2.3.1.3</Version>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>CoreAPI.xml</DocumentationFile>
+    <NoWarn>1701;1702;1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -17,4 +22,10 @@
     <PackageReference Include="Sendgrid" Version="9.10.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="CoreAPI.xml">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
 </Project>

src/Core/CoreAPI.xml

@@ -7,6 +7,9 @@ public class Author
     {
         public Author() { }
 
+        /// <summary>
+        /// Author ID
+        /// </summary>
         public int Id { get; set; }
 
         [StringLength(160)]