Fix small problems, improve customer route swagger docs

Author: norkator

ApiTesting.http

@@ -39,6 +39,6 @@ Accept: application/json
 ### Token provided, get token from login
 GET http://localhost:3000/example/with-auth
 Accept: application/json
-Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3RAdGVzdGVyLmNvbSIsImlhdCI6MTU5ODM0MTA1NiwiZXhwIjoxNTk4MzQ0NjU2fQ.iF7nE7uXZsPBfN_yJFA-CPj7dat7MPWgDEBieqPI2Kw
+Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJUZXN0IFVzZXIiLCJpZCI6MywiZW1haWwiOiJ0ZXN0QHRlc3Rlci5jb20iLCJpYXQiOjE1OTgzNDIzNzksImV4cCI6MTU5ODM0NTk3OX0.mgyA-axI4kd-IW-YbyJK7KqpCmIJLyNF3bLM7Fnu9fo
 
 ###

src/api/components/Authentication/index.ts

@@ -50,7 +50,11 @@ export async function createAccount(req: Request, res: Response, next: NextFunct
         console.log('new user created: ' + saved);
 
 
-        const token: string = jwt.sign({email: user.email}, process.env.JWT_SECRET, {
+        const token: string = jwt.sign({
+            user_name: saved.name,
+            id: saved.id,
+            email: saved.email
+        }, process.env.JWT_SECRET, {
             expiresIn: process.env.JWT_EXPIRE
         });
 
@@ -100,7 +104,11 @@ export async function login(req: Request, res: Response, next: NextFunction): Pr
         const isMatched: boolean = await bcrypt.compare(user.password, dbUser.password);
         if (isMatched) {
 
-            const token: string = jwt.sign({email: user.email}, process.env.JWT_SECRET, {
+            const token: string = jwt.sign({
+                user_name: dbUser.name,
+                id: dbUser.id,
+                email: dbUser.email
+            }, process.env.JWT_SECRET, {
                 expiresIn: process.env.JWT_EXPIRE
             });
 

src/api/routes/CustomerRouter.ts

@@ -8,22 +8,133 @@ const router: Router = Router();
 
 /* Note: these routes already have '/customers' part on them */
 
-// Todo: swagger doc!
+/**
+ * @swagger
+ * /customers/:
+ *   get:
+ *      description: Get all customers
+ *      tags: ["Customers"]
+ *      security:
+ *       - bearerAuth: []
+ *      requestBody:
+ *        description: retrieves all customers, organization id for filtering is coming from jwt token
+ *        required: true
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: ''
+ */
 router.get('/', CustomerComponent.getAll); // Retrieves a list of customers
 
-// Todo: swagger doc!
+/**
+ * @swagger
+ * /customers/{customerId}:
+ *   get:
+ *      description: Get customer with given customer id
+ *      summary: Get a customer by ID
+ *      parameters:
+ *        - in: path
+ *          name: customerId
+ *          schema:
+ *            type: integer
+ *          required: true
+ *          description: Numeric ID of the customer to get
+ *      tags: ["Customers"]
+ *      security:
+ *       - bearerAuth: []
+ *      requestBody:
+ *        description: retrieves customer given as url parameter, organization id for filtering is coming from jwt token
+ *        required: true
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: ''
+ *      responses:
+ *        201:
+ *          description: return created customer
+ *          content:
+ *            application/json:
+ *              schema:
+ *                oneOf:
+ *                  - $ref: ''
+ *        default:
+ *          description: unexpected error
+ *          content:
+ *            application/json:
+ *              schema:
+ *                $ref: ''
+ */
 router.get('/:customerId', CustomerComponent.getOne); // Retrieves a specific customer
 
-// Todo: swagger doc!
+/**
+ * @swagger
+ * /customers/:
+ *   post:
+ *      description: Create new customer
+ *      tags: ["Customers"]
+ *      security:
+ *       - bearerAuth: []
+ *      requestBody:
+ *        description: customer creation request body
+ *        required: true
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: ''
+ *            example:
+ *              customer_name: Test Customer
+ *              customer_description: Customer for testing purposes
+ *      responses:
+ *        201:
+ *          description: return created customer
+ *          content:
+ *            application/json:
+ *              schema:
+ *                oneOf:
+ *                  - $ref: ''
+ *        default:
+ *          description: unexpected error
+ *          content:
+ *            application/json:
+ *              schema:
+ *                $ref: ''
+ */
 router.post('/', CustomerComponent.create); // Create a new customer
 
-// Todo: swagger doc!
+// Todo: improve swagger doc!
+/**
+ * @swagger
+ * /customers/{customerId}:
+ *   put:
+ *      description: Update customer
+ *      tags: ["Customers"]
+ *      security:
+ *       - bearerAuth: []
+ */
 router.put('/:customerId', CustomerComponent.update); // Updates customer
 
-// Todo: swagger doc!
+// Todo: improve swagger doc!
+/**
+ * @swagger
+ * /customers/{customerId}:
+ *   patch:
+ *      description: Partially update customer
+ *      tags: ["Customers"]
+ *      security:
+ *       - bearerAuth: []
+ */
 router.patch('/:customerId', CustomerComponent.update); // Partial update for one customer
 
-// Todo: swagger doc!
+// Todo: improve swagger doc!
+/**
+ * @swagger
+ * /customers/{customerId}:
+ *   delete:
+ *      description: Delete customer with customerId
+ *      tags: ["Customers"]
+ *      security:
+ *       - bearerAuth: []
+ */
 router.delete('/:customerId', CustomerComponent.deleteOne); // Delete customer