feat: add group descriptions to models (#335)

kuzzleio · Mar 21, 2024 · de00fb7 · de00fb7
1 parent 05c426f
commit de00fb7
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 29 deletions.
diff --git a/doc/2/controllers/models/write-asset/index.md b/doc/2/controllers/models/write-asset/index.md
@@ -60,6 +60,7 @@ Method: POST
             locales: {
               [locale: string]: {
                 groupFriendlyName: string;
+                description: string;
               };
             };
           };

diff --git a/doc/2/controllers/models/write-device/index.md b/doc/2/controllers/models/write-device/index.md
@@ -59,6 +59,7 @@ Method: POST
             locales: {
               [locale: string]: {
                 groupFriendlyName: string;
+                description: string;
               };
             };
           };

diff --git a/lib/modules/model/types/ModelContent.ts b/lib/modules/model/types/ModelContent.ts
@@ -37,6 +37,7 @@ export interface MetadataDetails {
 
 interface MetadataGroupLocale {
   groupFriendlyName: string;
+  description: string;
 }
 
 export interface MetadataGroups {
@@ -106,10 +107,12 @@ export interface AssetModelContent extends KDocumentContent {
      *   "buildingEnv": {
      *     "locales": {
      *       "en": {
-     *         "groupFriendlyName": "Building environment"
+     *         "groupFriendlyName": "Building environment",
+     *         "description": "The building environment"
      *       },
      *       "fr": {
-     *         "groupFriendlyName": "Environnement du bâtiment"
+     *         "groupFriendlyName": "Environnement du bâtiment",
+     *         "description": "L'environnement du bâtiment"
      *       }
      *     }
      *   }
@@ -187,10 +190,12 @@ export interface DeviceModelContent extends KDocumentContent {
      *   "sensorSpecs": {
      *     "locales": {
      *       "en": {
-     *         "groupFriendlyName": "Sensor specifications"
+     *         "groupFriendlyName": "Sensor specifications",
+     *         "description" : "All sensors specifications"
      *       },
      *       "fr": {
-     *         "groupFriendlyName": "Spécifications techniques"
+     *         "groupFriendlyName": "Spécifications techniques",
+     *         "description": "Toutes les spécifications techniques"
      *       }
      *     }
      *   }

diff --git a/lib/modules/model/types/ModelDefinition.ts b/lib/modules/model/types/ModelDefinition.ts
@@ -39,14 +39,16 @@ import {
  *       }
  *     },
  *     metadataGroups: {
- *       "buildingEnv": {
- *         "locales": {
- *           "en": {
- *             "groupFriendlyName": "Building environment"
- *           },
- *           "fr": {
- *             "groupFriendlyName": "Environnement du bâtiment"
- *           }
+ *       buildingEnv: {
+ *         locales: {
+ *          en: {
+ *            groupFriendlyName: "Building environment",
+ *            description: "The building environment"
+ *          },
+ *          fr: {
+ *            groupFriendlyName: "Environnement du bâtiment",
+ *            description: "L'environnement du bâtiment"
+ *          }
  *         }
  *       }
  *     }
@@ -108,19 +110,20 @@ export type AssetModelDefinition = {
  *       }
  *     },
  *     metadataGroups: {
- *       sensorSpecs: {
- *         locales: {
- *           en: {
- *             groupFriendlyName: "Sensors specifications"
- *           },
- *           fr: {
- *             groupFriendlyName: "Spécifications des capteurs"
- *           }
- *         }
- *       }
- *     }
- *   }
- *
+ *      sensorSpecs: {
+ *        locales: {
+ *          en: {
+ *            groupFriendlyName: "Sensor specifications",
+ *            description : "All sensors specifications"
+ *          },
+ *          fr: {
+ *            groupFriendlyName: "Spécifications techniques",
+ *            description: "Toutes les spécifications techniques"
+ *          }
+ *        }
+ *      }
+ *    }
+ *  }
  */
 export type DeviceModelDefinition = {
   /**

diff --git a/tests/application/assets/Container.ts b/tests/application/assets/Container.ts
@@ -78,10 +78,12 @@ export const containerAssetDefinition: AssetModelDefinition = {
     environment: {
       locales: {
         en: {
-          groupFriendlyName: "Environmental Measurements"
+          groupFriendlyName: "Environmental Measurements",
+          description: "All environmental relative measurments"
         },
         fr: {
-          groupFriendlyName: "Mesures environnementales"
+          groupFriendlyName: "Mesures environnementales",
+          description: "Toutes les mesures liées a l'environement"
         }
       }
     },

diff --git a/tests/scenario/migrated/model-controller.test.ts b/tests/scenario/migrated/model-controller.test.ts
@@ -526,8 +526,8 @@ describe("features/Model/Controller", () => {
       metadataGroups: {
         companyInfo: {
           locales: {
-            en: { groupFriendlyName: "Company Information" },
-            fr: { groupFriendlyName: "Informations sur l'entreprise" }
+            en: { groupFriendlyName: "Company Information", description: "All company related informations" },
+            fr: { groupFriendlyName: "Informations sur l'entreprise", description: "Toutes les informations relatives a l'entreprise" }
           }
         }
       }