From 5a183cecd7101505e3cb0a60317ed810419b7e4e Mon Sep 17 00:00:00 2001 From: Christian Hofmaier Date: Mon, 6 Aug 2018 00:47:05 +0000 Subject: language tags and function comments --- server/api/permissions.js | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'server/api/permissions.js') diff --git a/server/api/permissions.js b/server/api/permissions.js index ef7c5e8..5ed09e0 100644 --- a/server/api/permissions.js +++ b/server/api/permissions.js @@ -2,7 +2,14 @@ var path = require('path') var db = require(path.join(__appdir, 'lib', 'sequelize')) +// GET requests module.exports.get = { + + /* + * ?id= + * + * @return: Returns the information about a role and it's permissions and groups. + */ getRoleById: function (req, res) { db.role.findOne({ where: { id: req.query.id }, include: ['permissions', 'groups'] }).then(role => { if (role) res.send(role) @@ -10,6 +17,9 @@ module.exports.get = { }) }, + /* + * @return: Returns a list of all roles in the database. + */ getRoleList: function (req, res) { db.role.findAll({ attributes: ['id', 'name', 'descr'] @@ -18,6 +28,9 @@ module.exports.get = { }) }, + /* + * @return: Returns a list of all permissions in the database. + */ getPermissionList: function (req, res) { db.permission.findAll().then(function (permissions) { res.status(200).send(permissions) @@ -25,7 +38,14 @@ module.exports.get = { } } +// POST requests module.exports.post = { + + /* + * id: + * + * Deletes the role to the given id. + */ deleteRoles: function (req, res) { const roleIds = req.body.id @@ -34,6 +54,15 @@ module.exports.post = { }) }, + /* + * id: + * name: + * descr: + * permissions: + * groups: + * + * Creates or updates a role. + */ saveRole: function (req, res) { const role = req.body -- cgit v1.2.3-55-g7522