docs: add edit user data request to swagger API

Author: DanielAraldi

src/main/docs/index.ts

@@ -8,7 +8,7 @@ export default {
     title: 'Clean Node API',
     description:
       'API of surveys in NodeJs using Typescript, TDD, Clean Architecture, Design Patterns and SOLID principles.',
-    version: '1.4.0',
+    version: '1.5.0',
     termsOfService:
       'https://github.com/DanielAraldi/clean-node-api/blob/main/LICENSE',
     contact: {
@@ -21,7 +21,7 @@ export default {
     },
   },
   servers: [{ url: '/api' }],
-  tags: [{ name: 'Login' }, { name: 'Survey' }],
+  tags: [{ name: 'Login' }, { name: 'Survey' }, { name: 'Account' }],
   paths,
   schemas,
   components,

src/main/docs/paths.ts

@@ -1,13 +1,14 @@
 import {
+  accountPath,
   loginPath,
   signUpPath,
   refreshTokenPath,
   surveyPath,
   surveyResultPath,
 } from './paths/';
 
-// API routes
 export default {
+  '/account/edit': accountPath,
   '/login': loginPath,
   '/signup': signUpPath,
   '/refresh': refreshTokenPath,

src/main/docs/paths/account-path.ts

@@ -0,0 +1,31 @@
+export const accountPath = {
+  put: {
+    security: [{ apiKeyAuth: [] }],
+    tags: ['Account'],
+    summary: 'Update for name and e-mail.',
+    description: 'Change name and e-mail user. Made only by logged in users.',
+    requestBody: {
+      content: {
+        'application/json': {
+          schema: {
+            $ref: '#/schemas/accountEditParams',
+          },
+        },
+      },
+    },
+    responses: {
+      204: {
+        description: 'Request made successfully, your data was edited!',
+      },
+      403: {
+        $ref: '#/components/forbidden',
+      },
+      404: {
+        $ref: '#/components/notFound',
+      },
+      500: {
+        $ref: '#/components/serverError',
+      },
+    },
+  },
+};

src/main/docs/paths/index.ts

@@ -1,3 +1,4 @@
+export * from './account-path';
 export * from './login-path';
 export * from './refresh-token-path';
 export * from './signup-path';

src/main/docs/schemas.ts

@@ -1,5 +1,6 @@
 import {
   accountSchema,
+  accountEditParamsSchema,
   loginParamsSchema,
   signUpParamsSchema,
   errorSchema,
@@ -17,6 +18,7 @@ import {
 
 export default {
   account: accountSchema,
+  accountEditParams: accountEditParamsSchema,
   loginParams: loginParamsSchema,
   signUpParams: signUpParamsSchema,
   refreshToken: refreshTokenSchema,

src/main/docs/schemas/account-edit-params-schema.ts

@@ -0,0 +1,18 @@
+export const accountEditParamsSchema = {
+  type: 'object',
+  properties: {
+    email: {
+      type: 'string',
+      nullable: true,
+    },
+    name: {
+      type: 'string',
+      nullable: true,
+    },
+  },
+  required: ['email', 'name'],
+  example: {
+    email: '[email protected]',
+    name: null,
+  },
+};

src/main/docs/schemas/index.ts

@@ -1,3 +1,4 @@
+export * from './account-edit-params-schema';
 export * from './account-schema';
 export * from './error-schema';
 export * from './login-params-schema';