Merge pull request #52 from TransactionProcessing/documentation/#47_swaggerpages

Minor swagger updates

Author: StuartFerguson

MessagingService.DataTransferObjects/MessagingService.DataTransferObjects.csproj

@@ -1,9 +1,13 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
 	  <TargetFrameworks>net5.0;netstandard2.0</TargetFrameworks>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|net5.0|AnyCPU'">
+    <DocumentationFile>D:\Projects\StuartFerguson\Messaging\MessagingService.DataTransferObjects\MessagingService.DataTransferObjects.xml</DocumentationFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
   </ItemGroup>

MessagingService.DataTransferObjects/MessagingService.DataTransferObjects.xml

@@ -22,6 +22,7 @@
     [Route(DomainEventController.ControllerRoute)]
     [ApiController]
     [ExcludeFromCodeCoverage]
+    [ApiExplorerSettings(IgnoreApi = true)]
     public class DomainEventController : ControllerBase
     {
         #region Fields

MessagingService/Controllers/DomainEventController.cs

@@ -49,19 +49,17 @@ public EmailController(IMediator mediator)
         #endregion
 
         #region Methods
-
+        
         /// <summary>
-        /// Posts the email.
+        /// Sends the email.
         /// </summary>
         /// <param name="sendEmailRequest">The send email request.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns></returns>
         [HttpPost]
         [Route("")]
-        [SwaggerResponse(201, "Created", typeof(SendEmailResponseDTO))]
-        [SwaggerResponseExample(201, typeof(SendEmailResponseExample))]
-
-        public async Task<IActionResult> PostEmail([FromBody] SendEmailRequestDTO sendEmailRequest,
+        [ProducesResponseType(typeof(SendEmailResponseDTO), 201)]
+        public async Task<IActionResult> SendEmail([FromBody] SendEmailRequestDTO sendEmailRequest,
                                                    CancellationToken cancellationToken)
         {
             // Reject password tokens

MessagingService/Controllers/EmailController.cs

@@ -42,18 +42,17 @@ public SMSController(IMediator mediator)
         #endregion
 
         #region Methods
-
+        
         /// <summary>
-        /// Posts the sms.
+        /// Sends the SMS.
         /// </summary>
         /// <param name="sendSMSRequest">The send SMS request.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns></returns>
         [HttpPost]
         [Route("")]
-        [SwaggerResponse(201, "Created", typeof(SendSMSResponse))]
-        [SwaggerResponseExample(201, typeof(SendSMSResponseExample))]
-        public async Task<IActionResult> PostSMS([FromBody] SendSMSRequest sendSMSRequest,
+        [ProducesResponseType(typeof(SendSMSResponse), 201)]
+        public async Task<IActionResult> SendSMS([FromBody] SendSMSRequest sendSMSRequest,
                                                    CancellationToken cancellationToken)
         {
             // Reject password tokens

MessagingService/Controllers/SMSController.cs

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