X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=ucs2-afb%2Fucs_apidef.json;h=9d543e29c180e2cc1cff1708dc1142473ffd2d6c;hb=refs%2Fchanges%2F22%2F24722%2F1;hp=5a3e81edf997239688240812bab9bd7934658976;hpb=d2e42029ec04c3f224580f8007cdfbbfe0fc47a6;p=apps%2Fagl-service-unicens.git diff --git a/ucs2-afb/ucs_apidef.json b/ucs2-afb/ucs_apidef.json index 5a3e81e..9d543e2 100644 --- a/ucs2-afb/ucs_apidef.json +++ b/ucs2-afb/ucs_apidef.json @@ -1,20 +1,21 @@ { "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", - "version": 2, + "api": "UNICENS", + "version": 3, "prefix": "ucs2_", "postfix": "", "start": null , "onevent": null, - "init": null, - "scope": "static", - "private": true + "preinit": null, + "init": "ucs2_initbinding", + "scope": "", + "private": false } }, "servers": [ @@ -39,12 +40,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 +68,7 @@ "response": { "type": "object" } } }, - "afb-event-v1": { + "afb-event-v2": { "type": "object", "required": [ "jtype", "event" ], "properties": { @@ -82,10 +83,13 @@ }, "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" + }, + "controller": { + "permission": "urn:AGL:permission:UNICENS:public:controller" } }, "responses": { @@ -102,8 +106,27 @@ } }, "paths": { + "/listconfig": { + "description": "List Config Files", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/config" + }, + "parameters": [ + { + "in": "query", + "name": "cfgpath", + "required": false, + "schema": { "type": "string" } + } + ], + "responses": { + "200": {"$ref": "#/components/responses/200"} + } + } + }, "/initialise": { - "description": "Initialise Unicens2 lib from NetworkConfig.XML.", + "description": "configure Unicens2 lib from NetworkConfig.XML.", "get": { "x-permissions": { "$ref": "#/components/x-permissions/config" @@ -117,18 +140,102 @@ } ], "responses": { - "200": {"$ref": "#/components/responses/200"} + "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/monitor" + }, + "responses": { + "200": {"$ref": "#/components/responses/200"} } } }, - "/monitor": { - "description": "Subscribe to Unicens2 Events.", + "/writei2c": { + "description": "Writes I2C command to remote node.", "get": { "x-permissions": { "$ref": "#/components/x-permissions/monitor" }, + "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": { + "description": "Transmits a control message to a node.", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/controller" + }, + "parameters": [ + { + "in": "query", + "name": "node", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "msgid", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "data", + "required": false, + "schema": { + "type": "string", + "format": "byte" + }, + "style": "simple" + } + ], "responses": { - "200": {"$ref": "#/components/responses/200"} + "200": {"$ref": "#/components/responses/200"} } } }