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