Committed by
Gerrit Code Review
ONOS-4114 Flows Post has example of criteria, swagger shows link to wiki page wi…
…th full json criteria Change-Id: Ib430c537349e4d5d5e798f7b84158b7120264d3f
Showing
2 changed files
with
7 additions
and
198 deletions
... | @@ -129,7 +129,13 @@ public class FlowsWebResource extends AbstractWebResource { | ... | @@ -129,7 +129,13 @@ public class FlowsWebResource extends AbstractWebResource { |
129 | 129 | ||
130 | /** | 130 | /** |
131 | * Create new flow rule. Creates and installs a new flow rule for the | 131 | * Create new flow rule. Creates and installs a new flow rule for the |
132 | - * specified device. | 132 | + * specified device. <br> |
133 | + * Instructions description: | ||
134 | + * https://wiki.onosproject.org/display/ONOS/Flow+Rule+Instructions | ||
135 | + * <br> | ||
136 | + * Criteria description: | ||
137 | + * https://wiki.onosproject.org/display/ONOS/Flow+Rule+Criteria | ||
138 | + * | ||
133 | * @onos.rsModel FlowsPost | 139 | * @onos.rsModel FlowsPost |
134 | * @param deviceId device identifier | 140 | * @param deviceId device identifier |
135 | * @param stream flow rule JSON | 141 | * @param stream flow rule JSON | ... | ... |
... | @@ -89,203 +89,6 @@ | ... | @@ -89,203 +89,6 @@ |
89 | "format": "int64", | 89 | "format": "int64", |
90 | "example": "0x88cc", | 90 | "example": "0x88cc", |
91 | "description":"Ethernet frame type" | 91 | "description":"Ethernet frame type" |
92 | - }, | ||
93 | - "mac": { | ||
94 | - "type": "string", | ||
95 | - "example": "00:00:11:00:00:01" | ||
96 | - }, | ||
97 | - "port": { | ||
98 | - "type": "int64", | ||
99 | - "format": "int64", | ||
100 | - "example": 1, | ||
101 | - "description":"Match port" | ||
102 | - }, | ||
103 | - "metadata": { | ||
104 | - "type": "Hex16", | ||
105 | - "format": "Hex16", | ||
106 | - "example": "0xabcdL", | ||
107 | - "description":"Metadata passed between tables" | ||
108 | - }, | ||
109 | - "vlanId": { | ||
110 | - "type": "uint16", | ||
111 | - "format": "uint16", | ||
112 | - "example": "0x1000" | ||
113 | - }, | ||
114 | - "priority": { | ||
115 | - "type": "int64", | ||
116 | - "format": "int64", | ||
117 | - "example": 1, | ||
118 | - "description":"VLAN priority." | ||
119 | - }, | ||
120 | - "ipDscp": { | ||
121 | - "type": "byte", | ||
122 | - "format": "byte", | ||
123 | - "description":"IP DSCP (6 bits in ToS field)" | ||
124 | - }, | ||
125 | - "ipEcn": { | ||
126 | - "type": "byte", | ||
127 | - "format": "byte", | ||
128 | - "description":"IP ECN (2 bits in ToS field)." | ||
129 | - }, | ||
130 | - "protocol": { | ||
131 | - "type": "uint16", | ||
132 | - "format": "uint16", | ||
133 | - "example": 1, | ||
134 | - "description":"IP protocol" | ||
135 | - }, | ||
136 | - "ip": { | ||
137 | - "type": "string", | ||
138 | - "example": "10.1.1.0/24", | ||
139 | - "description":"IP source address" | ||
140 | - }, | ||
141 | - "tcpPort": { | ||
142 | - "type": "integer", | ||
143 | - "format": "uint16", | ||
144 | - "example": 1, | ||
145 | - "description":"TCP source address" | ||
146 | - }, | ||
147 | - "udpPort": { | ||
148 | - "type": "uint16", | ||
149 | - "format": "uint16", | ||
150 | - "example": 1, | ||
151 | - "description":"UDP source address" | ||
152 | - }, | ||
153 | - "sctpPort": { | ||
154 | - "type": "uint16", | ||
155 | - "format": "uint16", | ||
156 | - "example": 1, | ||
157 | - "description":"SCTP source address" | ||
158 | - }, | ||
159 | - "icmpType": { | ||
160 | - "type": "uint16", | ||
161 | - "format": "uint16", | ||
162 | - "example": 1, | ||
163 | - "description":"Internet Control Message Protocol for IPV4 code (RFC0792)" | ||
164 | - }, | ||
165 | - "icmpCode": { | ||
166 | - "type": "uint16", | ||
167 | - "format": "uint16", | ||
168 | - "example": 1, | ||
169 | - "description":"Internet Control Message Protocol for IPV4 code (RFC0792)" | ||
170 | - }, | ||
171 | - "flowLabel": { | ||
172 | - "type": "Hex16", | ||
173 | - "format": "Hex16", | ||
174 | - "example": "0xffffe", | ||
175 | - "description":"IPv6 Flow Label (RFC 6437)" | ||
176 | - }, | ||
177 | - "icmpv6Type": { | ||
178 | - "type": "uint16", | ||
179 | - "format": "uint16", | ||
180 | - "example": 1, | ||
181 | - "description":"Internet Control Message Protocol for IPV6 type (RFC2463)" | ||
182 | - }, | ||
183 | - "icmpv6Code": { | ||
184 | - "type": "uint16", | ||
185 | - "format": "uint16", | ||
186 | - "example": 1, | ||
187 | - "description":"Internet Control Message Protocol for IPV6 code (RFC2463)" | ||
188 | - }, | ||
189 | - "targetAddress": { | ||
190 | - "type": "String", | ||
191 | - "example": "10.1.1.0/24", | ||
192 | - "description":"IPv6 Neighbor discovery target address" | ||
193 | - }, | ||
194 | - "label": { | ||
195 | - "type": "int32", | ||
196 | - "format": "int32", | ||
197 | - "example": 1, | ||
198 | - "description":"MPLS label" | ||
199 | - }, | ||
200 | - "exthdrFlags": { | ||
201 | - "type": "int64", | ||
202 | - "format": "int64", | ||
203 | - "example": 1, | ||
204 | - "description":"IPv6 extension header pseudo-field" | ||
205 | - }, | ||
206 | - "lambda": { | ||
207 | - "type": "int64", | ||
208 | - "format": "int64", | ||
209 | - "example": 1, | ||
210 | - "description":"wavelength abstraction" | ||
211 | - }, | ||
212 | - "gridType": { | ||
213 | - "type": "String", | ||
214 | - "example": "DWDM", | ||
215 | - "description":"Type of wavelength grid" | ||
216 | - }, | ||
217 | - "channelSpacing": { | ||
218 | - "type": "int64", | ||
219 | - "format": "int64", | ||
220 | - "example": 100, | ||
221 | - "description":"Optical channel spacing" | ||
222 | - }, | ||
223 | - "spacingMultiplier": { | ||
224 | - "type": "integer", | ||
225 | - "format": "int64", | ||
226 | - "example": 4, | ||
227 | - "description":"Optical channel spacing multiplier" | ||
228 | - }, | ||
229 | - "slotGranularity": { | ||
230 | - "type": "int64", | ||
231 | - "format": "int64", | ||
232 | - "example": 8 | ||
233 | - }, | ||
234 | - "ochSignalId": { | ||
235 | - "type": "integer", | ||
236 | - "format": "int64", | ||
237 | - "example": 1, | ||
238 | - "description":"Optical channel signal ID" | ||
239 | - }, | ||
240 | - "tunnelId": { | ||
241 | - "type": "int64", | ||
242 | - "format": "int64", | ||
243 | - "example": 5, | ||
244 | - "description":"Tunnel ID" | ||
245 | - }, | ||
246 | - "ochSignalType": { | ||
247 | - "type": "int64", | ||
248 | - "format": "int64", | ||
249 | - "example": 1, | ||
250 | - "description":"Optical channel signal type" | ||
251 | - }, | ||
252 | - "oduSignalId": { | ||
253 | - "type": "int64", | ||
254 | - "format": "int64", | ||
255 | - "example": 1, | ||
256 | - "description":"ODU (Optical channel Data Unit) signal ID." | ||
257 | - }, | ||
258 | - "tributaryPortNumber": { | ||
259 | - "type": "int64", | ||
260 | - "format": "int64", | ||
261 | - "example": 11, | ||
262 | - "description":"OPU (Optical channel Payload Unit) port number." | ||
263 | - }, | ||
264 | - "tributarySlotLen": { | ||
265 | - "type": "int64", | ||
266 | - "format": "int64", | ||
267 | - "example": 80, | ||
268 | - "description":"OPU (Optical channel Payload Unit) slot length." | ||
269 | - }, | ||
270 | - "tributarySlotBitmap": { | ||
271 | - "type": "array", | ||
272 | - "title": "tributarySlotBitmap", | ||
273 | - "description":"OPU (Optical channel Payload Unit) slot bitmap.", | ||
274 | - "required": [ | ||
275 | - "byte", | ||
276 | - "port" | ||
277 | - ], | ||
278 | - "items": { | ||
279 | - "type": "byte", | ||
280 | - "title": "byte", | ||
281 | - "example": 1 | ||
282 | - } | ||
283 | - }, | ||
284 | - "oduSignalType": { | ||
285 | - "type": "int64", | ||
286 | - "format": "int64", | ||
287 | - "example": 4, | ||
288 | - "description":"ODU (Optical channel Data Unit) signal type." | ||
289 | } | 92 | } |
290 | } | 93 | } |
291 | } | 94 | } | ... | ... |
-
Please register or login to post a comment