-
Notifications
You must be signed in to change notification settings - Fork 6
/
openapi.yml
277 lines (277 loc) · 10.7 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
openapi: 3.0.0
info:
title: amlight/sdntrace_cp
version: '0.1'
description: An OpenFlow Path Tracing on Control Plane
servers:
- url: /api/amlight/sdntrace_cp
paths:
/v1/trace:
put:
summary: Trace a path
description: Trace a path starting with the switch given with the parameters given. The trace is done entirely in control plane.
requestBody:
content:
application/json:
schema:
type: object
properties:
trace:
type: object
required:
- switch
properties:
switch:
type: object
required:
- dpid
- in_port
properties:
dpid:
type: string
description: Initial switch datapath ID
example: 00:00:00:00:00:00:00:01
in_port:
type: integer
description: Starting incoming port
example: 1
eth:
type: object
properties:
dl_vlan:
type: integer
description: VLAN ID. This is an integer in range [1, 4095] as in a network packet.
example: 100
minimum: 1
maximum: 4095
dl_type:
type: integer
description: Ethernet type
example: '0x8100'
dl_src:
type: string
description: Source MAC address
example: '01:23:45:67:89:ab'
dl_dst:
type: string
description: Destination MAC address
example: '23:45:67:89:ab:cd'
ip:
type: object
properties:
nw_src:
type: string
description: Source IP for IPv4.
example: 192.168.20.21
nw_dst:
type: string
description: Destination IP for IPv4.
example: 192.168.25.123
ipv6_src:
type: string
description: Source IP for IPv6.
example: '2002:db8::8a3f:362:7897'
ipv6_dst:
type: string
description: Destination IP for IPv6.
example: '2002:db8::8a3f:362:7897'
nw_proto:
type: integer
description: IP protocol
example: 6
nw_tos:
type: integer
description: IP TOS
example: 0
tp:
type: object
properties:
tp_src:
type: integer
description: Source transport port
example: 8761
tp_dst:
type: integer
description: Destination transport port
example: 80
responses:
200:
description: Ok.
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
required:
- dpid
- port
- time
- type
properties:
dpid:
type: string
description: Switch datapath ID
example: 00:00:00:00:00:00:00:01
port:
type: integer
description: Incoming port in the switch
example: 1
time:
type: string
description: Date time when the iteration was computed
example: "2022-01-25 13:44:52.387021"
type:
type: string
enum: ["starting", "intermediary", "last", "loop"]
description: Type of the step. May be "starting", "intermediary", "last", and "loop".
example: "intermediary"
vlan:
type: integer
description: VLAN ID
example: 100
400:
description: "Parameter 'dpid' and/or 'in_port' is missing"
content:
application/json:
schema:
type: string
example: Bad requestç
424:
description: "Stored flows could not be fetched"
content:
application/json:
schema:
type: string
example: Failed Dependency
/v1/traces:
put:
summary: Trace paths given switches
description: Trace a path starting with each switch given in a list as parameter.
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
trace:
type: object
required:
- switch
properties:
switch:
type: object
required:
- dpid
- in_port
properties:
dpid:
type: string
description: Initial switch datapath ID
example: 00:00:00:00:00:00:00:01
in_port:
type: integer
description: Starting incoming port
example: 1
eth:
type: object
properties:
dl_vlan:
type: integer
description: VLAN ID. This is an integer in range [1, 4095] as in a network packet.
example: 100
minimum: 1
maximum: 4095
dl_type:
type: integer
description: Ethernet type
dl_src:
type: string
description: Source MAC address
dl_dst:
type: string
description: Destination MAC address
ip:
type: object
properties:
nw_src:
type: string
description: Source IP for IPv4.
example: 192.168.20.21
nw_dst:
type: string
description: Destination IP for IPv4.
example: 192.168.25.123
ipv6_src:
type: string
description: Source IP for IPv6.
example: '2002:db8::8a3f:362:7897'
ipv6_dst:
type: string
description: Destination IP for IPv6.
example: '2002:db8::8a3f:362:7897'
nw_proto:
type: integer
description: IP protocol
example: 6
nw_tos:
type: integer
description: IP TOS
example: 0
tp:
type: object
properties:
tp_src:
type: integer
description: Source transport port
example: 8761
tp_dst:
type: integer
description: Destination transport port
example: 80
responses:
200:
description: Ok.
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: array
items:
type: object
required:
- dpid
- port
- time
- type
properties:
dpid:
type: string
description: Switch datapath ID
example: 00:00:00:00:00:00:00:01
port:
type: integer
description: Incoming port in the switch
example: 1
time:
type: string
description: Date time when the iteration was computed
example: "2022-01-25 13:44:52.387021"
type:
type: string
enum: ["starting", "intermediary", "last", "loop"]
description: Type of the step. May be "starting", "intermediary", "last", and "loop".
example: "intermediary"
vlan:
type: integer
description: VLAN ID
example: 100