feat(ns-plug): added ability to update description (#1374)

Author: Tbaile

packages/ns-api/Makefile

@@ -6,7 +6,7 @@
 include $(TOPDIR)/rules.mk
 
 PKG_NAME:=ns-api
-PKG_VERSION:=3.3.1
+PKG_VERSION:=3.3.2
 PKG_RELEASE:=1
 
 PKG_BUILD_DIR:=$(BUILD_DIR)/ns-api-$(PKG_VERSION)

packages/ns-api/README.md

@@ -6920,6 +6920,20 @@ Response example:
 
 If the restart fails return a `restart_failed` error.
 
+
+### update
+
+You can update the field `description` that is being sent to the controller.
+```
+api-cli ns.plug update --data '{"description": "My new description"}'
+```
+
+Response example:
+```json
+{"result": "success"}
+```
+
+
 ## ns.netifyd
 
 Manage netifyd sink configuration.

packages/ns-api/files/ns.plug

@@ -157,14 +157,28 @@ def unregister():
         return utils.generic_error("failed_to_reload_firewall")
     return {"result": "success"}
 
+
+def update(args):
+    if 'description' not in args:
+        return utils.validation_error("description", "required")
+
+    e_uci = EUci()
+    e_uci.set("ns-plug", "config", "description", args["description"])
+    e_uci.save("ns-plug")
+    e_uci.commit("ns-plug")
+
+    return {"result": "success"}
+
+
 cmd = sys.argv[1]
 
 if cmd == 'list':
     print(json.dumps({
         "register": {"join_code": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "tls_verify": False, "unit_name": "fw.test.local", "description": "my unit"},
         "unregister": {},
         "status":{},
-        "restart": {}
+        "restart": {},
+        "update": {"description": "my new description"}
         }))
 else:
     action = sys.argv[2]
@@ -175,6 +189,9 @@ else:
         ret = status()
     elif action == "unregister":
         ret = unregister()
+    elif action == "update":
+        args = json.load(sys.stdin)
+        ret = update(args)
     elif action == "restart":
         ret = {"result": "success"}
         try: