Merge pull request #22 from IgniteUI/cpi/enrich-swagger-metadata

Enrich swagger metadata

Author: claudiopi

NorthwindCRUD/Models/Dtos/EmployeeDto.cs

@@ -1,32 +1,45 @@
 namespace NorthwindCRUD.Models.Dtos
 {
     using NorthwindCRUD.Models.Contracts;
+    using Swashbuckle.AspNetCore.Annotations;
     using System.ComponentModel.DataAnnotations;
 
     public class EmployeeDto : IEmployee
     {
+        [SwaggerSchema("Number automatically assigned to new employee.")]
+        [MinLength(8)] // Min length comes from IdGenerator.CreateDigitsId
+        [Required]
         public int EmployeeId { get; set; }
 
+        [SwaggerSchema("Employee's last name.")]
         public string LastName { get; set; }
 
+        [SwaggerSchema("Employee's first name.")]
         public string FirstName { get; set; }
 
+        [SwaggerSchema("Employee's title")]
         public string Title { get; set; }
 
+        [SwaggerSchema("Title used in salutations")]        
         public string TitleOfCourtesy { get; set; }
 
+        [SwaggerSchema("Employee's birth date", Format = "date")]
         public string BirthDate { get; set; }
 
+        [SwaggerSchema("Employee's hire date", Format = "date")]
         public string HireDate { get; set; }
 
         public string AddressId { get; set; }
 
         public AddressDto Address { get; set; }
-
+        
+        [SwaggerSchema("General information about employee's background.")]
         public string Notes { get; set; }
 
+        [SwaggerSchema("Employee's avatar url.", Format = "uri")]
         public string AvatarUrl { get; set; }
 
+        [SwaggerSchema("Employee's supervisor.")]
         public int ReportsTo { get; set; }
     }
 }

NorthwindCRUD/NorthwindCRUD.csproj

@@ -27,6 +27,7 @@
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.10" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0" />
   </ItemGroup>
 
 </Project>

NorthwindCRUD/Program.cs

@@ -41,6 +41,7 @@
     });
 
     option.OperationFilter<AuthResponsesOperationFilter>();
+    option.EnableAnnotations();
 });
 
 builder.Services.AddCors(options =>