add more xml docs and examples

Barsonax · May 9, 2024 · 879d68e · 879d68e
1 parent ce3e77b
commit 879d68e
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/.run/CleanAspCore.run.xml b/.run/CleanAspCore.run.xml
@@ -12,7 +12,6 @@
     <option name="ADDITIONAL_IIS_EXPRESS_ARGUMENTS" value="" />
     <method v="2">
       <option name="Build" default="false" projectName="CleanAspCore" projectPath="$PROJECT_DIR$/CleanAspCore/CleanAspCore.csproj" />
-      <option name="RunConfigurationTask" enabled="true" run_configuration_name="Run db" run_configuration_type="docker-deploy" />
     </method>
   </configuration>
 </component>
diff --git a/CleanAspCore/Features/Employees/Endpoints/AddEmployee.cs b/CleanAspCore/Features/Employees/Endpoints/AddEmployee.cs
@@ -13,11 +13,13 @@ public sealed class CreateEmployeeRequest
     /// <summary>
     /// The firstname of this employee.
     /// </summary>
+    /// <example>Mary</example>
     public required string FirstName { get; init; }
 
     /// <summary>
     /// The lastname of this employee.
     /// </summary>
+    /// <example>Poppins</example>
     public required string LastName { get; init; }
 
     /// <summary>
@@ -28,6 +30,7 @@ public sealed class CreateEmployeeRequest
     /// <summary>
     /// The gender of this employee.
     /// </summary>
+    /// <example>Female</example>
     public required string Gender { get; init; }
 
     /// <summary>

diff --git a/CleanAspCore/Features/Employees/Endpoints/GetEmployeeById.cs b/CleanAspCore/Features/Employees/Endpoints/GetEmployeeById.cs
@@ -6,28 +6,58 @@
 namespace CleanAspCore.Features.Employees.Endpoints;
 
 /// <summary>
-/// 
+///
 /// </summary>
 public sealed class GetEmployeeResponse
 {
+    /// <summary>
+    /// The id of this employee.
+    /// </summary>
     public required Guid Id { get; init; }
+
+    /// <summary>
+    /// The firstname of this employee.
+    /// </summary>
+    /// <example>Mary</example>
     public required string FirstName { get; init; }
+
+    /// <summary>
+    /// The lastname of this employee.
+    /// </summary>
+    /// <example>Poppins</example>
     public required string LastName { get; init; }
+
+    /// <summary>
+    /// The email of this employee.
+    /// </summary>
     public required string Email { get; init; }
+
+    /// <summary>
+    /// The gender of this employee.
+    /// </summary>
+    /// <example>Female</example>
     public required string Gender { get; init; }
+
+    /// <summary>
+    /// The department id of which this employee is in.
+    /// </summary>
     public required Guid DepartmentId { get; init; }
+
+    /// <summary>
+    /// The job id of this employee.
+    /// </summary>
     public required Guid JobId { get; init; }
 }
 
 internal static class GetEmployeeById
 {
-    internal static async Task<JsonHttpResult<GetEmployeeResponse>> Handle(Guid id, HrContext context, CancellationToken cancellationToken)
+    internal static async Task<Ok<GetEmployeeResponse>> Handle(Guid id, HrContext context, CancellationToken cancellationToken)
     {
         var result = await context.Employees
             .Where(x => x.Id == id)
             .Select(x => x.ToDto())
             .FirstAsync(cancellationToken);
-        return TypedResults.Json(result);
+        return TypedResults.Ok(result);
     }
 
     private static GetEmployeeResponse ToDto(this Employee employee) => new()