ns-api: added list-popular call

Added `list-popular` api call in `ns.dpi` Bump version to 0.0.11 Signed-off-by: Tommaso Bailetti <[email protected]>
NethServer · Oct 13, 2023 · 30c0211 · 30c0211
1 parent 1a18350
commit 30c0211
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 2 deletions.
diff --git a/packages/ns-api/Makefile b/packages/ns-api/Makefile
@@ -6,7 +6,7 @@
 include $(TOPDIR)/rules.mk
 
 PKG_NAME:=ns-api
-PKG_VERSION:=0.0.10
+PKG_VERSION:=0.0.11
 PKG_RELEASE:=1
 
 PKG_BUILD_DIR:=$(BUILD_DIR)/ns-api-$(PKG_VERSION)

diff --git a/packages/ns-api/README.md b/packages/ns-api/README.md
@@ -2035,6 +2035,55 @@ Example response:
 }
 ```
 
+### list-popular
+
+List popular applications and protocols:
+
+```bash
+api-cli ns.dpi list-popular
+```
+
+Data can be limited and paginated by using the `limit` and `page` parameters:
+
+```bash
+api-cli ns.dpi list-popular --data '{"limit": 3, "page": 2}'
+```
+
+**PLEASE NOTE**: `category` field can be missing in some applications/protocols.
+
+Example response:
+
+```json
+{
+   "values": [
+      {
+         "id": 10392,
+         "name": "netify.apple-siri",
+         "type": "application",
+         "category": {
+            "id": 5,
+            "name": "business"
+         }
+      },
+      {
+         "id": 142,
+         "name": "WhatsApp",
+         "type": "protocol",
+         "category": {
+            "id": 24,
+            "name": "messaging"
+         }
+      },
+      {
+         "id": 238,
+         "name": "Apple/Push",
+         "type": "protocol"
+      }
+   ]
+}
+```
+
+
 ### list-rules
 
 List created rules:

diff --git a/packages/ns-api/files/ns.dpi b/packages/ns-api/files/ns.dpi
@@ -37,7 +37,11 @@ if cmd == 'list':
             'applications': 'str',
             'protocols': 'str'
         },
-        'list-devices': {}
+        'list-devices': {},
+        'list-popular': {
+            'limit': 32,
+            'page': 32
+        }
     }))
 elif cmd == 'call':
     action = sys.argv[2]
@@ -64,6 +68,10 @@ elif cmd == 'call':
             print(json.dumps({'message': 'success'}))
         elif action == 'list-devices':
             print(json.dumps({'values': dpi.list_devices(e_uci)}))
+        elif action == 'list-popular':
+            data = json.JSONDecoder().decode(sys.stdin.read())
+            result = dpi.list_popular(e_uci, data.get('limit', None), data.get('page', 1))
+            print(json.dumps({'values': result}))
     except KeyError as e:
         print(json.dumps(utils.validation_error(e.args[0], 'required')))
     except json.JSONDecodeError: