Merge pull request #86 from IT-Academy-BCN/hotfix/swaggerDocs

[BE] Add code filed to users register Swagger Documentation #79
IT-Academy-BCN · Sep 25, 2023 · 0e48f90 · 0e48f90
2 parents bc6d50e + e26717d
commit 0e48f90
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 56 deletions.
diff --git a/app/Http/Controllers/api/UserController.php b/app/Http/Controllers/api/UserController.php
@@ -54,6 +54,11 @@ class UserController extends Controller
  *           property="password_confirmation",
  *           type="string",
  *           example="password123"
+ *         ),
+ *         @OA\Property(
+ *           property="code",
+ *           type="string",
+ *           example="A1BC23D"
  *         )
  *       )
  *     )

diff --git a/storage/api-docs/api-docs.json b/storage/api-docs/api-docs.json
@@ -202,62 +202,6 @@
                 ]
             }
         },
-        "/collaborators/{area}": {
-            "get": {
-                "tags": [
-                    "Collaborators"
-                ],
-                "summary": "User Collaborators",
-                "description": "This endpoint is used to get persons that work on the specific project",
-                "operationId": "76c6c77e7057fbc3ba434dc982216781",
-                "parameters": [
-                    {
-                        "name": "area",
-                        "in": "path",
-                        "description": "name of the area",
-                        "required": true,
-                        "schema": {
-                            "type": "string",
-                            "example": "landing"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Collaborators details.",
-                        "content": {
-                            "application/json": {
-                                "schema": {
-                                    "properties": {
-                                        "rows": {
-                                            "type": "array",
-                                            "items": {
-                                                "properties": {
-                                                    "name": {
-                                                        "type": "string",
-                                                        "example": "CloudSalander"
-                                                    },
-                                                    "photo": {
-                                                        "type": "string",
-                                                        "example": "https://avatars.githubusercontent.com/u/1247767?v=4"
-                                                    },
-                                                    "url": {
-                                                        "type": "string",
-                                                        "example": "https://api.github.com/users/CloudSalander"
-                                                    }
-                                                },
-                                                "type": "object"
-                                            }
-                                        }
-                                    },
-                                    "type": "object"
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        },
         "/login": {
             "post": {
                 "tags": [
@@ -390,6 +334,62 @@
                 ]
             }
         },
+        "/collaborators/{area}": {
+            "get": {
+                "tags": [
+                    "Collaborators"
+                ],
+                "summary": "User Collaborators",
+                "description": "This endpoint is used to get persons that work on the specific project",
+                "operationId": "76c6c77e7057fbc3ba434dc982216781",
+                "parameters": [
+                    {
+                        "name": "area",
+                        "in": "path",
+                        "description": "name of the area",
+                        "required": true,
+                        "schema": {
+                            "type": "string",
+                            "example": "landing"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Collaborators details.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "properties": {
+                                        "rows": {
+                                            "type": "array",
+                                            "items": {
+                                                "properties": {
+                                                    "name": {
+                                                        "type": "string",
+                                                        "example": "CloudSalander"
+                                                    },
+                                                    "photo": {
+                                                        "type": "string",
+                                                        "example": "https://avatars.githubusercontent.com/u/1247767?v=4"
+                                                    },
+                                                    "url": {
+                                                        "type": "string",
+                                                        "example": "https://api.github.com/users/CloudSalander"
+                                                    }
+                                                },
+                                                "type": "object"
+                                            }
+                                        }
+                                    },
+                                    "type": "object"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/faqs": {
             "get": {
                 "tags": [
@@ -588,6 +588,10 @@
                                     "password_confirmation": {
                                         "type": "string",
                                         "example": "password123"
+                                    },
+                                    "code": {
+                                        "type": "string",
+                                        "example": "A1BC23D"
                                     }
                                 },
                                 "type": "object"
@@ -650,6 +654,10 @@
                         "application/json": {
                             "schema": {
                                 "properties": {
+                                    "token": {
+                                        "type": "string",
+                                        "example": "abcdefghij"
+                                    },
                                     "password": {
                                         "type": "string",
                                         "example": "password"