Remove plural on devices engine collection property to avoid breaking…

… change
kuzzleio · Jun 6, 2024 · e5837cf · e5837cf
1 parent 83c2ff7
commit e5837cf
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/doc/2/concepts/configuration/index.md b/doc/2/concepts/configuration/index.md
@@ -53,7 +53,7 @@ The following collections are used by the plugin. They're automatically created
 The following collections are used by the plugin. They're automatically created when the plugin is started and are specific to each engine:
 
 - `config`: The collection that stores the engine configuration.
-- `devices`: The collection that stores the devices.
+- `device`: The collection that stores the devices.
 - `measures`: The collection that stores the measures once extracted by the decoders.
 - `asset`: The collection that stores the assets.
 - `assetGroups`: The collection that stores the assets groups.

diff --git a/lib/modules/plugin/DeviceManagerPlugin.ts b/lib/modules/plugin/DeviceManagerPlugin.ts
@@ -290,7 +290,7 @@ export class DeviceManagerPlugin extends Plugin {
         assetHistory: {
           name: InternalCollection.ASSETS_HISTORY,
         },
-        devices: {
+        device: {
           name: InternalCollection.DEVICES,
           mappings: devicesMappings,
         },

diff --git a/lib/modules/plugin/types/DeviceManagerConfiguration.ts b/lib/modules/plugin/types/DeviceManagerConfiguration.ts
@@ -52,6 +52,7 @@ export type DeviceManagerConfiguration = {
       mappings: JSONObject;
       settings?: JSONObject;
     };
+    // ! TODO next major release: pluralize the collection name
     asset: {
       name: string;
       mappings: CollectionMappings;
@@ -65,7 +66,8 @@ export type DeviceManagerConfiguration = {
       name: string;
       settings?: JSONObject;
     };
-    devices: {
+    // ! TODO next major release: pluralize the collection name
+    device: {
       name: string;
       mappings: CollectionMappings;
       settings?: JSONObject;