summaryrefslogtreecommitdiffstats
path: root/ctl-binding/ctl-apidef.json
diff options
context:
space:
mode:
authorFulup Ar Foll <fulup@iot.bzh>2017-09-29 12:23:26 +0200
committerFulup Ar Foll <fulup@iot.bzh>2017-09-29 12:23:26 +0200
commitacde5b8a880ff6f5e19ee91bd1f213339947b62f (patch)
tree333ebb3e87531da12fe447309e77a6fa57ba4165 /ctl-binding/ctl-apidef.json
parentacfdebd511ebcde861c7975af0a92c0d6bc87678 (diff)
Initial Commit as submodule
Diffstat (limited to 'ctl-binding/ctl-apidef.json')
-rw-r--r--ctl-binding/ctl-apidef.json249
1 files changed, 0 insertions, 249 deletions
diff --git a/ctl-binding/ctl-apidef.json b/ctl-binding/ctl-apidef.json
deleted file mode 100644
index a8b433e..0000000
--- a/ctl-binding/ctl-apidef.json
+++ /dev/null
@@ -1,249 +0,0 @@
-{
- "openapi": "3.0.0",
- "$schema": "http:iot.bzh/download/openapi/schema-3.0/default-schema.json",
- "info": {
- "description": "",
- "title": "controler",
- "version": "1.0",
- "x-binding-c-generator": {
- "api": "control",
- "version": 2,
- "prefix": "ctlapi_",
- "postfix": "",
- "start": null,
- "onevent": "DispatchOneEvent",
- "init": "CtlBindingInit",
- "scope": "",
- "private": false
- }
- },
- "servers": [
- {
- "url": "ws://{host}:{port}/api/polctl",
- "description": "Unicens2 API.",
- "variables": {
- "host": {
- "default": "localhost"
- },
- "port": {
- "default": "1234"
- }
- },
- "x-afb-events": [
- {
- "$ref": "#/components/schemas/afb-event"
- }
- ]
- }
- ],
- "components": {
- "schemas": {
- "afb-reply": {
- "$ref": "#/components/schemas/afb-reply-v2"
- },
- "afb-event": {
- "$ref": "#/components/schemas/afb-event-v2"
- },
- "afb-reply-v2": {
- "title": "Generic response.",
- "type": "object",
- "required": ["jtype", "request"],
- "properties": {
- "jtype": {
- "type": "string",
- "const": "afb-reply"
- },
- "request": {
- "type": "object",
- "required": ["status"],
- "properties": {
- "status": {
- "type": "string"
- },
- "info": {
- "type": "string"
- },
- "token": {
- "type": "string"
- },
- "uuid": {
- "type": "string"
- },
- "reqid": {
- "type": "string"
- }
- }
- },
- "response": {
- "type": "object"
- }
- }
- },
- "afb-event-v2": {
- "type": "object",
- "required": ["jtype", "event"],
- "properties": {
- "jtype": {
- "type": "string",
- "const": "afb-event"
- },
- "event": {
- "type": "string"
- },
- "data": {
- "type": "object"
- }
- }
- }
- },
- "x-permissions": {
- "control": {
- "permission": "urn:AGL:permission:audio:public:control"
- },
- "dispatch": {
- "permission": "urn:AGL:permission:audio:public:dispatch"
- },
- "request": {
- "permission": "urn:AGL:permission:audio:public:request"
- },
- "debug": {
- "permission": "urn:AGL:permission:audio:public:debug"
- }
- },
- "responses": {
- "200": {
- "description": "A complex object array response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/afb-reply"
- }
- }
- }
- }
- }
- },
- "paths": {
- "/ping": {
- "description": "Ping Binding",
- "get": {
- "x-permissions": {
- "$ref": "#/components/x-permissions/control"
- },
- "parameters": [{
- "in": "query",
- "name": "args",
- "required": false,
- "schema": {
- "type": "json"
- }
- }],
- "responses": {
- "200": {
- "$ref": "#/components/responses/200"
- }
- }
- }
- },
- "/subscribe": {
- "description": "Subcribe Audio Agent Policy Control End",
- "get": {
- "x-permissions": {
- "$ref": "#/components/x-permissions/control"
- },
- "parameters": [
- {
- "in": "query",
- "name": "event_patern",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/components/responses/200"
- }
- }
- }
- },
- "/dispatch": {
- "description": "Request Access to Navigation Audio Channel.",
- "get": {
- "x-permissions": {
- "$ref": "#/components/x-permissions/dispatch"
- },
- "parameters": [
- {
- "in": "query",
- "name": "zone",
- "required": false,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/components/responses/200"
- }
- }
- }
- },
- "/request": {
- "description": "Execute LUA string script.",
- "get": {
- "x-permissions": {
- "$ref": "#/components/x-permissions/request"
- },
- "parameters": [
- {
- "in": "query",
- "name": "func",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "args",
- "required": false,
- "schema": {
- "type": "array"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/components/responses/200"
- }
- }
- }
- },
- "/debuglua": {
- "description": "Execute LUA string script.",
- "get": {
- "x-permissions": {
- "$ref": "#/components/x-permissions/debug"
- },
- "parameters": [
- {
- "in": "query",
- "name": "filename",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/components/responses/200"
- }
- }
- }
- }
- }
-}