Minor doc updates

AnalogIO · Jan 13, 2022 · 3917a24 · 3917a24
1 parent 143e58b
commit 3917a24
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/coffeecard/CoffeeCard.Models/DataTransferObjects/User/LoginDTO.cs b/coffeecard/CoffeeCard.Models/DataTransferObjects/User/LoginDTO.cs
@@ -35,7 +35,7 @@ public class LoginDto
         /// App version of device logging in
         /// </summary>
         /// <value>App version</value>
-        /// <example>2.0.0</example>
+        /// <example>2.1.0</example>
         [Required]
         public string Version { get; set; }
     }

diff --git a/coffeecard/CoffeeCard.Models/DataTransferObjects/User/RegisterDTO.cs b/coffeecard/CoffeeCard.Models/DataTransferObjects/User/RegisterDTO.cs
@@ -9,7 +9,7 @@ namespace CoffeeCard.Models.DataTransferObjects.User
     /// {
     ///     "name": "John Doe",
     ///     "email": "john@doe.com",
-    ///     "password": "0ffe1abd1a08215353c233d6e009613e95eec4253832a761af28ff37ac5a150c"
+    ///     "password": "[no example provided]"
     /// }
     /// </example>
     public class RegisterDto
@@ -32,10 +32,10 @@ public class RegisterDto
         public string Email { get; set; }
 
         /// <summary>
-        /// Pin Code as first SHA256, then Base64 encoded string
+        /// Pin Code as first UTF8 encoded, then SHA256 hashed, and then Base64 encoded string
         /// </summary>
         /// <value>Password</value>
-        /// <example>no example provided</example>
+        /// <example>[no example provided]</example>
         [Required]
         public string Password { get; set; }
     }

diff --git a/coffeecard/CoffeeCard.Models/DataTransferObjects/User/UpdateUserDTO.cs b/coffeecard/CoffeeCard.Models/DataTransferObjects/User/UpdateUserDTO.cs
@@ -11,7 +11,7 @@ namespace CoffeeCard.Models.DataTransferObjects.User
     ///     "email": "john@doe.com",
     ///     "privacyActivated": true,
     ///     "programmeId": 1,
-    ///     "password": "0ffe1abd1a08215353c233d6e009613e95eec4253832a761af28ff37ac5a150c"
+    ///     "password": "[no example provided]"
     /// }
     /// </example>
     public class UpdateUserDto
@@ -46,10 +46,10 @@ public class UpdateUserDto
         public int? ProgrammeId { get; set; }
 
         /// <summary>
-        /// Pin Code as first SHA256, then Base64 encoded string
+        /// Pin Code as first UTF8 encoded, then SHA256 hashed, and then Base64 encoded string
         /// </summary>
         /// <value>Pin code</value>
-        /// <example>no example provided</example>
+        /// <example>[no example provided]</example>
         public string Password { get; set; }
     }
 }