Add response schema to all API methods

.eslintrc.cjs

@@ -23,8 +23,8 @@ module.exports = {
         'selector': 'property',
         'format': ['camelCase', 'PascalCase'],
         'filter': {
-          // Allow "2xx" as a property name, used in the API response schema
-          'regex': '^(2xx|2\d{2}|application\/json)$',
+          // Allow "2xx", "3xx", "5xx" as a property name, used in the API response schema
+          'regex': '^(2xx|2\d{2}|5xx|3xx|application\/json)$',
           'match': false,
         },
       },

src/presentation/http/http-api.ts

@@ -20,6 +20,7 @@ import EditorToolsRouter from './router/editorTools.js';
 import { UserSchema } from './schema/User.js';
 import { NoteSchema } from './schema/Note.js';
 import { NoteSettingsSchema } from './schema/NoteSettings.js';
+import { OauthSchema } from './schema/OauthSchema.js';
 import Policies from './policies/index.js';
 import type { RequestParams, Response } from '@presentation/api.interface.js';
 import NoteSettingsRouter from './router/noteSettings.js';
@@ -60,9 +61,9 @@ export default class HttpApi implements Api {
     this.server = fastify({
       logger: appServerLogger as FastifyBaseLogger,
       ajv: {
-        plugins: [ 
+        plugins: [
           /** Allows to validate files in schema */
-          ajvFilePlugin 
+          ajvFilePlugin,
         ],
       },
     });
@@ -300,6 +301,7 @@ export default class HttpApi implements Api {
     this.server?.addSchema(NoteSettingsSchema);
     this.server?.addSchema(JoinSchemaParams);
     this.server?.addSchema(JoinSchemaResponse);
+    this.server?.addSchema(OauthSchema);
     this.server?.addSchema(UploadSchema);
   }
 

src/presentation/http/router/auth.ts

@@ -39,35 +39,85 @@ const AuthRouter: FastifyPluginCallback<AuthRouterOptions> = (fastify, opts, don
   fastify.post<{
     Body: AuthOptions;
     Reply: AuthSession | ErrorResponse;
-  }>('/', async (request, reply) => {
-    const { token } = request.body;
-    const userSession = await opts.authService.verifyRefreshToken(token);
+  }>('/',
+    {
+      schema: {
+        body: {
+          required: [ 'token' ],
+          properties: {
+            token: {
+              type: 'string',
+            },
+          },
+        },
 
-    /**
-     * Check if session is valid
-     */
-    if (!userSession) {
-      return await reply.unauthorized('Session is not valid');
-    }
+        response: {
+          '2xx': {
+            description: 'New token generated',
+            content: {
+              'application/json': {
+                schema: {
+                  accessToken: { type: 'string' },
+                  refreshToken: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    async (request, reply) => {
+      const { token } = request.body;
+      const userSession = await opts.authService.verifyRefreshToken(token);
 
-    const accessToken = opts.authService.signAccessToken({ id: userSession.userId });
+      /**
+       * Check if session is valid
+       */
+      if (!userSession) {
+        return await reply.unauthorized('Session is not valid');
+      }
 
-    await opts.authService.removeSessionByRefreshToken(token);
-    const refreshToken = await opts.authService.signRefreshToken(userSession.userId);
+      const accessToken = opts.authService.signAccessToken({ id: userSession.userId });
 
-    return reply.send({
-      accessToken,
-      refreshToken,
+      await opts.authService.removeSessionByRefreshToken(token);
+      const refreshToken = await opts.authService.signRefreshToken(userSession.userId);
+
+      return reply.send({
+        accessToken,
+        refreshToken,
+      });
     });
-  });
 
   /**
    * Route for logout, removes session from database by refresh token
    */
   fastify.delete<{
     Body: AuthOptions;
     Reply: { ok: boolean }
-  }>('/', async (request, reply) => {
+  }>('/', {
+    schema: {
+      body: {
+        token: {
+          type: 'string',
+        },
+      },
+
+      response: {
+        '2xx': {
+          description: 'Check for successful deletion of the token',
+          content: {
+            'application/json': {
+              schema:{
+                ok: {
+                  type: 'boolean',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  }, async (request, reply) => {
     await opts.authService.removeSessionByRefreshToken(request.body.token);
 
     return reply.status(StatusCodes.OK).send({

src/presentation/http/router/note.ts

@@ -240,6 +240,30 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
         'authRequired',
       ],
     },
+    schema: {
+      body: {
+        content: {
+          $ref: 'NoteSchema#/properties/content',
+        },
+        parentId: {
+          $ref: 'NoteSchema#/properties/id',
+        },
+      },
+      response: {
+        '2xx': {
+          description: 'Note fields',
+          content: {
+            'application/json':{
+              schema: {
+                id: {
+                  $ref: 'NoteSchema#/properties/id',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
   }, async (request, reply) => {
     /**
      * @todo Validate request query

src/presentation/http/router/noteSettings.ts

@@ -117,6 +117,14 @@ const NoteSettingsRouter: FastifyPluginCallback<NoteSettingsRouterOptions> = (fa
           $ref: 'NoteSchema#/properties/id',
         },
       },
+      body: {
+        userId: {
+          $ref: 'NoteSettingsSchema#/properties/team/items/properties/id',
+        },
+        newRole:{
+          $ref: 'NoteSettingsSchema#/properties/team/items/properties/role',
+        },
+      },
     },
     preHandler: [
       noteResolver,

src/presentation/http/router/oauth.ts

@@ -34,7 +34,48 @@ const OauthRouter: FastifyPluginCallback<OauthRouterOptions> = (fastify, opts, d
   /**
    * Callback for Google oauth2. Google redirects to this endpoint after user authentication.
    */
-  fastify.get('/google/callback', async (request, reply) => {
+  fastify.get('/google/callback', {
+    schema: {
+      params: {
+        clientId: {
+          $ref: 'OauthSchema#/properties/clientId',
+        },
+        clientSecret: {
+          $ref: 'OauthSchema#/properties/clientSecret',
+        },
+      },
+
+      response:{
+        '2xx': {
+          accessToken: {
+            $ref: 'OauthSchema#/properties/accessToken',
+          },
+          refreshToken: {
+            $ref: 'OauthSchema#/properties/refreshToken',
+          },
+        },
+
+        '3xx': {
+          code: {
+            type: 'string',
+          },
+
+          message: {
+            type: 'string',
+          },
+        },
+
+        // '5xx': {
+        //   code: {
+        //     type: 'string',
+        //   },
+        //   message: {
+        //     type: 'string',
+        //   },
+        // },
+      },
+    },
+  }, async (request, reply) => {
     /**
      * Get referer from request headers
      */

src/presentation/http/router/user.ts

@@ -115,8 +115,7 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
     schema: {
       body: {
         toolId: {
-          type: 'string',
-          description: 'Unique editor tool id',
+          $ref: 'EditorToolSchema#/properties/id',
         },
       },
       response: {
@@ -162,8 +161,7 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
     schema: {
       body: {
         toolId: {
-          type: 'string',
-          description: 'Unique editor tool id',
+          $ref: 'EditorToolSchema#/properties/id',
         },
       },
       response: {
@@ -173,7 +171,7 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
             'application/json': {
               schema: {
                 removedId: {
-                  type: 'string',
+                  $ref: 'EditorToolSchema#/properties/id',
                 },
               },
             },

src/presentation/http/schema/Join.ts

@@ -1,6 +1,7 @@
 export const JoinSchemaParams = {
   $id: 'JoinSchemaParams',
   type: 'object',
+  required: [ 'hash' ],
   properties: {
     hash: {
       type: 'string',

src/presentation/http/schema/OauthSchema.ts

@@ -0,0 +1,30 @@
+
+export const OauthSchema = {
+  $id: 'OauthSchema',
+  type: 'object',
+  required: [
+    'clientId',
+    'clientSecret',
+  ],
+  properties: {
+    clientId: {
+      type: 'string',
+      description: 'Google client id token',
+    },
+
+    clientSecret: {
+      type: 'string',
+      description: 'Google client secret key',
+    },
+
+    accessToken: {
+      type: 'string',
+      description: 'The returned access token from Google',
+    },
+
+    refreshToken: {
+      type: 'string',
+      description: 'The returned refreshtoken from Google',
+    },
+  },
+};

src/presentation/http/schema/User.ts

@@ -4,6 +4,7 @@
 export const UserSchema = {
   $id: 'UserSchema',
   type: 'object',
+  required: [ 'email' ],
   properties: {
     id: { type: 'number' },
     email: { type: 'string' },