All files / src/web/routes groupsRoutes.ts

100% Statements 8/8
100% Branches 0/0
100% Functions 0/0
100% Lines 8/8

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 1257x 7x   7x                                                                           7x                                                     7x                                                           7x                                               7x   7x
import express from "express";
import * as groupsController from '../controllers/groupsController';
 
const router = express.Router();
 
/**
 * @swagger
 * /groups:
 *   post:
 *     tags:
 *       - Groups
 *     description: Create a new Transaction Group
 *     produces:
 *       - application/json
 *     requestBody:
 *       description: Group configuration object
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             type: object
 *             properties:
 *               name:
 *                 type: string
 *                 example: Groceries
 *     responses:
 *       201:
 *         description: Confirmation for the successfully added Group
 *         content:
 *           application/json:
 *             schema:
 *               type: object
 *               properties:
 *                 message:
 *                   type: string
 *                   example: Added 1 group to database
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/').post(groupsController.new);
 
/**
 * @swagger
 * /groups/all:
 *   get:
 *     tags:
 *       - Groups
 *     description: Get all Transactions Groups and their Rules.
 *     produces:
 *       - application/json
 *     responses:
 *       200:
 *         description: Array of Group objects
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 $ref: '#components/schemas/group'
 *       400:
 *         description: Bad request
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/all').get(groupsController.getAll);
 
/**
 * @swagger
 * /groups/{group}:
 *   get:
 *     tags:
 *       - Groups
 *     description: Get a Transaction Group and its Rules.
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: group
 *         in: path
 *         required: true
 *         type: string
 *     responses:
 *       200:
 *         description: Group object
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#components/schemas/group'
 *       400:
 *         description: Bad request
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/:group').get(groupsController.get);
 
/**
 * @swagger
 * /groups/{group}:
 *   delete:
 *     tags:
 *       - Groups
 *     description: Delete a Transaction Group
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: group
 *         in: path
 *         required: true
 *         type: string
 *     responses:
 *       204:
 *         description: Confirmation for the successfully deleted Group
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/:group').delete(groupsController.delete);
 
export { router };