feat: login a user docs

src/routes.ts

@@ -1,26 +1,26 @@
-import { Express, Request, Response } from "express";
+import { Express, Request, Response } from 'express'
 import {
   createProductHandler,
   getProductHandler,
   updateProductHandler,
   deleteProductHandler,
-} from "./controller/product.controller";
+} from './controller/product.controller'
 import {
   createUserSessionHandler,
   getUserSessionsHandler,
   deleteSessionHandler,
-} from "./controller/session.controller";
-import { createUserHandler } from "./controller/user.controller";
-import requireUser from "./middleware/requireUser";
-import validateResource from "./middleware/validateResource";
+} from './controller/session.controller'
+import { createUserHandler } from './controller/user.controller'
+import requireUser from './middleware/requireUser'
+import validateResource from './middleware/validateResource'
 import {
   createProductSchema,
   deleteProductSchema,
   getProductSchema,
   updateProductSchema,
-} from "./schema/product.schema";
-import { createSessionSchema } from "./schema/session.schema";
-import { createUserSchema } from "./schema/user.schema";
+} from './schema/product.schema'
+import { createSessionSchema } from './schema/session.schema'
+import { createUserSchema } from './schema/user.schema'
 
 function routes(app: Express) {
   /**
@@ -34,7 +34,7 @@ function routes(app: Express) {
    *       200:
    *         description: App is up and running
    */
-  app.get("/healthcheck", (req: Request, res: Response) => res.sendStatus(200));
+  app.get('/healthcheck', (req: Request, res: Response) => res.sendStatus(200))
 
   /**
    * @openapi
@@ -61,23 +61,46 @@ function routes(app: Express) {
    *      400:
    *        description: Bad request
    */
-  app.post("/api/users", validateResource(createUserSchema), createUserHandler);
+  app.post('/api/users', validateResource(createUserSchema), createUserHandler)
 
+  /**
+   * @openapi
+   * '/api/sessions':
+   *  post:
+   *     tags:
+   *     - Sessions
+   *     summary: Login a user
+   *     requestBody:
+   *      required: true
+   *      content:
+   *        application/json:
+   *           schema:
+   *            $ref: '#/components/schemas/CreateSessionInput'
+   *     responses:
+   *        200:
+   *          description: Success
+   *          content:
+   *            application/json:
+   *              schema:
+   *                $ref: '#/components/schemas/CreateSessionResponse'
+   *        401:
+   *          description: Invalid email or password
+   */
   app.post(
-    "/api/sessions",
+    '/api/sessions',
     validateResource(createSessionSchema),
     createUserSessionHandler
-  );
+  )
 
-  app.get("/api/sessions", requireUser, getUserSessionsHandler);
+  app.get('/api/sessions', requireUser, getUserSessionsHandler)
 
-  app.delete("/api/sessions", requireUser, deleteSessionHandler);
+  app.delete('/api/sessions', requireUser, deleteSessionHandler)
 
   app.post(
-    "/api/products",
+    '/api/products',
     [requireUser, validateResource(createProductSchema)],
     createProductHandler
-  );
+  )
 
   /**
    * @openapi
@@ -102,22 +125,22 @@ function routes(app: Express) {
    *         description: Product not found
    */
   app.put(
-    "/api/products/:productId",
+    '/api/products/:productId',
     [requireUser, validateResource(updateProductSchema)],
     updateProductHandler
-  );
+  )
 
   app.get(
-    "/api/products/:productId",
+    '/api/products/:productId',
     validateResource(getProductSchema),
     getProductHandler
-  );
+  )
 
   app.delete(
-    "/api/products/:productId",
+    '/api/products/:productId',
     [requireUser, validateResource(deleteProductSchema)],
     deleteProductHandler
-  );
+  )
 }
 
-export default routes;
+export default routes

src/schema/session.schema.ts

@@ -1,12 +1,36 @@
-import { object, string } from "zod";
+import { object, string } from 'zod'
 
+/**
+ * @openapi
+ * components:
+ *  schemas:
+ *    CreateSessionInput:
+ *      type: object
+ *      required:
+ *        - email
+ *        - password
+ *      properties:
+ *        email:
+ *          types: string
+ *          default: jane.doe@example.com
+ *        password:
+ *          types: string
+ *          default: stringPassword123
+ *    CreateSessionResponse:
+ *      type: object
+ *      properties:
+ *        accessToken:
+ *          types: string
+ *        refreshToken:
+ *          types: string
+ */
 export const createSessionSchema = object({
   body: object({
     email: string({
-      required_error: "Email is required",
+      required_error: 'Email is required',
     }),
     password: string({
-      required_error: "Password is required",
+      required_error: 'Password is required',
     }),
   }),
-});
+})