xfarrow/blink
0
0
Fork 0
mirror of https://github.com/xfarrow/blink synced 2025-02-21 08:50:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add some comments

Browse Source
This commit is contained in:
xfarrow 2024-02-15 10:37:09 +01:00
parent 8d1b5ba73b
commit 347d722537
1 changed files with 30 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
backend/apis/nodejs/api_controller.js
View File

@ -28,7 +28,14 @@ const jwt = require('jsonwebtoken');
// ======== BEGIN API ENDPOINTS ======== // ======== BEGIN API ENDPOINTS ========
// POST /**
* POST Request
*
* Register a Person
*
* @returns The activationLink identifier if
* the registration is successful
*/
async function registerPerson(req, res){ async function registerPerson(req, res){
if (process.env.ALLOW_USER_REGISTRATION === 'false'){ if (process.env.ALLOW_USER_REGISTRATION === 'false'){
@ -81,7 +88,14 @@ async function registerPerson(req, res){
} }
} }
// POST /**
* POST Request
*
* Creates a token if the specified email
* and password are valid
*
* @returns The token
*/
async function login(req, res){ async function login(req, res){
// Ensure that the required fields are present before proceeding // Ensure that the required fields are present before proceeding
@ -100,7 +114,13 @@ async function login(req, res){
} }
} }
// GET /**
* Obtain a Person's details if the
* specified person is myself or an
* enabled Person
*
* @returns The Person
*/
async function getPerson(req, res){ async function getPerson(req, res){
try { try {
const user = await knex('Person') const user = await knex('Person')
@ -192,9 +212,14 @@ async function updatePerson(req, res){
} }
} }
// GET /**
* GET Request
*
* Deletes a User. An user can only delete
* themselves.
*
*/
async function deletePerson(req, res) { async function deletePerson(req, res) {
// A user can only delete themselves
try { try {
await knex('Person') await knex('Person')
.where({id : req.jwt.person_id}) .where({id : req.jwt.person_id})