feat(metadata): add option field readOnly to prevent editing (#358)

* feat(metadata): add option field readOnly to prevent editing * doc(metadata): update doc concerning metadataDetails
kuzzleio · Aug 9, 2024 · e0641b4 · e0641b4
1 parent febf3a6
commit e0641b4
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 19 deletions.
diff --git a/doc/2/controllers/models/update-asset/index.md b/doc/2/controllers/models/update-asset/index.md
@@ -48,6 +48,7 @@ Method: PUT
                 description: string;
               };
             };
+            readOnly?: boolean;
           };
       */
     },

diff --git a/doc/2/controllers/models/write-asset/index.md b/doc/2/controllers/models/write-asset/index.md
@@ -49,6 +49,7 @@ Method: POST
                 description: string;
               };
             };
+            readOnly?: boolean;
           };
       */
     },

diff --git a/doc/2/controllers/models/write-device/index.md b/doc/2/controllers/models/write-device/index.md
@@ -48,6 +48,7 @@ Method: POST
                 description: string;
               };
             };
+            readOnly?: boolean;
           };
       */
     },

diff --git a/lib/modules/model/types/ModelContent.ts b/lib/modules/model/types/ModelContent.ts
@@ -38,6 +38,7 @@ export interface MetadataDetails {
     locales: {
       [locale: string]: LocaleDetails;
     };
+    readOnly?: boolean;
   };
 }
 
@@ -148,14 +149,15 @@ export interface AssetModelContent extends KDocumentContent {
      *   "extTemp": {
      *     "group": "buildingEnv",
      *     "locales": {
-     *     "en": {
-     *        "friendlyName": "External temperature",
-     *        "description": "Building external temperature"
-     *     },
-     *     "fr": {
-     *       "friendlyName": "Température extérieure",
-     *       "description": "Température à l'exterieur du bâtiment"
-     *     },
+     *       "en": {
+     *          "friendlyName": "External temperature",
+     *          "description": "Building external temperature"
+     *       },
+     *       "fr": {
+     *         "friendlyName": "Température extérieure",
+     *         "description": "Température à l'exterieur du bâtiment"
+     *       },
+     *     "readOnly": true,
      *   }
      */
     metadataDetails?: MetadataDetails;
@@ -278,14 +280,15 @@ export interface DeviceModelContent extends KDocumentContent {
      *   "sensorVersion": {
      *     "group": "sensorSpecs",
      *     "locales": {
-     *     "en": {
-     *        "friendlyName": "Sensor version",
-     *        "description": "Firmware version of the sensor"
-     *     },
-     *     "fr": {
-     *       "friendlyName": "Version du capteur",
-     *       "description": "Version du micrologiciel du capteur"
-     *     },
+     *       "en": {
+     *          "friendlyName": "Sensor version",
+     *          "description": "Firmware version of the sensor"
+     *       },
+     *       "fr": {
+     *         "friendlyName": "Version du capteur",
+     *         "description": "Version du micrologiciel du capteur"
+     *       },
+     *     "readOnly": true,
      *   }
      */
     metadataDetails?: MetadataDetails;
@@ -302,7 +305,7 @@ export interface DeviceModelContent extends KDocumentContent {
      *       "fr": {
      *         "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
@@ -36,7 +36,8 @@ import {
  *             "friendlyName": "Température externe",
  *             "description": "Température externe du conteneur"
  *           }
- *         }
+ *         },
+ *         "readOnly": true,
  *       }
  *     },
  *     metadataGroups: {
@@ -153,7 +154,8 @@ export type AssetModelDefinition = {
  *             friendlyName: "Type de traceur",
  *             description: "Type du traceur"
  *           }
- *         }
+ *         },
+ *         readOnly: true,
  *       }
  *     },
  *     metadataGroups: {

diff --git a/tests/scenario/migrated/model-controller.test.ts b/tests/scenario/migrated/model-controller.test.ts
@@ -546,6 +546,7 @@ describe("features/Model/Controller", () => {
               description: "L'entreprise qui a fabriqué l'avion",
             },
           },
+          readOnly: true,
         },
       },
       metadataGroups: {
-Original file line number
+Diff line change
@@ Expand Up / @@ -48,6 +48,7 @@ Method: PUT @@
                     description: string;
                   };
                 };
+                readOnly?: boolean;
               };
           */
         },
@@ Expand Down @@