Gitiles
Code Review Sign In
gerrit.opencord.org / bbsim / 3f8fdc6e93572364e4a52cab385cd128e228030b / . / docs / swagger / bbsim / bbsim.swagger.json
blob: d4130f1c030b1ffc1f6ef8a70debba91b01a91e1 [file] [log] [blame]
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]1{
2 "swagger": "2.0",
3 "info": {
4 "title": "bbsim/bbsim.proto",
5 "version": "version not set"
6 },
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]7 "consumes": [
8 "application/json"
9 ],
10 "produces": [
11 "application/json"
12 ],
13 "paths": {
14 "/v1/olt": {
15 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]16 "summary": "Get current status of OLT",
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]17 "operationId": "GetOlt",
18 "responses": {
19 "200": {
20 "description": "A successful response.",
21 "schema": {
22 "$ref": "#/definitions/bbsimOlt"
23 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]24 },
25 "default": {
26 "description": "An unexpected error response",
27 "schema": {
28 "$ref": "#/definitions/runtimeError"
29 }
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]30 }
31 },
32 "tags": [
33 "BBSim"
34 ]
35 }
36 },
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]37 "/v1/olt/flows": {
38 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]39 "summary": "Get all flows or ONU specific flows",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]40 "operationId": "GetFlows2",
41 "responses": {
42 "200": {
43 "description": "A successful response.",
44 "schema": {
45 "$ref": "#/definitions/bbsimFlows"
46 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]47 },
48 "default": {
49 "description": "An unexpected error response",
50 "schema": {
51 "$ref": "#/definitions/runtimeError"
52 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]53 }
54 },
55 "parameters": [
56 {
57 "name": "SerialNumber",
58 "in": "query",
59 "required": false,
60 "type": "string"
61 }
62 ],
63 "tags": [
64 "BBSim"
65 ]
66 }
67 },
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]68 "/v1/olt/onus": {
69 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]70 "summary": "Get status of all ONUs",
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]71 "operationId": "GetONUs",
72 "responses": {
73 "200": {
74 "description": "A successful response.",
75 "schema": {
76 "$ref": "#/definitions/bbsimONUs"
77 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]78 },
79 "default": {
80 "description": "An unexpected error response",
81 "schema": {
82 "$ref": "#/definitions/runtimeError"
83 }
84 }
85 },
86 "tags": [
87 "BBSim"
88 ]
89 },
90 "delete": {
91 "summary": "Shutdown all ONUs in OLT",
92 "operationId": "ShutdownAllONUs",
93 "responses": {
94 "200": {
95 "description": "A successful response.",
96 "schema": {
97 "$ref": "#/definitions/bbsimResponse"
98 }
99 },
100 "default": {
101 "description": "An unexpected error response",
102 "schema": {
103 "$ref": "#/definitions/runtimeError"
104 }
105 }
106 },
107 "tags": [
108 "BBSim"
109 ]
110 },
111 "post": {
112 "summary": "Poweron all ONUs in OLT",
113 "operationId": "PoweronAllONUs",
114 "responses": {
115 "200": {
116 "description": "A successful response.",
117 "schema": {
118 "$ref": "#/definitions/bbsimResponse"
119 }
120 },
121 "default": {
122 "description": "An unexpected error response",
123 "schema": {
124 "$ref": "#/definitions/runtimeError"
125 }
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]126 }
127 },
128 "tags": [
129 "BBSim"
130 ]
131 }
132 },
133 "/v1/olt/onus/{SerialNumber}": {
134 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]135 "summary": "Get status of an ONU by serial number",
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]136 "operationId": "GetONU",
137 "responses": {
138 "200": {
139 "description": "A successful response.",
140 "schema": {
141 "$ref": "#/definitions/bbsimONU"
142 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]143 },
144 "default": {
145 "description": "An unexpected error response",
146 "schema": {
147 "$ref": "#/definitions/runtimeError"
148 }
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]149 }
150 },
151 "parameters": [
152 {
153 "name": "SerialNumber",
154 "in": "path",
155 "required": true,
156 "type": "string"
157 }
158 ],
159 "tags": [
160 "BBSim"
161 ]
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]162 },
163 "delete": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]164 "summary": "Shutdown an ONU by serial number",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]165 "operationId": "ShutdownONU",
166 "responses": {
167 "200": {
168 "description": "A successful response.",
169 "schema": {
170 "$ref": "#/definitions/bbsimResponse"
171 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]172 },
173 "default": {
174 "description": "An unexpected error response",
175 "schema": {
176 "$ref": "#/definitions/runtimeError"
177 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]178 }
179 },
180 "parameters": [
181 {
182 "name": "SerialNumber",
183 "in": "path",
184 "required": true,
185 "type": "string"
186 }
187 ],
188 "tags": [
189 "BBSim"
190 ]
191 },
192 "post": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]193 "summary": "Poweron an ONU by serial number",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]194 "operationId": "PoweronONU",
195 "responses": {
196 "200": {
197 "description": "A successful response.",
198 "schema": {
199 "$ref": "#/definitions/bbsimResponse"
200 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]201 },
202 "default": {
203 "description": "An unexpected error response",
204 "schema": {
205 "$ref": "#/definitions/runtimeError"
206 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]207 }
208 },
209 "parameters": [
210 {
211 "name": "SerialNumber",
212 "in": "path",
213 "required": true,
214 "type": "string"
215 }
216 ],
217 "tags": [
218 "BBSim"
219 ]
220 }
221 },
222 "/v1/olt/onus/{SerialNumber}/alarms/{AlarmType}/{Status}": {
223 "post": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]224 "summary": "Send ONU alarm indication",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]225 "operationId": "SetOnuAlarmIndication",
226 "responses": {
227 "200": {
228 "description": "A successful response.",
229 "schema": {
230 "$ref": "#/definitions/bbsimResponse"
231 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]232 },
233 "default": {
234 "description": "An unexpected error response",
235 "schema": {
236 "$ref": "#/definitions/runtimeError"
237 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]238 }
239 },
240 "parameters": [
241 {
242 "name": "SerialNumber",
243 "in": "path",
244 "required": true,
245 "type": "string"
246 },
247 {
248 "name": "AlarmType",
249 "in": "path",
250 "required": true,
251 "type": "string"
252 },
253 {
254 "name": "Status",
255 "in": "path",
256 "required": true,
257 "type": "string"
258 }
259 ],
260 "tags": [
261 "BBSim"
262 ]
263 }
264 },
265 "/v1/olt/onus/{SerialNumber}/flows": {
266 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]267 "summary": "Get all flows or ONU specific flows",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]268 "operationId": "GetFlows",
269 "responses": {
270 "200": {
271 "description": "A successful response.",
272 "schema": {
273 "$ref": "#/definitions/bbsimFlows"
274 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]275 },
276 "default": {
277 "description": "An unexpected error response",
278 "schema": {
279 "$ref": "#/definitions/runtimeError"
280 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]281 }
282 },
283 "parameters": [
284 {
285 "name": "SerialNumber",
286 "in": "path",
287 "required": true,
288 "type": "string"
289 }
290 ],
291 "tags": [
292 "BBSim"
293 ]
294 }
295 },
296 "/v1/olt/onus/{SerialNumber}/trafficschedulers": {
297 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]298 "summary": "Get Traffic scheduler information for ONU",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]299 "operationId": "GetOnuTrafficSchedulers",
300 "responses": {
301 "200": {
302 "description": "A successful response.",
303 "schema": {
304 "$ref": "#/definitions/bbsimONUTrafficSchedulers"
305 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]306 },
307 "default": {
308 "description": "An unexpected error response",
309 "schema": {
310 "$ref": "#/definitions/runtimeError"
311 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]312 }
313 },
314 "parameters": [
315 {
316 "name": "SerialNumber",
317 "in": "path",
318 "required": true,
319 "type": "string"
320 }
321 ],
322 "tags": [
323 "BBSim"
324 ]
325 }
326 },
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]327 "/v1/olt/port/{PonPortId}/onus": {
328 "delete": {
329 "summary": "Shutdown all ONUs under a PON by pon-port-ID",
330 "operationId": "ShutdownONUsOnPON",
331 "responses": {
332 "200": {
333 "description": "A successful response.",
334 "schema": {
335 "$ref": "#/definitions/bbsimResponse"
336 }
337 },
338 "default": {
339 "description": "An unexpected error response",
340 "schema": {
341 "$ref": "#/definitions/runtimeError"
342 }
343 }
344 },
345 "parameters": [
346 {
347 "name": "PonPortId",
348 "in": "path",
349 "required": true,
350 "type": "integer",
351 "format": "int64"
352 }
353 ],
354 "tags": [
355 "BBSim"
356 ]
357 },
358 "post": {
359 "summary": "Poweron all ONUs under a PON by pon-port-ID",
360 "operationId": "PoweronONUsOnPON",
361 "responses": {
362 "200": {
363 "description": "A successful response.",
364 "schema": {
365 "$ref": "#/definitions/bbsimResponse"
366 }
367 },
368 "default": {
369 "description": "An unexpected error response",
370 "schema": {
371 "$ref": "#/definitions/runtimeError"
372 }
373 }
374 },
375 "parameters": [
376 {
377 "name": "PonPortId",
378 "in": "path",
379 "required": true,
380 "type": "integer",
381 "format": "int64"
382 }
383 ],
384 "tags": [
385 "BBSim"
386 ]
387 }
388 },
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]389 "/v1/olt/ports/{InterfaceType}/{InterfaceID}/alarms/los/{Status}": {
390 "post": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]391 "summary": "Send OLT alarm indication for Interface type NNI or PON",
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]392 "operationId": "SetOltAlarmIndication",
393 "responses": {
394 "200": {
395 "description": "A successful response.",
396 "schema": {
397 "$ref": "#/definitions/bbsimResponse"
398 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]399 },
400 "default": {
401 "description": "An unexpected error response",
402 "schema": {
403 "$ref": "#/definitions/runtimeError"
404 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]405 }
406 },
407 "parameters": [
408 {
409 "name": "InterfaceType",
410 "in": "path",
411 "required": true,
412 "type": "string"
413 },
414 {
415 "name": "InterfaceID",
416 "in": "path",
417 "required": true,
418 "type": "integer",
419 "format": "int64"
420 },
421 {
422 "name": "Status",
423 "in": "path",
424 "required": true,
425 "type": "string"
426 }
427 ],
428 "tags": [
429 "BBSim"
430 ]
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]431 }
432 },
433 "/v1/olt/status": {
434 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]435 "summary": "Get current status of OLT",
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]436 "operationId": "GetOlt2",
437 "responses": {
438 "200": {
439 "description": "A successful response.",
440 "schema": {
441 "$ref": "#/definitions/bbsimOlt"
442 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]443 },
444 "default": {
445 "description": "An unexpected error response",
446 "schema": {
447 "$ref": "#/definitions/runtimeError"
448 }
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]449 }
450 },
451 "tags": [
452 "BBSim"
453 ]
454 }
455 },
456 "/v1/version": {
457 "get": {
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]458 "summary": "Get BBSim version",
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]459 "operationId": "Version",
460 "responses": {
461 "200": {
462 "description": "A successful response.",
463 "schema": {
464 "$ref": "#/definitions/bbsimVersionNumber"
465 }
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]466 },
467 "default": {
468 "description": "An unexpected error response",
469 "schema": {
470 "$ref": "#/definitions/runtimeError"
471 }
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]472 }
473 },
474 "tags": [
475 "BBSim"
476 ]
477 }
478 }
479 },
480 "definitions": {
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]481 "bbsimAlarmParameter": {
482 "type": "object",
483 "properties": {
484 "Key": {
485 "type": "string"
486 },
487 "Value": {
488 "type": "string"
489 }
490 }
491 },
492 "bbsimFlows": {
493 "type": "object",
494 "properties": {
495 "flow_count": {
496 "type": "integer",
497 "format": "int64"
498 },
499 "flows": {
500 "type": "array",
501 "items": {
502 "$ref": "#/definitions/openoltFlow"
503 }
504 }
505 }
506 },
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]507 "bbsimLogLevel": {
508 "type": "object",
509 "properties": {
510 "level": {
511 "type": "string"
512 },
513 "caller": {
514 "type": "boolean",
515 "format": "boolean"
516 }
517 }
518 },
519 "bbsimNNIPort": {
520 "type": "object",
521 "properties": {
522 "ID": {
523 "type": "integer",
524 "format": "int32"
525 },
526 "OperState": {
527 "type": "string"
528 }
529 }
530 },
531 "bbsimONU": {
532 "type": "object",
533 "properties": {
534 "ID": {
535 "type": "integer",
536 "format": "int32"
537 },
538 "SerialNumber": {
539 "type": "string"
540 },
541 "OperState": {
542 "type": "string"
543 },
544 "InternalState": {
545 "type": "string"
546 },
547 "PonPortID": {
548 "type": "integer",
549 "format": "int32"
550 },
551 "STag": {
552 "type": "integer",
553 "format": "int32"
554 },
555 "CTag": {
556 "type": "integer",
557 "format": "int32"
558 },
559 "HwAddress": {
560 "type": "string"
561 },
562 "PortNo": {
563 "type": "integer",
564 "format": "int32"
565 }
566 }
567 },
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]568 "bbsimONURequest": {
569 "type": "object",
570 "properties": {
571 "SerialNumber": {
572 "type": "string"
573 }
574 }
575 },
576 "bbsimONUTrafficSchedulers": {
577 "type": "object",
578 "properties": {
579 "traffSchedulers": {
580 "$ref": "#/definitions/tech_profileTrafficSchedulers"
581 }
582 }
583 },
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]584 "bbsimONUs": {
585 "type": "object",
586 "properties": {
587 "items": {
588 "type": "array",
589 "items": {
590 "$ref": "#/definitions/bbsimONU"
591 }
592 }
593 }
594 },
595 "bbsimOlt": {
596 "type": "object",
597 "properties": {
598 "ID": {
599 "type": "integer",
600 "format": "int32"
601 },
602 "SerialNumber": {
603 "type": "string"
604 },
605 "OperState": {
606 "type": "string"
607 },
608 "InternalState": {
609 "type": "string"
610 },
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]611 "IP": {
612 "type": "string"
613 },
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]614 "NNIPorts": {
615 "type": "array",
616 "items": {
617 "$ref": "#/definitions/bbsimNNIPort"
618 }
619 },
620 "PONPorts": {
621 "type": "array",
622 "items": {
623 "$ref": "#/definitions/bbsimPONPort"
624 }
625 }
626 }
627 },
628 "bbsimPONPort": {
629 "type": "object",
630 "properties": {
631 "ID": {
632 "type": "integer",
633 "format": "int32"
634 },
635 "OperState": {
636 "type": "string"
637 }
638 }
639 },
640 "bbsimResponse": {
641 "type": "object",
642 "properties": {
643 "status_code": {
644 "type": "integer",
645 "format": "int32"
646 },
647 "message": {
648 "type": "string"
649 }
650 }
651 },
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]652 "bbsimSubActionTypes": {
653 "type": "string",
654 "enum": [
655 "JOIN",
656 "LEAVE",
657 "JOINV3"
658 ],
659 "default": "JOIN"
660 },
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]661 "bbsimVersionNumber": {
662 "type": "object",
663 "properties": {
664 "version": {
665 "type": "string"
666 },
667 "buildTime": {
668 "type": "string"
669 },
670 "commitHash": {
671 "type": "string"
672 },
673 "gitStatus": {
674 "type": "string"
675 }
676 }
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]677 },
678 "openoltAction": {
679 "type": "object",
680 "properties": {
681 "cmd": {
682 "$ref": "#/definitions/openoltActionCmd"
683 },
684 "o_vid": {
685 "type": "integer",
686 "format": "int64"
687 },
688 "o_pbits": {
689 "type": "integer",
690 "format": "int64"
691 },
692 "o_tpid": {
693 "type": "integer",
694 "format": "int64"
695 },
696 "i_vid": {
697 "type": "integer",
698 "format": "int64"
699 },
700 "i_pbits": {
701 "type": "integer",
702 "format": "int64"
703 },
704 "i_tpid": {
705 "type": "integer",
706 "format": "int64"
707 }
708 }
709 },
710 "openoltActionCmd": {
711 "type": "object",
712 "properties": {
713 "add_outer_tag": {
714 "type": "boolean",
715 "format": "boolean"
716 },
717 "remove_outer_tag": {
718 "type": "boolean",
719 "format": "boolean"
720 },
721 "trap_to_host": {
722 "type": "boolean",
723 "format": "boolean"
724 }
725 }
726 },
727 "openoltClassifier": {
728 "type": "object",
729 "properties": {
730 "o_tpid": {
731 "type": "integer",
732 "format": "int64"
733 },
734 "o_vid": {
735 "type": "integer",
736 "format": "int64"
737 },
738 "i_tpid": {
739 "type": "integer",
740 "format": "int64"
741 },
742 "i_vid": {
743 "type": "integer",
744 "format": "int64"
745 },
746 "o_pbits": {
747 "type": "integer",
748 "format": "int64"
749 },
750 "i_pbits": {
751 "type": "integer",
752 "format": "int64"
753 },
754 "eth_type": {
755 "type": "integer",
756 "format": "int64"
757 },
758 "dst_mac": {
759 "type": "string",
760 "format": "byte"
761 },
762 "src_mac": {
763 "type": "string",
764 "format": "byte"
765 },
766 "ip_proto": {
767 "type": "integer",
768 "format": "int64"
769 },
770 "dst_ip": {
771 "type": "integer",
772 "format": "int64"
773 },
774 "src_ip": {
775 "type": "integer",
776 "format": "int64"
777 },
778 "src_port": {
779 "type": "integer",
780 "format": "int64"
781 },
782 "dst_port": {
783 "type": "integer",
784 "format": "int64"
785 },
786 "pkt_tag_type": {
787 "type": "string"
788 }
789 }
790 },
791 "openoltFlow": {
792 "type": "object",
793 "properties": {
794 "access_intf_id": {
795 "type": "integer",
796 "format": "int32"
797 },
798 "onu_id": {
799 "type": "integer",
800 "format": "int32"
801 },
802 "uni_id": {
803 "type": "integer",
804 "format": "int32"
805 },
806 "flow_id": {
807 "type": "integer",
808 "format": "int64"
809 },
810 "flow_type": {
811 "type": "string"
812 },
813 "alloc_id": {
814 "type": "integer",
815 "format": "int32"
816 },
817 "network_intf_id": {
818 "type": "integer",
819 "format": "int32"
820 },
821 "gemport_id": {
822 "type": "integer",
823 "format": "int32"
824 },
825 "classifier": {
826 "$ref": "#/definitions/openoltClassifier"
827 },
828 "action": {
829 "$ref": "#/definitions/openoltAction"
830 },
831 "priority": {
832 "type": "integer",
833 "format": "int32"
834 },
835 "cookie": {
836 "type": "string",
837 "format": "uint64"
838 },
839 "port_no": {
840 "type": "integer",
841 "format": "int64"
842 }
843 }
844 },
Pragya Arya3f8fdc62020-03-16 11:12:27 +0530[diff] [blame^]845 "protobufAny": {
846 "type": "object",
847 "properties": {
848 "type_url": {
849 "type": "string"
850 },
851 "value": {
852 "type": "string",
853 "format": "byte"
854 }
855 }
856 },
857 "runtimeError": {
858 "type": "object",
859 "properties": {
860 "error": {
861 "type": "string"
862 },
863 "code": {
864 "type": "integer",
865 "format": "int32"
866 },
867 "message": {
868 "type": "string"
869 },
870 "details": {
871 "type": "array",
872 "items": {
873 "$ref": "#/definitions/protobufAny"
874 }
875 }
876 }
877 },
Matteo Scandolo9d08be52020-03-12 09:43:53 -0700[diff] [blame]878 "tech_profileAdditionalBW": {
879 "type": "string",
880 "enum": [
881 "AdditionalBW_None",
882 "AdditionalBW_NA",
883 "AdditionalBW_BestEffort",
884 "AdditionalBW_Auto"
885 ],
886 "default": "AdditionalBW_None"
887 },
888 "tech_profileDirection": {
889 "type": "string",
890 "enum": [
891 "UPSTREAM",
892 "DOWNSTREAM",
893 "BIDIRECTIONAL"
894 ],
895 "default": "UPSTREAM"
896 },
897 "tech_profileInferredAdditionBWIndication": {
898 "type": "string",
899 "enum": [
900 "InferredAdditionBWIndication_None",
901 "InferredAdditionBWIndication_Assured",
902 "InferredAdditionBWIndication_BestEffort"
903 ],
904 "default": "InferredAdditionBWIndication_None"
905 },
906 "tech_profileSchedulerConfig": {
907 "type": "object",
908 "properties": {
909 "direction": {
910 "$ref": "#/definitions/tech_profileDirection"
911 },
912 "additional_bw": {
913 "$ref": "#/definitions/tech_profileAdditionalBW"
914 },
915 "priority": {
916 "type": "integer",
917 "format": "int64"
918 },
919 "weight": {
920 "type": "integer",
921 "format": "int64"
922 },
923 "sched_policy": {
924 "$ref": "#/definitions/tech_profileSchedulingPolicy"
925 }
926 }
927 },
928 "tech_profileSchedulingPolicy": {
929 "type": "string",
930 "enum": [
931 "WRR",
932 "StrictPriority",
933 "Hybrid"
934 ],
935 "default": "WRR"
936 },
937 "tech_profileTrafficScheduler": {
938 "type": "object",
939 "properties": {
940 "direction": {
941 "$ref": "#/definitions/tech_profileDirection"
942 },
943 "alloc_id": {
944 "type": "integer",
945 "format": "int64"
946 },
947 "scheduler": {
948 "$ref": "#/definitions/tech_profileSchedulerConfig"
949 },
950 "traffic_shaping_info": {
951 "$ref": "#/definitions/tech_profileTrafficShapingInfo"
952 }
953 }
954 },
955 "tech_profileTrafficSchedulers": {
956 "type": "object",
957 "properties": {
958 "intf_id": {
959 "type": "integer",
960 "format": "int64"
961 },
962 "onu_id": {
963 "type": "integer",
964 "format": "int64"
965 },
966 "uni_id": {
967 "type": "integer",
968 "format": "int64"
969 },
970 "port_no": {
971 "type": "integer",
972 "format": "int64"
973 },
974 "traffic_scheds": {
975 "type": "array",
976 "items": {
977 "$ref": "#/definitions/tech_profileTrafficScheduler"
978 }
979 }
980 }
981 },
982 "tech_profileTrafficShapingInfo": {
983 "type": "object",
984 "properties": {
985 "cir": {
986 "type": "integer",
987 "format": "int64"
988 },
989 "cbs": {
990 "type": "integer",
991 "format": "int64"
992 },
993 "pir": {
994 "type": "integer",
995 "format": "int64"
996 },
997 "pbs": {
998 "type": "integer",
999 "format": "int64"
1000 },
1001 "gir": {
1002 "type": "integer",
1003 "format": "int64"
1004 },
1005 "add_bw_ind": {
1006 "$ref": "#/definitions/tech_profileInferredAdditionBWIndication"
1007 }
1008 }
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200[diff] [blame]1009 }
1010 }
1011}