From 1ce1f355c01cac81c116d28db8389ddbea65b153 Mon Sep 17 00:00:00 2001
From: Jeas0001 <jeas0001@edu.mercantec.dk>
Date: Wed, 7 May 2025 11:28:21 +0200
Subject: [PATCH] Recipecontroller comments

---
 backend/API/Controllers/RecipeController.cs | 37 +++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/backend/API/Controllers/RecipeController.cs b/backend/API/Controllers/RecipeController.cs
index 5fa9bdf..d2c65ea 100644
--- a/backend/API/Controllers/RecipeController.cs
+++ b/backend/API/Controllers/RecipeController.cs
@@ -20,6 +20,10 @@ namespace API.Controllers
             _openAiRecipes = openAiRecipes;
         }
 
+        /// <summary>
+        /// Gets the userId from the jwt token amd returns a list of recipes without their ingredients and directions
+        /// </summary>
+        /// <returns>returns a okobjectresult with a list of recipes if it fails it returns a confliftobjectresult with a message of why it failed</returns>
         [Authorize]
         [HttpGet("getall")]
         public async Task<IActionResult> ReadRecipes()
@@ -30,6 +34,11 @@ namespace API.Controllers
             return await _recipeLogic.GetRecipes(userId);
         }
 
+        /// <summary>
+        /// Gets a specifik recipe including the ingredients and directions
+        /// </summary>
+        /// <param name="recipeId">The recipe that is you want</param>
+        /// <returns>returns a okobjectresult with a recipe if it fails it returns a confliftobjectresult with a message of why it failed</returns>
         [Authorize]
         [HttpGet("get/{recipeId}")]
         public async Task<IActionResult> ReadRecipe(int recipeId)
@@ -37,13 +46,27 @@ namespace API.Controllers
             return await _recipeLogic.GetRecipe(recipeId);
         }
 
+        /// <summary>
+        /// Creates a recipe and adds it to the users recipes
+        /// </summary>
+        /// <param name="recipe">The recipe to be added</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]
         [HttpPost("create/{RecipesId}")]
-        public async Task<IActionResult> CreateRecipe([FromBody] RecipeDTO recipe, int RecipesId)
+        public async Task<IActionResult> CreateRecipe([FromBody] RecipeDTO recipe)
         {
-            return await _recipeLogic.CreateRecipe(recipe, RecipesId);
+            var claims = HttpContext.User.Claims;
+            string userIdString = claims.FirstOrDefault(c => c.Type == ClaimTypes.NameIdentifier).Value;
+            int userId = Convert.ToInt32(userIdString);
+            return await _recipeLogic.CreateRecipe(recipe, userId);
         }
 
+        /// <summary>
+        /// Edits a recipe
+        /// </summary>
+        /// <param name="recipe">the edited recipe</param>
+        /// <param name="recipeId">the recipe to be edited</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("edit/{recipeId}")]
         public async Task<IActionResult> EditRecipe([FromBody] RecipeDTO recipe, int recipeId)
@@ -54,6 +77,11 @@ namespace API.Controllers
             return await _recipeLogic.EditRecipe(recipe, recipeId, userId);
         }
 
+        /// <summary>
+        /// Deletess a recipe
+        /// </summary>
+        /// <param name="recipeId">the id of the recipe to be deleted</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]
         [HttpDelete("delete/{recipeId}")]
         public async Task<IActionResult> DeleteRecipe(int recipeId)
@@ -61,6 +89,11 @@ namespace API.Controllers
             return await _recipeLogic.DeleteRecipe(recipeId);
         }
 
+        /// <summary>
+        /// Generates a recipe using chatgpt
+        /// </summary>
+        /// <param name="recipeDTO">Contains all the infomation that is needed to generate a recipe</param>
+        /// <returns>returns a list of generated recipes</returns>
         [Authorize]
         [HttpPost("chatbot")]
         public async Task<IActionResult> GenerateRecipe([FromBody] GenerateRecipeDTO recipeDTO)