All files / src/web/routes groupRulesRoutes.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 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 1437x 7x   7x                                                                               7x                                                                 7x                                                                     7x                                                         7x   7x
import express from "express";
import * as groupRulesController from '../controllers/groupRulesController';
 
const router = express.Router();
 
/**
 * @swagger
 * /groups/{group}/rules:
 *   post:
 *     tags:
 *       - Groups
 *       - Rules
 *     description: Create a new Transaction Group Rule
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: group
 *         in: path
 *         required: true
 *         type: string
 *     requestBody:
 *       description: Rule configuration object
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             $ref: '#components/schemas/groupRuleConfig'
 *     responses:
 *       201:
 *         description: Confirmation for the successfully added Group Rule
 *         content:
 *           application/json:
 *             schema:
 *               type: object
 *               properties:
 *                 message:
 *                   type: string
 *                   example: Added 1 group rule to database
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/').post(groupRulesController.new);
 
/**
 * @swagger
 * /groups/{group}/rules/all:
 *   get:
 *     tags:
 *       - Groups
 *       - Rules
 *     description: Get all Transaction Group Rules for a Group.
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: group
 *         in: path
 *         required: true
 *         type: string
 *     responses:
 *       200:
 *         description: Array of Group objects
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 $ref: '#components/schemas/groupRule'
 *       400:
 *         description: Bad request
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/all').get(groupRulesController.getAll);
 
/**
 * @swagger
 * /groups/{group}/rules/{rule_id}:
 *   get:
 *     tags:
 *       - Groups
 *       - Rules
 *     description: Get a Transaction Group Rule.
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: group
 *         in: path
 *         required: true
 *         type: string
 *       - name: rule_id
 *         in: path
 *         required: true
 *         type: integer
 *     responses:
 *       200:
 *         description: Group Rule object
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#components/schemas/groupRule'
 *       400:
 *         description: Bad request
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/:id').get(groupRulesController.get);
 
/**
 * @swagger
 * /groups/{group}/rules/{rule_id}:
 *   delete:
 *     tags:
 *       - Groups
 *       - Rules
 *     description: Delete a Transaction Group Rule
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: group
 *         in: path
 *         required: true
 *         type: string
 *       - name: rule_id
 *         in: path
 *         required: true
 *         type: integer
 *     responses:
 *       204:
 *         description: Confirmation for the successfully deleted Rule
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/:id').delete(groupRulesController.delete);
 
export { router };