From e30110bcff0d6f4db86b2fada9bba13ac796c476 Mon Sep 17 00:00:00 2001
From: Jeas0001 <jeas0001@edu.mercantec.dk>
Date: Wed, 7 May 2025 12:30:12 +0200
Subject: [PATCH] Usercontrollers comments

---
 backend/API/Controllers/UserController.cs | 33 +++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/backend/API/Controllers/UserController.cs b/backend/API/Controllers/UserController.cs
index 8bb69eb..28e7ebe 100644
--- a/backend/API/Controllers/UserController.cs
+++ b/backend/API/Controllers/UserController.cs
@@ -17,6 +17,10 @@ namespace API.Controllers
             _userLogic = userLogic;
         }
 
+        /// <summary>
+        /// Gets the users email and username
+        /// </summary>
+        /// <returns>returns the users email, username and Id</returns>
         [Authorize]
         [HttpGet("get")]
         public async Task<IActionResult> ReadUser()
@@ -27,18 +31,33 @@ namespace API.Controllers
             return await _userLogic.GetUser(userId);
         }
 
+        /// <summary>
+        /// Logins a user
+        /// </summary>
+        /// <param name="loginDTO">The users login credentials</param>
+        /// <returns>Returns a jwttoken their username, id and a refreshtoken</returns>
         [HttpPost("login")]
         public async Task<IActionResult> Login([FromBody] LoginDTO loginDTO)
         {
             return await _userLogic.Login(loginDTO);
         }
 
+        /// <summary>
+        /// Create a new user
+        /// </summary>
+        /// <param name="userDTO">contains the username email and password</param>
+        /// <returns>returns a okobjectresult with a boolean that is true if it fails it returns a confliftobjectresult with a message of why it failed</returns>
         [HttpPost("create")]
         public async Task<IActionResult> CreateUser([FromBody] CreateUserDTO userDTO)
         {
             return await _userLogic.RegisterUser(userDTO);
         }
 
+        /// <summary>
+        /// Changes the password of the user
+        /// </summary>
+        /// <param name="passwordDTO">Contains the old password and the new one</param>
+        /// <returns>returns a okobjectresult with a boolean that is true if it fails it returns a confliftobjectresult with a message of why it failed</returns>
         [Authorize]
         [HttpPut("change-password")]
         public async Task<IActionResult> ChangePassword([FromBody] ChangePasswordDTO passwordDTO)
@@ -49,6 +68,11 @@ namespace API.Controllers
             return await _userLogic.ChangePassword(passwordDTO, userId);
         }
 
+        /// <summary>
+        /// Edits the email and username of the user
+        /// </summary>
+        /// <param name="userDTO">The updated username and email</param>
+        /// <returns>returns a okobjectresult with a boolean that is true if it fails it returns a confliftobjectresult with a message of why it failed</returns>
         [Authorize]
         [HttpPut("update")]
         public async Task<IActionResult> UpdateUser([FromBody] UpdateUserDTO userDTO)
@@ -59,6 +83,10 @@ namespace API.Controllers
             return await _userLogic.EditProfile(userDTO, userId);
         }
 
+        /// <summary>
+        /// Deletes the user
+        /// </summary>
+        /// <returns>returns a okobjectresult with a boolean that is true if it fails it returns a confliftobjectresult with a message of why it failed</returns>
         [Authorize]
         [HttpDelete("delete")]
         public async Task<IActionResult> DeleteUser()
@@ -69,6 +97,11 @@ namespace API.Controllers
             return await _userLogic.DeleteUser(userId);
         }
 
+        /// <summary>
+        /// For when the jwt token is outdated
+        /// </summary>
+        /// <param name="refreshToken">contains a string with the refreshtoken</param>
+        /// <returns>returns a new refreshtoken and new jwt token</returns>
         [HttpPost("refreshtoken")]
         public async Task<IActionResult> RefreashToken([FromBody] RefreshTokenDTO refreshToken)
         {