-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yml
322 lines (318 loc) · 9.88 KB
/
openapi.yml
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
openapi: 3.0.0
info:
version: v1
title: In-band Network Telemetry (INT) for EVCs
description: NApp to deploy In-band Network Telemetry (INT) for EVCs
servers:
- url: /api/kytos/telemetry_int
paths:
/v1/evc:
get:
summary: List all INT enabled EVCs
operationId: list_evcs
responses:
'200':
description: List all INT enabled EVCs. The schema object is the same as mef_eline '#/components/schemas/Circuit'
content:
application/json:
schema:
type: object
/v1/evc/enable:
post:
summary: Enable INT on EVCs
operationId: enable_evcs
requestBody:
description: Enable INT on EVCs. If the list of evc_ids is empty, it will try to enable on non-INT EVCs.
required: true
content:
application/json:
schema:
type: object
properties:
evc_ids:
type: array
items:
type: string
force:
type: boolean
description: Force INT to get enabled again. It will enable even if the EVC already has INT or if a ProxyPort isn't UP.
default: false
responses:
'201':
description: INT enabled on EVCs
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Invalid request payload
'409':
description: Conflict resource state. For instance, when an EVC already has INT or a ProxyPort status isn't UP.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResp'
'404':
description: Dependent resource (EVC, flows or ProxyPort) not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResp'
'500':
description: Internal Server Error
'503':
description: Service unavailable
/v1/evc/disable:
post:
summary: Disable INT on EVCs
operationId: disable_evcs
requestBody:
description: Disable INT on EVCs. If the list of evc_ids is empty, it will try to disable on all INT EVCs.
required: true
content:
application/json:
schema:
type: object
properties:
evc_ids:
type: array
items:
type: string
force:
type: boolean
description: Force INT to get disabled again. It will try to disable even if the EVC isn't found or it doesn't have INT.
default: false
responses:
'201':
description: INT disabled on EVCs
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Invalid request payload
'409':
description: Conflict resource state. For instance, when an EVC already has INT or a ProxyPort status isn't UP.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResp'
'404':
description: Dependent resource (EVC, flows or ProxyPort) not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResp'
'500':
description: Internal Server Error
'503':
description: Service unavailable
/v1/evc/redeploy:
patch:
summary: Redeploy INT on EVCs
operationId: redeploy_evcs
requestBody:
description: Redeploy INT on EVCs. If the list of evc_ids is empty, it will try to redeploy all INT EVCs.
required: true
content:
application/json:
schema:
type: object
properties:
evc_ids:
type: array
items:
type: string
responses:
'201':
description: INT redeployed
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Invalid request payload
'409':
description: Conflict resource state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResp'
'404':
description: Dependent resource (EVC, flows or ProxyPort) not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResp'
'500':
description: Internal Server Error
'503':
description: Service unavailable
/v1/evc/compare:
get:
summary: List compare EVCs
operationId: compare_evc
responses:
'200':
description: List and compare which INT EVCs have flows installed comparing with mef_eline flows and telemetry metadata
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CompareResp'
'500':
description: Internal Server Error
'503':
description: Service unavailable
/v1/uni/proxy_port:
get:
summary: List the existing UNIs and the configured proxy ports
operationId: list_proxy_ports
responses:
'200':
description: List the existing configured proxy ports
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ProxyPortListResp'
'500':
description: Internal Server Error
'503':
description: Service unavailable
/v1/uni/{interface_id}/proxy_port/{port_number}:
post:
summary: Set proxy port metadata on a UNI
description: Set proxy port metadata on a UNI. Each UNI should use a different proxy port. If the proxy port is being updated, INT will be redeployed. If the proxy port is being set for the first time, you will need to enable INT on EVC afterwards.
operationId: set_proxy_port
parameters:
- name: interface_id
schema:
type: string
required: true
description: The interface ID
in: path
- name: port_number
schema:
type: integer
required: true
description: The proxy port number
in: path
- name: force
schema:
type: boolean
required: false
description: If force is set, it will also accept a proxy_port that isn't UP
in: query
responses:
'200':
description: Operation sucessful
content:
application/json:
schema:
type: string
example: Operation sucessful
'404':
description: Interface id or proxy port not found
'409':
description: Proxy port conflict
'500':
description: Internal Server Error
'503':
description: Service unavailable
/v1/uni/{interface_id}/proxy_port:
delete:
summary: Delete proxy port metadata on a UNI
description: Delete proxy port metadata on a UNI. It will only delete the metadata if no INT EVCs are using this port, unless you use the force option. When metadata is removed, INT will be disabled.
operationId: del_proxy_port
parameters:
- name: interface_id
schema:
type: string
required: true
description: The interface ID
in: path
- name: force
schema:
type: boolean
in: query
required: false
description: Force metadata deletion even if there are INT EVCs using the proxy port
responses:
'200':
description: Operation sucessful.
content:
application/json:
schema:
type: string
example: Operation sucessful
'404':
description: Interface id or proxy port not found
'409':
description: Proxy port deletion conflict
content:
application/json:
schema:
type: object
properties:
description:
type: string
evc_ids:
type: array
items:
type: string
'500':
description: Internal Server Error
'503':
description: Service unavailable
components:
schemas:
ErrResp: # Can be referenced via '#/components/schemas/ErrResp'
type: object
properties:
description:
type: string
code:
type: number
CompareResp: # Can be referenced via '#/components/schemas/CompareResp'
type: object
properties:
id:
type: string
name:
type: string
compare_reason:
type: array
items:
type: string
ProxyPortListResp: # Can be referenced via '#/components/schemas/ProxyPortListResp'
type: object
properties:
uni:
type: object
properties:
id:
type: string
status:
type: string
status_reason:
type: array
items:
type: string
proxy_port:
type: object
properties:
port_number:
type: integer
status:
type: string
status_reason:
type: array
items:
type: string