docs: create delete user by id doc (#210)

* docs: create delete user by id doc * fix: update param to userID * docs: exec make swag * docs: update param
devhatt · Oct 1, 2024 · 42b37eb · 42b37eb
1 parent b81e895
commit 42b37eb
Show file tree

Hide file tree

Showing 5 changed files with 95 additions and 3 deletions.
diff --git a/api/controllers/user.go b/api/controllers/user.go
@@ -186,6 +186,16 @@ func (uc *UserController) FindByID(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusOK)
 }
 
+// Delete user
+// @Summary Delete user
+// @Description Marks a user as deleted (soft delete) without removing them from the database
+// @Tags User
+// @Param userID path string true "User ID"
+// @Success 204 "No Content"
+// @Failure 400 "Bad request"
+// @Failure 401 "Unauthorized"
+// @Failure 500 "Internal server error"
+// @Router /user/{userID} [delete]
 func (uc *UserController) Delete(w http.ResponseWriter, r *http.Request) {
 	userIDFromTokenStr := r.Header.Get("UserId")
 	userIDFromToken, err := uniqueEntityId.ParseID(userIDFromTokenStr)
@@ -195,7 +205,7 @@ func (uc *UserController) Delete(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	IDStr := chi.URLParam(r, "id")
+	IDStr := chi.URLParam(r, "userID")
 	ID, err := uniqueEntityId.ParseID(IDStr)
 	if err != nil {
 		uc.logger.Error("[#UserController.Delete] Erro ao tentar converter o body da requisição -> Erro: ", err)
@@ -212,10 +222,11 @@ func (uc *UserController) Delete(w http.ResponseWriter, r *http.Request) {
 	err = uc.usecase.Delete(ID)
 	if err != nil {
 		uc.logger.Error("[#UserController.Delete] Erro ao tentar deletar o usuário -> Erro: ", err)
-		http.Error(w, "Erro ao tentar atualizar o usuário ", http.StatusBadRequest)
+		http.Error(w, "Erro ao tentar atualizar o usuário ", http.StatusInternalServerError)
 		return
 	}
 
+	w.WriteHeader(http.StatusNoContent)
 }
 
 // Enable push notifications

diff --git a/api/routes/routes.go b/api/routes/routes.go
@@ -46,7 +46,7 @@ func InitRoutes(controllers Controllers, c *chi.Mux) {
 				r.Patch("/{userID}/pets/{petID}", controllers.PetController.Update)
 				r.Patch("/{userID}", controllers.UserController.Update)
 				r.Get("/{userID}", controllers.UserController.FindByID)
-				r.Delete("/{id}", controllers.UserController.Delete)
+				r.Delete("/{userID}", controllers.UserController.Delete)
 			})
 			private.Route("/settings", func(r chi.Router) {
 				r.Patch("/push-notifications", controllers.UserController.UpdatePushNotificationSettings)

diff --git a/swagger/docs.go b/swagger/docs.go
@@ -529,6 +529,36 @@ const docTemplate = `{
                     }
                 }
             },
+            "delete": {
+                "description": "Marks a user as deleted (soft delete) without removing them from the database",
+                "tags": [
+                    "User"
+                ],
+                "summary": "Delete user",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "User ID",
+                        "name": "userID",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "204": {
+                        "description": "No Content"
+                    },
+                    "400": {
+                        "description": "Bad request"
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    },
+                    "500": {
+                        "description": "Internal server error"
+                    }
+                }
+            },
             "patch": {
                 "description": "Updates the details of an existing user based on the provided user ID and payload",
                 "consumes": [

diff --git a/swagger/swagger.json b/swagger/swagger.json
@@ -523,6 +523,36 @@
                     }
                 }
             },
+            "delete": {
+                "description": "Marks a user as deleted (soft delete) without removing them from the database",
+                "tags": [
+                    "User"
+                ],
+                "summary": "Delete user",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "User ID",
+                        "name": "userID",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "204": {
+                        "description": "No Content"
+                    },
+                    "400": {
+                        "description": "Bad request"
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    },
+                    "500": {
+                        "description": "Internal server error"
+                    }
+                }
+            },
             "patch": {
                 "description": "Updates the details of an existing user based on the provided user ID and payload",
                 "consumes": [

diff --git a/swagger/swagger.yaml b/swagger/swagger.yaml
@@ -640,6 +640,27 @@ paths:
       tags:
       - User
   /user/{userID}:
+    delete:
+      description: Marks a user as deleted (soft delete) without removing them from
+        the database
+      parameters:
+      - description: User ID
+        in: path
+        name: userID
+        required: true
+        type: string
+      responses:
+        "204":
+          description: No Content
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+      summary: Delete user
+      tags:
+      - User
     get:
       consumes:
       - application/json