docs: atualização do endpoint de cadastro do usuário (#42)

* docs: atualização do endpoint de cadastro do usuário

* docs: adicionei o name,reapeatPassowrd,username em req

* docs: "corrigir erros de cody style"

.github/pull_request_template.md

@@ -0,0 +1,56 @@
+Closes
+
+<details open> 
+  <summary>
+    <b>Feature</b>
+  </summary>
+
+N/A
+
+</details>
+
+<details open> 
+  <summary>
+    <b>Bugfix</b>
+  </summary>
+
+- **Description**
+  N/A
+
+- **Cause**
+  N/A
+
+- **Solution**
+N/A
+</details>
+
+<details> 
+  <summary>
+    <b>Changelog</b>
+  </summary>
+N/A
+</details>
+
+<details open> 
+  <summary>
+    <b>Visual evidences :framed_picture:</b>
+  </summary>
+
+</details>
+
+<details open> 
+  <summary>
+    <b>Checklist</b>
+  </summary>
+
+- [ ] Issue linked
+- [ ] Build working correctly
+- [ ] Tests created
+</details>
+
+<details> 
+  <summary>
+    <b>Additional info</b>
+  </summary>
+N/A
+</details>

openapi/features/user/components/user-create-body.yaml

@@ -4,14 +4,30 @@ content:
     schema:
       type: object
       properties:
-        password:
+        name:
           type: string
-          description: Password for the new user account
-          example: 'alexandre-123'
+          description: User account name
+          example: 'John Doe'
+        username:
+          type: string
+          description: User name
+          example: 'johndoe123'
         email:
           type: string
           description: Email address for the new user account
-          example: 'alexandre@gmail.com'
+          example: 'johndoe@example.com'
+        password:
+          type: string
+          description: Password for the new user account
+          example: '001@Mypassword'
+        repeatPassword:
+          type: string
+          description: Confirming the user's new password
+          example: '001@Mypassword'
+
       required:
-        - password
+        - name
+        - username
         - email
+        - password
+        - repeatPassword

openapi/features/user/user-create-path.yaml

@@ -9,8 +9,8 @@ post:
     $ref: './components/user-create-body.yaml'
 
   responses:
-    '204':
-      description: User account created successfully
+    '201':
+      description: N/A
     '400':
       $ref: '../../shared/errors/validation-error.yaml'
     '500':

openapi/main.yaml

@@ -11,5 +11,5 @@ tags:
   - name: user
     description: Operations about user
 paths:
-  /user/create:
+  /api/users:
     $ref: './features/user/user-create-path.yaml'