Add support for type filters

topcoder-platform · Apr 5, 2020 · b69e298 · b69e298
1 parent 0656c42
commit b69e298
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -462,6 +462,12 @@ paths:
         - 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':

diff --git a/src/controllers/DeviceController.js b/src/controllers/DeviceController.js
@@ -113,7 +113,7 @@ async function getManufacturers (req, res) {
  * @param {Object} res the response
  */
 async function getDeviceModels (req, res) {
-  const result = await service.getDeviceModels()
+  const result = await service.getDeviceModels(req.query)
   res.send(result)
 }
 

diff --git a/src/services/DeviceService.js b/src/services/DeviceService.js
@@ -353,18 +353,25 @@ getManufacturers.schema = {
 
 /**
  * Get distinct device models.
+ * @param {Object} criteria the search criteria
  * @returns {Array} the distinct device models
  */
-async function getDeviceModels () {
+async function getDeviceModels (criteria) {
   const result = []
-  await iterateDevices({}, (device) => {
+  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,