3 "$schema": "http:iot.bzh/download/openapi/schema-3.0/default-schema.json",
6 "title": "low-level-can-service",
8 "x-binding-c-generator": {
22 "url": "ws://{host}:{port}/api/monitor",
23 "description": "Low level CAN API.",
26 "default": "localhost"
34 "$ref": "#/components/schemas/afb-event"
42 "$ref": "#/components/schemas/afb-reply-v2"
45 "$ref": "#/components/schemas/afb-event-v2"
48 "title": "Generic response.",
50 "required": [ "jtype", "request" ],
58 "required": [ "status" ],
60 "status": { "type": "string" },
61 "info": { "type": "string" },
62 "token": { "type": "string" },
63 "uuid": { "type": "string" },
64 "reqid": { "type": "string" }
67 "response": { "type": "object" }
72 "required": [ "jtype", "event" ],
78 "event": { "type": "string" },
79 "data": { "type": "object" }
85 "permission": "urn:AGL:permission:low-can:public:config"
88 "permission": "urn:AGL:permission:low-can:public:monitor"
91 "permission": "urn:AGL:permission:low-can:platform:write"
96 "description": "A complex object array response",
100 "$ref": "#/components/schemas/afb-reply"
109 "description": "Subscribe to CAN signals events",
115 "schema": { "type": "string" }
119 "200": {"$ref": "#/components/responses/200"}
124 "description": "Unsubscribe previously suscribed signals.",
130 "schema": { "type": "string" }
134 "200": {"$ref": "#/components/responses/200"}
138 "description": "Authenticate session to be raise Level Of Assurance.",
141 "$ref": "#/components/x-permissions/write"
144 "200": {"$ref": "#/components/responses/200"}
149 "description": "Write a CAN messages to the CAN bus.",
152 "$ref": "#/components/x-permissions/write"
159 "schema": { "type": "string" }
165 "schema": { "type": "array" },
171 "schema": { "type": "string" }
177 "schema": { "type": "string" }
183 "schema": { "type": "string" }
189 "name": "signal_name",
191 "schema": { "type": "string" }
195 "name": "signal_value",
197 "schema": { "type": "integer" }
201 "200": {"$ref": "#/components/responses/200"}