Docs

epfl-si · Oct 30, 2023 · 5cf3748 · 5cf3748
1 parent 011d999
commit 5cf3748
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/src/services/unit.service.js b/src/services/unit.service.js
@@ -111,7 +111,7 @@ async function getUnit (acro, lang) {
   }
   if (dict.has_accreds) {
     const ldapUnitPersons = await peopleService.getPersonByUnit(dict.sigle);
-    const UnitPersons = ldapUtil.ldap2unit(ldapUnitPersons, lang);
+    const UnitPersons = ldapUtil.ldapUnit2api(ldapUnitPersons, lang);
     if (UnitPersons.length > 0) {
       unitFullDetails.people = UnitPersons;
     }

diff --git a/src/utils/ldap.util.js b/src/utils/ldap.util.js
@@ -298,7 +298,18 @@ function ldapAddress2api (ldapResults) {
   return person;
 }
 
-function ldap2unit (ldapResults, hl) {
+/**
+ * Convert LDAP Unit result into API result.
+ *
+ * @example
+ * const ldapUtil = require('../utils/ldap.util');
+ * const persons = ldapUtil.ldapUnit2api(ldapResults, 'en');
+ *
+ * @param {object} ldapResults The result from the LDAP Unit search.
+ * @param {string} hl The user interface language.
+ * @returns {object} Return the result for the API.
+ */
+function ldapUnit2api (ldapResults, hl) {
   const list = [];
   const ldapUnitMapper = newLdapUnitMapper(hl);
 
@@ -336,5 +347,5 @@ module.exports = {
   getProfile,
   ldap2api,
   ldapAddress2api,
-  ldap2unit
+  ldapUnit2api
 };