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