[RIC-430] KeepAlive Automation fix + Update Swagger - Add ConnectionStatus to Get...
[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.4.5
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         connectionStatus:
333           type: string
334       type: object
335     ErrorResponse:
336       type: object
337       required:
338         - errorCode
339         - errorMessage
340       properties:
341         errorCode:
342           type: string
343           description: >-
344             401 - corrupted json, 402 - validation error, 403 - RAN in wrong
345             state, 404 - resource not found, 500 - RNIB error, 501 - internal
346             problem, 502 - RMR error, 503 - Routing Manager Unavailable
347         errorMessage:
348           type: string
349           description: Human readable text
350     RedButtonPartialSuccessResponseModel:
351       type: object
352       required:
353         - message
354       properties:
355         message:
356           type: string
357           description: Partial success reason
358     E2tIdentity:
359       type: object
360       required:
361         - e2tAddress
362         - ranNames
363       properties:
364         e2tAddress:
365           type: string
366         ranNames:
367           items:
368             type: string
369           type: array
370     RanFunction:
371       properties:
372         ranFunctionId:
373           type: integer
374         ranFunctionDefinition:
375           type: string
376         ranFunctionRevision:
377           type: integer
378       type: object
379     Enb:
380       properties:
381         enbType:
382           oneOf:
383             - type: string
384             - type: integer
385         guGroupIds:
386           items:
387             type: string
388           type: array
389         servedCells:
390           items:
391             properties:
392               bandwidthReducedSi:
393                 oneOf:
394                   - type: string
395                   - type: integer
396               broadcastPlmns:
397                 items:
398                   type: string
399                 type: array
400               cellId:
401                 type: string
402               choiceEutraMode:
403                 properties:
404                   fdd:
405                     properties:
406                       dlTransmissionBandwidth:
407                         oneOf:
408                           - type: string
409                           - type: integer
410                       dlearFcn:
411                         type: integer
412                       ulTransmissionBandwidth:
413                         oneOf:
414                           - type: string
415                           - type: integer
416                       ulearFcn:
417                         type: integer
418                     additionalProperties: false
419                     type: object
420                   tdd:
421                     properties:
422                       additionalSpecialSubframeExtensionInfo:
423                         properties:
424                           additionalSpecialSubframePatternsExtension:
425                             oneOf:
426                               - type: string
427                               - type: integer
428                           cyclicPrefixDl:
429                             oneOf:
430                               - type: string
431                               - type: integer
432                           cyclicPrefixUl:
433                             oneOf:
434                               - type: string
435                               - type: integer
436                         additionalProperties: false
437                         type: object
438                       additionalSpecialSubframeInfo:
439                         properties:
440                           additionalSpecialSubframePatterns:
441                             oneOf:
442                               - type: string
443                               - type: integer
444                           cyclicPrefixDl:
445                             oneOf:
446                               - type: string
447                               - type: integer
448                           cyclicPrefixUl:
449                             oneOf:
450                               - type: string
451                               - type: integer
452                         additionalProperties: false
453                         type: object
454                       earFcn:
455                         type: integer
456                       specialSubframeInfo:
457                         properties:
458                           cyclicPrefixDl:
459                             oneOf:
460                               - type: string
461                               - type: integer
462                           cyclicPrefixUl:
463                             oneOf:
464                               - type: string
465                               - type: integer
466                           specialSubframePatterns:
467                             oneOf:
468                               - type: string
469                               - type: integer
470                         additionalProperties: false
471                         type: object
472                       subframeAssignment:
473                         oneOf:
474                           - type: string
475                           - type: integer
476                       transmissionBandwidth:
477                         oneOf:
478                           - type: string
479                           - type: integer
480                     additionalProperties: false
481                     type: object
482                 additionalProperties: false
483                 type: object
484               csgId:
485                 type: string
486               eutraMode:
487                 oneOf:
488                   - type: string
489                   - type: integer
490               freqBandIndicatorPriority:
491                 oneOf:
492                   - type: string
493                   - type: integer
494               mbmsServiceAreaIdentities:
495                 items:
496                   type: string
497                 type: array
498               mbsfnSubframeInfos:
499                 items:
500                   properties:
501                     radioframeAllocationOffset:
502                       type: integer
503                     radioframeAllocationPeriod:
504                       oneOf:
505                         - type: string
506                         - type: integer
507                     subframeAllocation:
508                       type: string
509                     subframeAllocationType:
510                       oneOf:
511                         - type: string
512                         - type: integer
513                   additionalProperties: false
514                   type: object
515                 type: array
516               multibandInfos:
517                 items:
518                   type: integer
519                 type: array
520               neighbourInfos:
521                 items:
522                   properties:
523                     earFcn:
524                       type: integer
525                     ecgi:
526                       type: string
527                     pci:
528                       type: integer
529                     tac:
530                       type: string
531                   additionalProperties: false
532                   type: object
533                 type: array
534               numberOfAntennaPorts:
535                 oneOf:
536                   - type: string
537                   - type: integer
538               pci:
539                 type: integer
540               prachConfiguration:
541                 properties:
542                   highSpeedFlag:
543                     type: boolean
544                   prachConfigurationIndex:
545                     type: integer
546                   prachFrequencyOffset:
547                     type: integer
548                   rootSequenceIndex:
549                     type: integer
550                   zeroCorrelationZoneConfiguration:
551                     type: integer
552                 type: object
553               tac:
554                 type: string
555               additionalCellInformation:
556                 $ref: '#/components/schemas/AdditionalCellInformation'
557             type: object
558           type: array
559       type: object
560     Gnb:
561       properties:
562         gnbType:
563           oneOf:
564             - type: string
565             - type: integer
566         servedNrCells:
567           $ref: '#/components/schemas/ServedNrCells'
568         ranFunctions:
569           items:
570             $ref: '#/components/schemas/RanFunction'
571           type: array
572       type: object
573     ServedNrCells:
574       items:
575         required:
576           - servedNrCellInformation
577         properties:
578           nrNeighbourInfos:
579             items:
580               required:
581                 - choiceNrMode
582                 - nrCgi
583                 - nrMode
584                 - nrPci
585               properties:
586                 choiceNrMode:
587                   properties:
588                     fdd:
589                       properties:
590                         dlarFcnFreqInfo:
591                           properties:
592                             frequencyBands:
593                               items:
594                                 properties:
595                                   nrFrequencyBand:
596                                     type: integer
597                                   supportedSulBands:
598                                     items:
599                                       type: integer
600                                     type: array
601                                 additionalProperties: false
602                                 type: object
603                               type: array
604                             nrArFcn:
605                               oneOf:
606                                 - type: integer
607                             sulInformation:
608                               properties:
609                                 sulArFcn:
610                                   oneOf:
611                                     - type: integer
612                                 sulTransmissionBandwidth:
613                                   properties:
614                                     ncnrb:
615                                       oneOf:
616                                         - type: string
617                                         - type: integer
618                                     nrscs:
619                                       oneOf:
620                                         - type: string
621                                         - type: integer
622                                   additionalProperties: false
623                                   type: object
624                               additionalProperties: false
625                               type: object
626                           additionalProperties: false
627                           type: object
628                         ularFcnFreqInfo:
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                       additionalProperties: false
667                       type: object
668                     tdd:
669                       properties:
670                         arFcnNrFreqInfo:
671                           properties:
672                             frequencyBands:
673                               items:
674                                 properties:
675                                   nrFrequencyBand:
676                                     type: integer
677                                   supportedSulBands:
678                                     items:
679                                       type: integer
680                                     type: array
681                                 additionalProperties: false
682                                 type: object
683                               type: array
684                             nrArFcn:
685                               oneOf:
686                                 - type: integer
687                             sulInformation:
688                               properties:
689                                 sulArFcn:
690                                   oneOf:
691                                     - type: integer
692                                 sulTransmissionBandwidth:
693                                   properties:
694                                     ncnrb:
695                                       oneOf:
696                                         - type: string
697                                         - type: integer
698                                     nrscs:
699                                       oneOf:
700                                         - type: string
701                                         - type: integer
702                                   additionalProperties: false
703                                   type: object
704                               additionalProperties: false
705                               type: object
706                           additionalProperties: false
707                           type: object
708                       additionalProperties: false
709                       type: object
710                   additionalProperties: false
711                   type: object
712                 configuredStac:
713                   type: string
714                 nrCgi:
715                   type: string
716                 nrMode:
717                   oneOf:
718                     - type: string
719                     - type: integer
720                 nrPci:
721                   type: integer
722                 stac5g:
723                   type: string
724               additionalProperties: false
725               type: object
726             type: array
727           servedNrCellInformation:
728             required:
729               - cellId
730               - choiceNrMode
731               - nrMode
732               - nrPci
733               - servedPlmns
734             properties:
735               cellId:
736                 type: string
737               choiceNrMode:
738                 properties:
739                   fdd:
740                     properties:
741                       dlFreqInfo:
742                         properties:
743                           frequencyBands:
744                             items:
745                               properties:
746                                 nrFrequencyBand:
747                                   type: integer
748                                 supportedSulBands:
749                                   items:
750                                     type: integer
751                                   type: array
752                               additionalProperties: false
753                               type: object
754                             type: array
755                           nrArFcn:
756                             oneOf:
757                               - type: integer
758                           sulInformation:
759                             properties:
760                               sulArFcn:
761                                 oneOf:
762                                   - type: integer
763                               sulTransmissionBandwidth:
764                                 properties:
765                                   ncnrb:
766                                     oneOf:
767                                       - type: string
768                                       - type: integer
769                                   nrscs:
770                                     oneOf:
771                                       - type: string
772                                       - type: integer
773                                 additionalProperties: false
774                                 type: object
775                             additionalProperties: false
776                             type: object
777                         additionalProperties: false
778                         type: object
779                       dlTransmissionBandwidth:
780                         properties:
781                           ncnrb:
782                             oneOf:
783                               - type: string
784                               - type: integer
785                           nrscs:
786                             oneOf:
787                               - type: string
788                               - type: integer
789                         additionalProperties: false
790                         type: object
791                       ulFreqInfo:
792                         properties:
793                           frequencyBands:
794                             items:
795                               properties:
796                                 nrFrequencyBand:
797                                   type: integer
798                                 supportedSulBands:
799                                   items:
800                                     type: integer
801                                   type: array
802                               additionalProperties: false
803                               type: object
804                             type: array
805                           nrArFcn:
806                             oneOf:
807                               - type: integer
808                           sulInformation:
809                             properties:
810                               sulArFcn:
811                                 oneOf:
812                                   - type: integer
813                               sulTransmissionBandwidth:
814                                 properties:
815                                   ncnrb:
816                                     oneOf:
817                                       - type: string
818                                       - type: integer
819                                   nrscs:
820                                     oneOf:
821                                       - type: string
822                                       - type: integer
823                                 additionalProperties: false
824                                 type: object
825                             additionalProperties: false
826                             type: object
827                         additionalProperties: false
828                         type: object
829                       ulTransmissionBandwidth:
830                         properties:
831                           ncnrb:
832                             oneOf:
833                               - type: string
834                               - type: integer
835                           nrscs:
836                             oneOf:
837                               - type: string
838                               - type: integer
839                         additionalProperties: false
840                         type: object
841                     additionalProperties: false
842                     type: object
843                   tdd:
844                     properties:
845                       nrFreqInfo:
846                         properties:
847                           frequencyBands:
848                             items:
849                               properties:
850                                 nrFrequencyBand:
851                                   type: integer
852                                 supportedSulBands:
853                                   items:
854                                     type: integer
855                                   type: array
856                               additionalProperties: false
857                               type: object
858                             type: array
859                           nrArFcn:
860                             oneOf:
861                               - type: integer
862                           sulInformation:
863                             properties:
864                               sulArFcn:
865                                 oneOf:
866                                   - type: integer
867                               sulTransmissionBandwidth:
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                         additionalProperties: false
882                         type: object
883                       transmissionBandwidth:
884                         properties:
885                           ncnrb:
886                             oneOf:
887                               - type: string
888                               - type: integer
889                           nrscs:
890                             oneOf:
891                               - type: string
892                               - type: integer
893                         additionalProperties: false
894                         type: object
895                     additionalProperties: false
896                     type: object
897                 additionalProperties: false
898                 type: object
899               configuredStac:
900                 type: string
901               nrMode:
902                 oneOf:
903                   - type: string
904                   - type: integer
905               nrPci:
906                 type: integer
907               servedPlmns:
908                 items:
909                   type: string
910                 type: array
911               stac5g:
912                 type: string
913               additionalCellInformation:
914                 $ref: '#/components/schemas/AdditionalCellInformation'
915             additionalProperties: false
916             type: object
917         additionalProperties: false
918         type: object
919       type: array
920     SetupFailure:
921       properties:
922         criticalityDiagnostics:
923           properties:
924             informationElementCriticalityDiagnostics:
925               items:
926                 properties:
927                   ieCriticality:
928                     oneOf:
929                       - type: string
930                       - type: integer
931                   ieId:
932                     type: integer
933                   typeOfError:
934                     oneOf:
935                       - type: string
936                       - type: integer
937                 additionalProperties: false
938                 type: object
939               type: array
940             procedureCode:
941               type: integer
942             procedureCriticality:
943               oneOf:
944                 - type: string
945                 - type: integer
946             triggeringMessage:
947               oneOf:
948                 - type: string
949                 - type: integer
950           additionalProperties: false
951           type: object
952         miscellaneousCause:
953           oneOf:
954             - type: string
955             - type: integer
956         networkLayerCause:
957           oneOf:
958             - type: string
959             - type: integer
960         protocolCause:
961           oneOf:
962             - type: string
963             - type: integer
964         timeToWait:
965           oneOf:
966             - type: string
967             - type: integer
968         transportLayerCause:
969           oneOf:
970             - type: string
971             - type: integer
972       additionalProperties: false
973       type: object
974     AddEnbRequest:
975       type: object
976       required:
977         - ranName
978         - globalNbId
979         - enb
980       properties:
981         ranName:
982           type: string
983         globalNbId:
984           properties:
985             nbId:
986               type: string
987             plmnId:
988               type: string
989         ip:
990           type: string
991         port:
992           type: integer
993         enb:
994           $ref: '#/components/schemas/Enb'
995       additionalProperties: false
996     AdditionalCellInformation:
997       properties:
998         cellLatitude:
999           type: number
1000         cellLongitude:
1001           type: number
1002         antennaHeight:
1003           type: number
1004         antennaAzimuthDirection:
1005           type: number
1006         antennaTiltAngle:
1007           type: number
1008         antennaMaxTransmit:
1009           type: number
1010         antennaMaxGain:
1011           type: number
1012         sectorId:
1013           type: integer
1014       type: object
1015     NodebResponse:
1016       properties:
1017         connectionStatus:
1018           oneOf:
1019             - type: string
1020             - type: integer
1021         enb:
1022           $ref: '#/components/schemas/Enb'
1023         failureType:
1024           oneOf:
1025             - type: string
1026             - type: integer
1027         globalNbId:
1028           properties:
1029             nbId:
1030               type: string
1031             plmnId:
1032               type: string
1033           type: object
1034         gnb:
1035           $ref: '#/components/schemas/Gnb'
1036         ip:
1037           type: string
1038         nodeType:
1039           oneOf:
1040             - type: string
1041             - type: integer
1042         port:
1043           type: integer
1044         ranName:
1045           type: string
1046         setupFailure:
1047           $ref: '#/components/schemas/SetupFailure'
1048         setupFromNetwork:
1049           type: boolean
1050       additionalProperties: false
1051       type: object