forked from kytos-ng/flow_stats
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
274 lines (274 loc) · 8.45 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
openapi: 3.0.0
info:
title: amlight/flow_stats
version: v1
description: Flow structures and statistics
paths:
/api/amlight/flow_stats/flow/match/{dpid}:
get:
summary: Return first flow matching request.
description: Match the flows in switch with args in request, returning the first match
parameters:
- name: dpid
schema:
type: string
required: true
description: Datapath ID of the switch
in: path
- name: in_port
schema:
type: string
required: true
description: Incoming port
in: query
responses:
200:
description: Describe a successful call.
content:
application/json:
schema:
type: object
properties:
prop_one:
type: string
description: Meaning of prop_one
example: an example of prop_one
second_prop:
type: integer
description: Meaning of second_prop
example: 42
/api/amlight/flow_stats/flow/stats/{dpid}:
get:
summary: Return all flows matching request.
description: Match the flows in switch with args in request, returning all of them
parameters:
- name: dpid
schema:
type: string
required: true
description: Datapath ID of the switch
in: path
responses:
200: # You can add more responses
description: Describe a successful call.
content:
application/json: # You can also use text/plain, for example
schema:
type: object # Adapt to your response
properties:
prop_one:
type: string
description: Meaning of prop_one
example: an example of prop_one
second_prop:
type: integer
description: Meaning of second_prop
example: 42
/api/amlight/flow_stats/packet_count/{flow_id}:
get:
summary: Packet count of an specific flow.
description: Counters of a flow.
parameters:
- name: flow_id
schema:
type: string
required: true
description: Flow ID
in: path
responses:
200:
description: Counters ok
content:
application/json:
schema:
type: object
properties:
flow_id:
type: string
description: Flow ID
example: 263c85082b6d446cd7b72e1a5deae428
packet_counter:
type: integer
description: Number of packets that matched the flow
example: 42
packet_per_second:
type: number
description: Packets per second since flow creation
example: 2.345
404:
description: Does not exist
content:
application/json:
schema:
type: string
example: Flow not found
/api/amlight/flow_stats/bytes_count/{flow_id}:
get:
summary: Bytes count of an specific flow.
description: Counter per byte of a flow.
parameters:
- name: flow_id
schema:
type: string
required: true
description: Flow ID
in: path
responses:
200:
description: Counters ok
content:
application/json:
schema:
type: object
properties:
flow_id:
type: string
description: Flow ID
example: 263c85082b6d446cd7b72e1a5deae428
bytes_counter:
type: integer
description: Number of bytes in packets that matched the flow
example: 427
bits_per_second:
type: number
description: Bits per second since flow creation
example: 25.345
404:
description: Does not exist
content:
application/json:
schema:
type: string
example: Flow not found
/api/amlight/flow_stats/packet_count/per_flow/{dpid}:
get:
summary: Per flow packet count.
description: Packet count per flow of a switch
parameters:
- name: dpid
schema:
type: string
required: true
description: Datapath ID
in: path
responses:
200:
description: Counters ok
content:
application/json:
schema:
type: array
items:
type: object
properties:
flow_id:
type: string
description: Flow ID
example: 263c85082b6d446cd7b72e1a5deae428
packet_counter:
type: integer
description: Number of packets that matched the flow
example: 42
packet_per_second:
type: number
description: Packets per second since flow creation
example: 2.345
404:
description: Does not exist
content:
application/json:
schema:
type: string
example: Switch not found
/api/amlight/flow_stats/packet_count/sum/{dpid}:
get:
summary: Sum of packet count flow stats.
description: Sum of packet counts of all flow in a switch
parameters:
- name: dpid
schema:
type: string
required: true
description: Datapath ID
in: path
responses:
200:
description: Counters ok
content:
application/json:
schema:
type: integer
example: 2004
404:
description: Does not exist
content:
application/json:
schema:
type: string
example: Switch not found
/api/amlight/flow_stats/bytes_count/per_flow/{dpid}:
get:
summary: Per flow bytes count.
description: Bytes count per flow of a switch
parameters:
- name: dpid
schema:
type: string
required: true
description: Datapath ID
in: path
responses:
200:
description: Counters ok
content:
application/json:
schema:
type: array
items:
type: object
properties:
flow_id:
type: string
description: Flow ID
example: 263c85082b6d446cd7b72e1a5deae428
bytes_counter:
type: integer
description: Number of bytes in packets that matched the flow
example: 427
bits_per_second:
type: number
description: Bits per second since flow creation
example: 25.345
404:
description: Does not exist
content:
application/json:
schema:
type: string
example: Switch not found
/api/amlight/flow_stats/bytes_count/sum/{dpid}:
get:
summary: Sum of bytes count flow stats.
description: Sum of bytes counts of all flow in a switch
parameters:
- name: dpid
schema:
type: string
required: true
description: Datapath ID of the switch
in: path
responses:
200:
description: Counters ok
content:
application/json:
schema:
type: integer
example: 34204
404:
description: Does not exist
content:
application/json:
schema:
type: string
example: Switch not found