1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
{
"openapi": "3.0.0",
"$schema": "http://iot.bzh/download/openapi/schema-3.0/default-schema.json",
"info": {
"description": "",
"title": "signals-composer-service",
"version": "4.0",
"x-binding-c-generator": {
"api": "signal-composer",
"version": 2,
"prefix": "",
"postfix": "",
"start": null ,
"onevent": null,
"preinit": "loadConf",
"init": "execConf",
"scope": "",
"private": false
}
},
"servers": [
{
"url": "ws://{host}:{port}/api/monitor",
"description": "Signals composer API connected to low level AGL services",
"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": {
"addObjects": {
"permission": "urn:AGL:permission::platform:composer:addObjects"
}
},
"responses": {
"200": {
"description": "A complex object array response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/afb-reply"
}
}
}
}
}
},
"paths": {
"/subscribe": {
"description": "Subscribe to a signal object",
"parameters": [
{
"in": "query",
"name": "event",
"required": false,
"schema": { "type": "string" }
}
],
"responses": {
"200": {"$ref": "#/components/responses/200"}
}
},
"/unsubscribe": {
"description": "Unsubscribe previously suscribed signal objects.",
"parameters": [
{
"in": "query",
"name": "event",
"required": false,
"schema": { "type": "string" }
}
],
"responses": {
"200": {"$ref": "#/components/responses/200"}
}
},
"/get": {
"description": "Get informations about a resource or element",
"responses": {
"200": {"$ref": "#/components/responses/200"}
}
},
"/list": {
"description": "List all signals already configured",
"responses": {
"200": {"$ref": "#/components/responses/200"}
}
},
"/addObjects": {
"description": "Load new objects from an additional config file designated by JSON argument with the key 'file'.",
"get": {
"x-permissions": {
"$ref": "#/components/x-permissions/addObjects"
},
"responses": {
"200": {"$ref": "#/components/responses/200"}
}
},
"parameters": [
{
"in": "query",
"name": "path",
"required": true,
"schema": { "type": "string"}
}
]
}
}
}
|
