ctl-apidef.json


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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

{
    "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": {
            "monitor": {
                "permission": "urn:AGL:permission:audio:public:monitor"
            },
            "multimedia": {
                "permission": "urn:AGL:permission:audio:public:monitor"
            },
            "navigation": {
                "permission": "urn:AGL:permission:audio:public:monitor"
            },
            "emergency": {
                "permission": "urn:AGL:permission:audio:public:emergency"
            }
        },
        "responses": {
            "200": {
                "description": "A complex object array response",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/afb-reply"
                        }
                    }
                }
            }
        }
    },
    "paths": {
        "/monitor": {
            "description": "Subcribe Audio Agent Policy Control End",
            "get": {
                "x-permissions": {
                    "$ref": "#/components/x-permissions/monitor"
                },
                "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/navigation"
                },
                "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/navigation"
                },
                "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/navigation"
                },
                "parameters": [
                    {
                        "in": "query",
                        "name": "filename",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/200"
                    }
                }
            }
        }
    }
}