Initial API-V2 ajusted HTML page to fit new commands names

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

diff --git a/ucs2-afb/ucs_apidef.json b/ucs2-afb/ucs_apidef.json
index 5a3e81e..274ce73 100644 (file)
--- a/ucs2-afb/ucs_apidef.json
+++ b/ucs2-afb/ucs_apidef.json
@@ -1,20 +1,20 @@
 {
   "openapi": "3.0.0",
-  "$schema": "file:///home/fulup/Workspace/AGL-AppFW/unicens2rc-afb/etc/openapi-schema.json", 
+  "$schema": "http:iot.bzh/download/openapi/schema-3.0/default-schema.json",
   "info": {
     "description": "",
     "title": "ucs2",
     "version": "1.0",
     "x-binding-c-generator": {
-      "api": "unicens",
+      "api": "UNICENS",
       "version": 2,
       "prefix": "ucs2_",
       "postfix": "",
       "start": null ,
       "onevent": null,
       "init": null,
-      "scope": "static",
-      "private": true      
+      "scope": "",
+      "private": false
     }
   },
   "servers": [
@@ -39,12 +39,12 @@
   "components": {
     "schemas": {
       "afb-reply": {
-        "$ref": "#/components/schemas/afb-reply-v1"
+        "$ref": "#/components/schemas/afb-reply-v2"
       },
       "afb-event": {
-        "$ref": "#/components/schemas/afb-event-v1"
+        "$ref": "#/components/schemas/afb-event-v2"
       },
-      "afb-reply-v1": {
+      "afb-reply-v2": {
         "title": "Generic response.",
         "type": "object",
         "required": [ "jtype", "request" ],
@@ -67,7 +67,7 @@
           "response": { "type": "object" }
         }
       },
-      "afb-event-v1": {
+      "afb-event-v2": {
         "type": "object",
         "required": [ "jtype", "event" ],
         "properties": {
@@ -82,10 +82,10 @@
     },
     "x-permissions": {
         "config": {
-          "permission": "urn:AGL:permission:unicens:public:initialise"
+          "permission": "urn:AGL:permission:UNICENS:public:initialise"
         },
         "monitor": {
-          "permission": "urn:AGL:permission:unicens:public:monitor"
+          "permission": "urn:AGL:permission:UNICENS:public:monitor"
         }
     },
     "responses": {
@@ -102,8 +102,8 @@
     }
   },
   "paths": {
-    "/initialise": {
-      "description": "Initialise Unicens2 lib from NetworkConfig.XML.",
+    "/configure": {
+      "description": "configure Unicens2 lib from NetworkConfig.XML.",
       "get": {
         "x-permissions": {
           "$ref": "#/components/x-permissions/config"
@@ -117,18 +117,37 @@
           }
         ],
         "responses": {
-          "200": {"$ref": "#/components/responses/200"} 
+          "200": {"$ref": "#/components/responses/200"}
+        }
+      }
+    },
+    "/volume": {
+      "description": "Set Master Volume.",
+      "get": {
+        "x-permissions": {
+          "$ref": "#/components/x-permissions/monitor"
+        },
+        "parameters": [
+          {
+            "in": "query",
+            "name": "value",
+            "required": true,
+            "schema": { "type": "integer" }
+          }
+        ],
+        "responses": {
+          "200": {"$ref": "#/components/responses/200"}
         }
       }
     },
     "/monitor": {
-      "description": "Subscribe to Unicens2 Events.",
+      "description": "Subscribe to Unicens Event.",
       "get": {
         "x-permissions": {
           "$ref": "#/components/x-permissions/monitor"
         },
         "responses": {
-          "200": {"$ref": "#/components/responses/200"} 
+          "200": {"$ref": "#/components/responses/200"}
         }
       }
     }