more documentation

Author: david-rocca

src/controller/registry-org.controller/registry-org.controller.js

@@ -432,7 +432,7 @@ async function deleteOrg (req, res, next) {
  * @param {object} req - The Express request object, containing the organization shortname in `req.ctx.params.shortname`.
  * @param {object} res - The Express response object.
  * @param {function} next - The next middleware function.
- * @returns {Promise<void>} - A promise that resolves when the response is sent.
+ * @returns {Promise<void>} - A promise that resolves when the response is sent. Response body includes 'role' field for admins.
  * @description All registered users can access this endpoint. Regular, CNA & Admin Users can retrieve information about users in the same organization.
  *              Secretariat can retrieve all user information for any organization.
  *              Called by GET /api/registryOrg/:shortname/users

src/controller/registry-user.controller/registry-user.controller.js

@@ -6,6 +6,18 @@ const error = new errors.UserControllerError()
 const validateUUID = require('uuid').validate
 const _ = require('lodash')
 
+/**
+ * Retrieves information about all registry users.
+ *
+ * @async
+ * @function getAllUsers
+ * @param {object} req - The Express request object.
+ * @param {object} res - The Express response object.
+ * @param {function} next - The next middleware function.
+ * @returns {Promise<void>} - A promise that resolves when the response is sent. Response body includes 'role' field for admins.
+ * @description This endpoint is accessible to Secretariat only. It retrieves a list of all registry users.
+ *              Called by GET /api/registryUser
+ */
 async function getAllUsers (req, res, next) {
   try {
     const CONSTANTS = getConstants()
@@ -60,6 +72,18 @@ async function getAllUsers (req, res, next) {
   }
 }
 
+/**
+ * Retrieves information about a specific registry user.
+ *
+ * @async
+ * @function getUser
+ * @param {object} req - The Express request object.
+ * @param {object} res - The Express response object.
+ * @param {function} next - The next middleware function.
+ * @returns {Promise<void>} - A promise that resolves when the response is sent. Response body includes 'role' field for admins.
+ * @description All authenticated users can access this endpoint. It retrieves information about the specified registry user.
+ *              Called by GET /api/registryUser/:identifier
+ */
 async function getUser (req, res, next) {
   /*
     This function is a little bit overloaded ATM until future releases of CVE-Services