agl-service-unicens: move definition of api v2

[apps/agl-service-unicens.git] / ucs2-afb / ucs_apidef.h

diff --git a/ucs2-afb/ucs_apidef.h b/ucs2-afb/ucs_apidef.h
index 1dac82a..71739b6 100644 (file)
--- a/ucs2-afb/ucs_apidef.h
+++ b/ucs2-afb/ucs_apidef.h
@@ -22,39 +22,54 @@ static const char _afb_description_v2_UNICENS[] =
     "event\"},\"event\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}"
     "}},\"x-permissions\":{\"config\":{\"permission\":\"urn:AGL:permission:UN"
     "ICENS:public:initialise\"},\"monitor\":{\"permission\":\"urn:AGL:permiss"
-    "ion:UNICENS:public:monitor\"}},\"responses\":{\"200\":{\"description\":\""
-    "A complex object array response\",\"content\":{\"application/json\":{\"s"
-    "chema\":{\"$ref\":\"#/components/schemas/afb-reply\"}}}}}},\"paths\":{\""
-    "/listconfig\":{\"description\":\"List Config Files\",\"get\":{\"x-permis"
-    "sions\":{\"$ref\":\"#/components/x-permissions/config\"},\"parameters\":"
-    "[{\"in\":\"query\",\"name\":\"cfgpath\",\"required\":false,\"schema\":{\""
-    "type\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/res"
-    "ponses/200\"}}}},\"/initialise\":{\"description\":\"configure Unicens2 l"
-    "ib from NetworkConfig.XML.\",\"get\":{\"x-permissions\":{\"$ref\":\"#/co"
-    "mponents/x-permissions/config\"},\"parameters\":[{\"in\":\"query\",\"nam"
-    "e\":\"filename\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\""
-    "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/sub"
-    "scribe\":{\"description\":\"Subscribe to UNICENS Events.\",\"get\":{\"x-"
-    "permissions\":{\"$ref\":\"#/components/x-permissions/monitor\"},\"respon"
-    "ses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/writei2c\""
-    ":{\"description\":\"Writes I2C command to remote node.\",\"get\":{\"x-pe"
-    "rmissions\":{\"$ref\":\"#/components/x-permissions/monitor\"},\"paramete"
-    "rs\":[{\"in\":\"query\",\"name\":\"node\",\"required\":true,\"schema\":{"
-    "\"type\":\"integer\",\"format\":\"int32\"}},{\"in\":\"query\",\"name\":\""
-    "data\",\"required\":true,\"schema\":{\"type\":\"array\",\"format\":\"int"
-    "32\"},\"style\":\"simple\"}],\"responses\":{\"200\":{\"$ref\":\"#/compon"
-    "ents/responses/200\"}}}}}}"
+    "ion:UNICENS:public:monitor\"},\"controller\":{\"permission\":\"urn:AGL:p"
+    "ermission:UNICENS:public:controller\"}},\"responses\":{\"200\":{\"descri"
+    "ption\":\"A complex object array response\",\"content\":{\"application/j"
+    "son\":{\"schema\":{\"$ref\":\"#/components/schemas/afb-reply\"}}}}}},\"p"
+    "aths\":{\"/listconfig\":{\"description\":\"List Config Files\",\"get\":{"
+    "\"x-permissions\":{\"$ref\":\"#/components/x-permissions/config\"},\"par"
+    "ameters\":[{\"in\":\"query\",\"name\":\"cfgpath\",\"required\":false,\"s"
+    "chema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/com"
+    "ponents/responses/200\"}}}},\"/initialise\":{\"description\":\"configure"
+    " Unicens2 lib from NetworkConfig.XML.\",\"get\":{\"x-permissions\":{\"$r"
+    "ef\":\"#/components/x-permissions/config\"},\"parameters\":[{\"in\":\"qu"
+    "ery\",\"name\":\"filename\",\"required\":true,\"schema\":{\"type\":\"str"
+    "ing\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\""
+    "}}}},\"/subscribe\":{\"description\":\"Subscribe to network events.\",\""
+    "get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/monitor\""
+    "},\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\""
+    "/subscriberx\":{\"description\":\"Subscribe to Rx control message events"
+    ".\",\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/mo"
+    "nitor\"},\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\""
+    "}}}},\"/writei2c\":{\"description\":\"Writes I2C command to remote node."
+    "\",\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/mon"
+    "itor\"},\"parameters\":[{\"in\":\"query\",\"name\":\"node\",\"required\""
+    ":true,\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"in\":\""
+    "query\",\"name\":\"data\",\"required\":true,\"schema\":{\"type\":\"array"
+    "\",\"format\":\"int32\"},\"style\":\"simple\"}],\"responses\":{\"200\":{"
+    "\"$ref\":\"#/components/responses/200\"}}}},\"/sendmessage\":{\"descript"
+    "ion\":\"Transmits a control message to a node.\",\"get\":{\"x-permission"
+    "s\":{\"$ref\":\"#/components/x-permissions/controller\"},\"parameters\":"
+    "[{\"in\":\"query\",\"name\":\"node\",\"required\":true,\"schema\":{\"typ"
+    "e\":\"integer\",\"format\":\"int32\"}},{\"in\":\"query\",\"name\":\"msgi"
+    "d\",\"required\":true,\"schema\":{\"type\":\"integer\",\"format\":\"int3"
+    "2\"}},{\"in\":\"query\",\"name\":\"data\",\"required\":false,\"schema\":"
+    "{\"type\":\"string\",\"format\":\"byte\"},\"style\":\"simple\"}],\"respo"
+    "nses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}}}}"
 ;
 
 static const struct afb_auth _afb_auths_v2_UNICENS[] = {
        { .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:initialise" },
-       { .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:monitor" }
+       { .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:monitor" },
+       { .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:controller" }
 };
 
  void ucs2_listconfig(struct afb_req req);
  void ucs2_initialise(struct afb_req req);
  void ucs2_subscribe(struct afb_req req);
+ void ucs2_subscriberx(struct afb_req req);
  void ucs2_writei2c(struct afb_req req);
+ void ucs2_sendmessage(struct afb_req req);
 
 static const struct afb_verb_v2 _afb_verbs_v2_UNICENS[] = {
     {
@@ -75,7 +90,14 @@ static const struct afb_verb_v2 _afb_verbs_v2_UNICENS[] = {
         .verb = "subscribe",
         .callback = ucs2_subscribe,
         .auth = &_afb_auths_v2_UNICENS[1],
-        .info = "Subscribe to UNICENS Events.",
+        .info = "Subscribe to network events.",
+        .session = AFB_SESSION_NONE_V2
+    },
+    {
+        .verb = "subscriberx",
+        .callback = ucs2_subscriberx,
+        .auth = &_afb_auths_v2_UNICENS[1],
+        .info = "Subscribe to Rx control message events.",
         .session = AFB_SESSION_NONE_V2
     },
     {
@@ -85,6 +107,13 @@ static const struct afb_verb_v2 _afb_verbs_v2_UNICENS[] = {
         .info = "Writes I2C command to remote node.",
         .session = AFB_SESSION_NONE_V2
     },
+    {
+        .verb = "sendmessage",
+        .callback = ucs2_sendmessage,
+        .auth = &_afb_auths_v2_UNICENS[2],
+        .info = "Transmits a control message to a node.",
+        .session = AFB_SESSION_NONE_V2
+    },
     {
         .verb = NULL,
         .callback = NULL,