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