Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / ric-plt / e2mgr / 14eb5132c3dca8cdad98e7e5420701b04f452046 / . / Swagger / E2Manager_API.yaml
blob: 1ab3766846385bb5ceced5f62f39aa01649b72ec [file] [log] [blame]
ss412ga0421fb2020-07-02 17:22:59 +0300[diff] [blame]1openapi: 3.0.0
2info:
3 title: E2 Manager Service
4 description: E2 Manager Service APIs
5 version: 5.2.2
6servers:
7 - url: 'http://{apiRoot}/v1'
8 variables:
9 apiRoot:
10 default: 'localhost:3800'
11paths:
12 '/nodeb/{ranName}':
13 get:
14 tags:
15 - nodeb
16 summary: Get RAN by name
17 operationId: getNb
18 parameters:
19 - name: ranName
20 in: path
21 required: true
22 description: Name of RAN to return
23 schema:
24 type: string
25 responses:
26 '200':
27 description: Successful operation
28 content:
29 application/json:
30 schema:
31 $ref: '#/components/schemas/GetNodebResponse'
32 '400':
33 description: The specified RAN name is invalid
34 content:
35 application/json:
36 schema:
37 $ref: '#/components/schemas/ErrorResponse'
38 '404':
39 description: A RAN with the specified name was not found
40 content:
41 application/problem+json:
42 schema:
43 $ref: '#/components/schemas/ErrorResponse'
44 '500':
45 description: Internal Error
46 content:
47 application/problem+json:
48 schema:
49 $ref: '#/components/schemas/ErrorResponse'
50 '/nodeb/{ranName}/update':
51 put:
52 summary: Update GNB
53 tags:
54 - nodeb
55 operationId: UpdateGnb
56 parameters:
57 - name: ranName
58 in: path
59 required: true
60 description: Name of GNB RAN to update
61 schema:
62 type: string
63 requestBody:
64 content:
65 application/json:
66 schema:
67 $ref: '#/components/schemas/UpdateGnbRequest'
68 required: true
69 responses:
70 '200':
71 description: Successful operation
72 content:
73 application/json:
74 schema:
75 $ref: '#/components/schemas/UpdateGnbResponse'
76 '400':
77 description: Invalid input
78 content:
79 application/problem+json:
80 schema:
81 $ref: '#/components/schemas/ErrorResponse'
82 '500':
83 description: Internal error
84 content:
85 application/problem+json:
86 schema:
87 $ref: '#/components/schemas/ErrorResponse'
88 /nodeb/shutdown:
89 put:
90 tags:
91 - nodeb
92 summary: Close all connections to the RANs
93 responses:
94 '200':
95 description: 'Operation succeeded internally, outbound calls failed'
96 content:
97 application/json:
98 schema:
99 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
100 '204':
101 description: Successful operation
102 '500':
103 description: Internal Error
104 content:
105 application/problem+json:
106 schema:
107 $ref: '#/components/schemas/ErrorResponse'
108 /nodeb/ids:
109 get:
110 tags:
111 - nodeb
112 summary: Get RANs identities list
113 operationId: getNodebIdList
114 responses:
115 '200':
116 description: Successful operation
117 content:
118 application/json:
119 schema:
120 type: array
121 items:
122 $ref: '#/components/schemas/NodebIdentity'
123 '500':
124 description: Internal Error
125 content:
126 application/problem+json:
127 schema:
128 $ref: '#/components/schemas/ErrorResponse'
129 /nodeb/parameters:
130 put:
131 summary: Update e2mgr configuration
132 tags:
133 - nodeb
134 operationId: SetConfiguration
135 requestBody:
136 content:
137 application/json:
138 schema:
139 $ref: '#/components/schemas/SetConfiguration'
140 required: true
141 responses:
142 '200':
143 description: Successful operation
144 content:
145 application/json:
146 schema:
147 $ref: '#/components/schemas/SetConfiguration'
148 '400':
149 description: Invalid input
150 content:
151 application/problem+json:
152 schema:
153 $ref: '#/components/schemas/ErrorResponse'
154 '500':
155 description: Internal error
156 content:
157 application/problem+json:
158 schema:
159 $ref: '#/components/schemas/ErrorResponse'
160 /health:
161 get:
162 tags:
163 - Health Check
164 summary: E2 Manager Service Health Check
165 responses:
166 '200':
167 description: OK
168 /e2t/list:
169 get:
170 tags:
171 - e2t
172 summary: Gets a list of all E2T Instances address and their associated RANs
173 responses:
174 '200':
175 description: Successful operation
176 content:
177 application/json:
178 schema:
179 type: array
180 items:
181 $ref: '#/components/schemas/E2tIdentity'
182 '500':
183 description: Internal Error
184 content:
185 application/problem+json:
186 schema:
187 $ref: '#/components/schemas/ErrorResponse'
188components:
189 schemas:
190 UpdateGnbRequest:
191 type: object
192 required:
193 - servedNrCells
194 properties:
195 servedNrCells:
196 $ref: '#/components/schemas/ServedNrCells'
197 additionalProperties: false
198 UpdateGnbResponse:
199 properties:
200 connectionStatus:
201 oneOf:
202 - type: string
203 - type: integer
204 failureType:
205 oneOf:
206 - type: string
207 - type: integer
208 globalNbId:
209 properties:
210 nbId:
211 type: string
212 plmnId:
213 type: string
214 additionalProperties: false
215 type: object
216 gnb:
217 $ref: '#/components/schemas/Gnb'
218 ip:
219 type: string
220 nodeType:
221 oneOf:
222 - type: string
223 - type: integer
224 port:
225 type: integer
226 ranName:
227 type: string
228 setupFailure:
229 $ref: '#/components/schemas/SetupFailure'
230 additionalProperties: false
231 type: object
232 SetConfiguration:
233 type: object
234 required:
235 - enableRic
236 properties:
237 enableRic:
238 type: boolean
239 additionalProperties: false
240 NodebIdentity:
241 properties:
242 globalNbId:
243 properties:
244 nbId:
245 type: string
246 plmnId:
247 type: string
248 type: object
249 inventoryName:
250 type: string
251 type: object
252 GetNodebResponse:
253 properties:
254 connectionStatus:
255 oneOf:
256 - type: string
257 - type: integer
258 enb:
259 $ref: '#/components/schemas/Enb'
260 failureType:
261 oneOf:
262 - type: string
263 - type: integer
264 globalNbId:
265 properties:
266 nbId:
267 type: string
268 plmnId:
269 type: string
270 type: object
271 gnb:
272 $ref: '#/components/schemas/Gnb'
273 ip:
274 type: string
275 nodeType:
276 oneOf:
277 - type: string
278 - type: integer
279 port:
280 type: integer
281 ranName:
282 type: string
283 setupFailure:
284 $ref: '#/components/schemas/SetupFailure'
285 additionalProperties: false
286 type: object
287 ErrorResponse:
288 type: object
289 required:
290 - errorCode
291 - errorMessage
292 properties:
293 errorCode:
294 type: string
295 description: >-
296 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
297 state, 404 - resource not found, 500 - RNIB error, 501 - internal
298 problem, 502 - RMR error, 503 - Routing Manager Unavailable
299 errorMessage:
300 type: string
301 description: Human readable text
302 RedButtonPartialSuccessResponseModel:
303 type: object
304 required:
305 - message
306 properties:
307 message:
308 type: string
309 description: Partial success reason
310 E2tIdentity:
311 type: object
312 required:
313 - e2tAddress
314 - ranNames
315 properties:
316 e2tAddress:
317 type: string
318 ranNames:
319 items:
320 type: string
321 type: array
322 RanFunction:
323 properties:
324 ranFunctionId:
325 type: integer
326 ranFunctionDefinition:
327 type: string
328 ranFunctionRevision:
329 type: integer
330 type: object
331 Enb:
332 properties:
333 enbType:
334 oneOf:
335 - type: string
336 - type: integer
337 guGroupIds:
338 items:
339 type: string
340 type: array
341 servedCells:
342 items:
343 properties:
344 bandwidthReducedSi:
345 oneOf:
346 - type: string
347 - type: integer
348 broadcastPlmns:
349 items:
350 type: string
351 type: array
352 cellId:
353 type: string
354 choiceEutraMode:
355 properties:
356 fdd:
357 properties:
358 dlTransmissionBandwidth:
359 oneOf:
360 - type: string
361 - type: integer
362 dlearFcn:
363 type: integer
364 ulTransmissionBandwidth:
365 oneOf:
366 - type: string
367 - type: integer
368 ulearFcn:
369 type: integer
370 additionalProperties: false
371 type: object
372 tdd:
373 properties:
374 additionalSpecialSubframeExtensionInfo:
375 properties:
376 additionalSpecialSubframePatternsExtension:
377 oneOf:
378 - type: string
379 - type: integer
380 cyclicPrefixDl:
381 oneOf:
382 - type: string
383 - type: integer
384 cyclicPrefixUl:
385 oneOf:
386 - type: string
387 - type: integer
388 additionalProperties: false
389 type: object
390 additionalSpecialSubframeInfo:
391 properties:
392 additionalSpecialSubframePatterns:
393 oneOf:
394 - type: string
395 - type: integer
396 cyclicPrefixDl:
397 oneOf:
398 - type: string
399 - type: integer
400 cyclicPrefixUl:
401 oneOf:
402 - type: string
403 - type: integer
404 additionalProperties: false
405 type: object
406 earFcn:
407 type: integer
408 specialSubframeInfo:
409 properties:
410 cyclicPrefixDl:
411 oneOf:
412 - type: string
413 - type: integer
414 cyclicPrefixUl:
415 oneOf:
416 - type: string
417 - type: integer
418 specialSubframePatterns:
419 oneOf:
420 - type: string
421 - type: integer
422 additionalProperties: false
423 type: object
424 subframeAssignment:
425 oneOf:
426 - type: string
427 - type: integer
428 transmissionBandwidth:
429 oneOf:
430 - type: string
431 - type: integer
432 additionalProperties: false
433 type: object
434 additionalProperties: false
435 type: object
436 csgId:
437 type: string
438 eutraMode:
439 oneOf:
440 - type: string
441 - type: integer
442 freqBandIndicatorPriority:
443 oneOf:
444 - type: string
445 - type: integer
446 mbmsServiceAreaIdentities:
447 items:
448 type: string
449 type: array
450 mbsfnSubframeInfos:
451 items:
452 properties:
453 radioframeAllocationOffset:
454 type: integer
455 radioframeAllocationPeriod:
456 oneOf:
457 - type: string
458 - type: integer
459 subframeAllocation:
460 type: string
461 subframeAllocationType:
462 oneOf:
463 - type: string
464 - type: integer
465 additionalProperties: false
466 type: object
467 type: array
468 multibandInfos:
469 items:
470 type: integer
471 type: array
472 neighbourInfos:
473 items:
474 properties:
475 earFcn:
476 type: integer
477 ecgi:
478 type: string
479 pci:
480 type: integer
481 tac:
482 type: string
483 additionalProperties: false
484 type: object
485 type: array
486 numberOfAntennaPorts:
487 oneOf:
488 - type: string
489 - type: integer
490 pci:
491 type: integer
492 prachConfiguration:
493 properties:
494 highSpeedFlag:
495 type: boolean
496 prachConfigurationIndex:
497 type: integer
498 prachFrequencyOffset:
499 type: integer
500 rootSequenceIndex:
501 type: integer
502 zeroCorrelationZoneConfiguration:
503 type: integer
504 type: object
505 tac:
506 type: string
507 type: object
508 type: array
509 type: object
510 Gnb:
511 properties:
512 servedNrCells:
513 $ref: '#/components/schemas/ServedNrCells'
514 ranFunctions:
515 items:
516 $ref: '#/components/schemas/RanFunction'
517 type: array
518 type: object
519 ServedNrCells:
520 items:
521 required:
522 - servedNrCellInformation
523 properties:
524 nrNeighbourInfos:
525 items:
526 required:
527 - choiceNrMode
528 - nrCgi
529 - nrMode
530 - nrPci
531 properties:
532 choiceNrMode:
533 properties:
534 fdd:
535 properties:
536 dlarFcnFreqInfo:
537 properties:
538 frequencyBands:
539 items:
540 properties:
541 nrFrequencyBand:
542 type: integer
543 supportedSulBands:
544 items:
545 type: integer
546 type: array
547 additionalProperties: false
548 type: object
549 type: array
550 nrArFcn:
551 oneOf:
552 - type: integer
553 sulInformation:
554 properties:
555 sulArFcn:
556 oneOf:
557 - type: integer
558 sulTransmissionBandwidth:
559 properties:
560 ncnrb:
561 oneOf:
562 - type: string
563 - type: integer
564 nrscs:
565 oneOf:
566 - type: string
567 - type: integer
568 additionalProperties: false
569 type: object
570 additionalProperties: false
571 type: object
572 additionalProperties: false
573 type: object
574 ularFcnFreqInfo:
575 properties:
576 frequencyBands:
577 items:
578 properties:
579 nrFrequencyBand:
580 type: integer
581 supportedSulBands:
582 items:
583 type: integer
584 type: array
585 additionalProperties: false
586 type: object
587 type: array
588 nrArFcn:
589 oneOf:
590 - type: integer
591 sulInformation:
592 properties:
593 sulArFcn:
594 oneOf:
595 - type: integer
596 sulTransmissionBandwidth:
597 properties:
598 ncnrb:
599 oneOf:
600 - type: string
601 - type: integer
602 nrscs:
603 oneOf:
604 - type: string
605 - type: integer
606 additionalProperties: false
607 type: object
608 additionalProperties: false
609 type: object
610 additionalProperties: false
611 type: object
612 additionalProperties: false
613 type: object
614 tdd:
615 properties:
616 arFcnNrFreqInfo:
617 properties:
618 frequencyBands:
619 items:
620 properties:
621 nrFrequencyBand:
622 type: integer
623 supportedSulBands:
624 items:
625 type: integer
626 type: array
627 additionalProperties: false
628 type: object
629 type: array
630 nrArFcn:
631 oneOf:
632 - type: integer
633 sulInformation:
634 properties:
635 sulArFcn:
636 oneOf:
637 - type: integer
638 sulTransmissionBandwidth:
639 properties:
640 ncnrb:
641 oneOf:
642 - type: string
643 - type: integer
644 nrscs:
645 oneOf:
646 - type: string
647 - type: integer
648 additionalProperties: false
649 type: object
650 additionalProperties: false
651 type: object
652 additionalProperties: false
653 type: object
654 additionalProperties: false
655 type: object
656 additionalProperties: false
657 type: object
658 configuredStac:
659 type: string
660 nrCgi:
661 type: string
662 nrMode:
663 oneOf:
664 - type: string
665 - type: integer
666 nrPci:
667 type: integer
668 stac5g:
669 type: string
670 additionalProperties: false
671 type: object
672 type: array
673 servedNrCellInformation:
674 required:
675 - cellId
676 - choiceNrMode
677 - nrMode
678 - nrPci
679 - servedPlmns
680 properties:
681 cellId:
682 type: string
683 choiceNrMode:
684 properties:
685 fdd:
686 properties:
687 dlFreqInfo:
688 properties:
689 frequencyBands:
690 items:
691 properties:
692 nrFrequencyBand:
693 type: integer
694 supportedSulBands:
695 items:
696 type: integer
697 type: array
698 additionalProperties: false
699 type: object
700 type: array
701 nrArFcn:
702 oneOf:
703 - type: integer
704 sulInformation:
705 properties:
706 sulArFcn:
707 oneOf:
708 - type: integer
709 sulTransmissionBandwidth:
710 properties:
711 ncnrb:
712 oneOf:
713 - type: string
714 - type: integer
715 nrscs:
716 oneOf:
717 - type: string
718 - type: integer
719 additionalProperties: false
720 type: object
721 additionalProperties: false
722 type: object
723 additionalProperties: false
724 type: object
725 dlTransmissionBandwidth:
726 properties:
727 ncnrb:
728 oneOf:
729 - type: string
730 - type: integer
731 nrscs:
732 oneOf:
733 - type: string
734 - type: integer
735 additionalProperties: false
736 type: object
737 ulFreqInfo:
738 properties:
739 frequencyBands:
740 items:
741 properties:
742 nrFrequencyBand:
743 type: integer
744 supportedSulBands:
745 items:
746 type: integer
747 type: array
748 additionalProperties: false
749 type: object
750 type: array
751 nrArFcn:
752 oneOf:
753 - type: integer
754 sulInformation:
755 properties:
756 sulArFcn:
757 oneOf:
758 - type: integer
759 sulTransmissionBandwidth:
760 properties:
761 ncnrb:
762 oneOf:
763 - type: string
764 - type: integer
765 nrscs:
766 oneOf:
767 - type: string
768 - type: integer
769 additionalProperties: false
770 type: object
771 additionalProperties: false
772 type: object
773 additionalProperties: false
774 type: object
775 ulTransmissionBandwidth:
776 properties:
777 ncnrb:
778 oneOf:
779 - type: string
780 - type: integer
781 nrscs:
782 oneOf:
783 - type: string
784 - type: integer
785 additionalProperties: false
786 type: object
787 additionalProperties: false
788 type: object
789 tdd:
790 properties:
791 nrFreqInfo:
792 properties:
793 frequencyBands:
794 items:
795 properties:
796 nrFrequencyBand:
797 type: integer
798 supportedSulBands:
799 items:
800 type: integer
801 type: array
802 additionalProperties: false
803 type: object
804 type: array
805 nrArFcn:
806 oneOf:
807 - type: integer
808 sulInformation:
809 properties:
810 sulArFcn:
811 oneOf:
812 - type: integer
813 sulTransmissionBandwidth:
814 properties:
815 ncnrb:
816 oneOf:
817 - type: string
818 - type: integer
819 nrscs:
820 oneOf:
821 - type: string
822 - type: integer
823 additionalProperties: false
824 type: object
825 additionalProperties: false
826 type: object
827 additionalProperties: false
828 type: object
829 transmissionBandwidth:
830 properties:
831 ncnrb:
832 oneOf:
833 - type: string
834 - type: integer
835 nrscs:
836 oneOf:
837 - type: string
838 - type: integer
839 additionalProperties: false
840 type: object
841 additionalProperties: false
842 type: object
843 additionalProperties: false
844 type: object
845 configuredStac:
846 type: string
847 nrMode:
848 oneOf:
849 - type: string
850 - type: integer
851 nrPci:
852 type: integer
853 servedPlmns:
854 items:
855 type: string
856 type: array
857 stac5g:
858 type: string
859 additionalProperties: false
860 type: object
861 additionalProperties: false
862 type: object
863 type: array
864 SetupFailure:
865 properties:
866 criticalityDiagnostics:
867 properties:
868 informationElementCriticalityDiagnostics:
869 items:
870 properties:
871 ieCriticality:
872 oneOf:
873 - type: string
874 - type: integer
875 ieId:
876 type: integer
877 typeOfError:
878 oneOf:
879 - type: string
880 - type: integer
881 additionalProperties: false
882 type: object
883 type: array
884 procedureCode:
885 type: integer
886 procedureCriticality:
887 oneOf:
888 - type: string
889 - type: integer
890 triggeringMessage:
891 oneOf:
892 - type: string
893 - type: integer
894 additionalProperties: false
895 type: object
896 miscellaneousCause:
897 oneOf:
898 - type: string
899 - type: integer
900 networkLayerCause:
901 oneOf:
902 - type: string
903 - type: integer
904 protocolCause:
905 oneOf:
906 - type: string
907 - type: integer
908 timeToWait:
909 oneOf:
910 - type: string
911 - type: integer
912 transportLayerCause:
913 oneOf:
914 - type: string
915 - type: integer
916 additionalProperties: false
917 type: object