Merge branch 'models-endpoint' of https://github.com/meshde/lookups-api…

… into meshde-models-endpoint

docs/swagger.yaml

@@ -461,6 +461,30 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
+  '/lookups/devices/models':
+    get:
+      tags:
+        - Device
+      description: |
+        List distinct device models.
+      parameters:
+        - name: type
+          in: query
+          description: Filter by device type, case insensitive, partial match is used
+          required: false
+          type: string
+
+      responses:
+        '200':
+          description: OK
+          schema:
+            type: array
+            items:
+              type: string
+        '500':
+          description: Server error
+          schema:
+            $ref: '#/definitions/ErrorModel'
   '/lookups/countries':
     get:
       tags:

docs/tc-lookup-api.postman_collection.json

@@ -3209,4 +3209,4 @@
 		}
 	],
 	"protocolProfileBehavior": {}
-}
+}

src/controllers/DeviceController.js

@@ -107,6 +107,16 @@ async function getManufacturers (req, res) {
   res.send(result)
 }
 
+/**
+ * Get distinct device models
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function getDeviceModels (req, res) {
+  const result = await service.getDeviceModels(req.query)
+  res.send(result)
+}
+
 module.exports = {
   list,
   listHead,
@@ -117,5 +127,6 @@ module.exports = {
   partiallyUpdate,
   remove,
   getTypes,
-  getManufacturers
+  getManufacturers,
+  getDeviceModels
 }

src/routes.js

@@ -146,6 +146,13 @@ module.exports = {
       // any role / scope is allowed
     }
   },
+  '/lookups/devices/models': {
+    get: {
+      controller: 'DeviceController',
+      method: 'getDeviceModels'
+      // any role / scope is allowed
+    }
+  },
   '/lookups/devices/:id': {
     get: {
       controller: 'DeviceController',

src/services/DeviceService.js

@@ -389,6 +389,27 @@ getManufacturers.schema = {
   }).required()
 }
 
+/**
+ * Get distinct device models.
+ * @param {Object} criteria the search criteria
+ * @returns {Array} the distinct device models
+ */
+async function getDeviceModels (criteria) {
+  const result = []
+  await iterateDevices(criteria, (device) => {
+    if (!_.includes(result, device.model)) {
+      result.push(device.model)
+    }
+  })
+  return result
+}
+
+getDeviceModels.schema = {
+  criteria: Joi.object().keys({
+    type: Joi.string()
+  })
+}
+
 module.exports = {
   list,
   getEntity,
@@ -397,7 +418,8 @@ module.exports = {
   update,
   remove,
   getTypes,
-  getManufacturers
+  getManufacturers,
+  getDeviceModels
 }
 
 logger.buildService(module.exports)