[RIC-571] Increment Swagger version to 5.2.21
[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.21
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         gnbType:
561           oneOf:
562             - type: string
563             - type: integer
564         servedNrCells:
565           $ref: '#/components/schemas/ServedNrCells'
566         ranFunctions:
567           items:
568             $ref: '#/components/schemas/RanFunction'
569           type: array
570       type: object
571     ServedNrCells:
572       items:
573         required:
574           - servedNrCellInformation
575         properties:
576           nrNeighbourInfos:
577             items:
578               required:
579                 - choiceNrMode
580                 - nrCgi
581                 - nrMode
582                 - nrPci
583               properties:
584                 choiceNrMode:
585                   properties:
586                     fdd:
587                       properties:
588                         dlarFcnFreqInfo:
589                           properties:
590                             frequencyBands:
591                               items:
592                                 properties:
593                                   nrFrequencyBand:
594                                     type: integer
595                                   supportedSulBands:
596                                     items:
597                                       type: integer
598                                     type: array
599                                 additionalProperties: false
600                                 type: object
601                               type: array
602                             nrArFcn:
603                               oneOf:
604                                 - type: integer
605                             sulInformation:
606                               properties:
607                                 sulArFcn:
608                                   oneOf:
609                                     - type: integer
610                                 sulTransmissionBandwidth:
611                                   properties:
612                                     ncnrb:
613                                       oneOf:
614                                         - type: string
615                                         - type: integer
616                                     nrscs:
617                                       oneOf:
618                                         - type: string
619                                         - type: integer
620                                   additionalProperties: false
621                                   type: object
622                               additionalProperties: false
623                               type: object
624                           additionalProperties: false
625                           type: object
626                         ularFcnFreqInfo:
627                           properties:
628                             frequencyBands:
629                               items:
630                                 properties:
631                                   nrFrequencyBand:
632                                     type: integer
633                                   supportedSulBands:
634                                     items:
635                                       type: integer
636                                     type: array
637                                 additionalProperties: false
638                                 type: object
639                               type: array
640                             nrArFcn:
641                               oneOf:
642                                 - type: integer
643                             sulInformation:
644                               properties:
645                                 sulArFcn:
646                                   oneOf:
647                                     - type: integer
648                                 sulTransmissionBandwidth:
649                                   properties:
650                                     ncnrb:
651                                       oneOf:
652                                         - type: string
653                                         - type: integer
654                                     nrscs:
655                                       oneOf:
656                                         - type: string
657                                         - type: integer
658                                   additionalProperties: false
659                                   type: object
660                               additionalProperties: false
661                               type: object
662                           additionalProperties: false
663                           type: object
664                       additionalProperties: false
665                       type: object
666                     tdd:
667                       properties:
668                         arFcnNrFreqInfo:
669                           properties:
670                             frequencyBands:
671                               items:
672                                 properties:
673                                   nrFrequencyBand:
674                                     type: integer
675                                   supportedSulBands:
676                                     items:
677                                       type: integer
678                                     type: array
679                                 additionalProperties: false
680                                 type: object
681                               type: array
682                             nrArFcn:
683                               oneOf:
684                                 - type: integer
685                             sulInformation:
686                               properties:
687                                 sulArFcn:
688                                   oneOf:
689                                     - type: integer
690                                 sulTransmissionBandwidth:
691                                   properties:
692                                     ncnrb:
693                                       oneOf:
694                                         - type: string
695                                         - type: integer
696                                     nrscs:
697                                       oneOf:
698                                         - type: string
699                                         - type: integer
700                                   additionalProperties: false
701                                   type: object
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                 configuredStac:
711                   type: string
712                 nrCgi:
713                   type: string
714                 nrMode:
715                   oneOf:
716                     - type: string
717                     - type: integer
718                 nrPci:
719                   type: integer
720                 stac5g:
721                   type: string
722               additionalProperties: false
723               type: object
724             type: array
725           servedNrCellInformation:
726             required:
727               - cellId
728               - choiceNrMode
729               - nrMode
730               - nrPci
731               - servedPlmns
732             properties:
733               cellId:
734                 type: string
735               choiceNrMode:
736                 properties:
737                   fdd:
738                     properties:
739                       dlFreqInfo:
740                         properties:
741                           frequencyBands:
742                             items:
743                               properties:
744                                 nrFrequencyBand:
745                                   type: integer
746                                 supportedSulBands:
747                                   items:
748                                     type: integer
749                                   type: array
750                               additionalProperties: false
751                               type: object
752                             type: array
753                           nrArFcn:
754                             oneOf:
755                               - type: integer
756                           sulInformation:
757                             properties:
758                               sulArFcn:
759                                 oneOf:
760                                   - type: integer
761                               sulTransmissionBandwidth:
762                                 properties:
763                                   ncnrb:
764                                     oneOf:
765                                       - type: string
766                                       - type: integer
767                                   nrscs:
768                                     oneOf:
769                                       - type: string
770                                       - type: integer
771                                 additionalProperties: false
772                                 type: object
773                             additionalProperties: false
774                             type: object
775                         additionalProperties: false
776                         type: object
777                       dlTransmissionBandwidth:
778                         properties:
779                           ncnrb:
780                             oneOf:
781                               - type: string
782                               - type: integer
783                           nrscs:
784                             oneOf:
785                               - type: string
786                               - type: integer
787                         additionalProperties: false
788                         type: object
789                       ulFreqInfo:
790                         properties:
791                           frequencyBands:
792                             items:
793                               properties:
794                                 nrFrequencyBand:
795                                   type: integer
796                                 supportedSulBands:
797                                   items:
798                                     type: integer
799                                   type: array
800                               additionalProperties: false
801                               type: object
802                             type: array
803                           nrArFcn:
804                             oneOf:
805                               - type: integer
806                           sulInformation:
807                             properties:
808                               sulArFcn:
809                                 oneOf:
810                                   - type: integer
811                               sulTransmissionBandwidth:
812                                 properties:
813                                   ncnrb:
814                                     oneOf:
815                                       - type: string
816                                       - type: integer
817                                   nrscs:
818                                     oneOf:
819                                       - type: string
820                                       - type: integer
821                                 additionalProperties: false
822                                 type: object
823                             additionalProperties: false
824                             type: object
825                         additionalProperties: false
826                         type: object
827                       ulTransmissionBandwidth:
828                         properties:
829                           ncnrb:
830                             oneOf:
831                               - type: string
832                               - type: integer
833                           nrscs:
834                             oneOf:
835                               - type: string
836                               - type: integer
837                         additionalProperties: false
838                         type: object
839                     additionalProperties: false
840                     type: object
841                   tdd:
842                     properties:
843                       nrFreqInfo:
844                         properties:
845                           frequencyBands:
846                             items:
847                               properties:
848                                 nrFrequencyBand:
849                                   type: integer
850                                 supportedSulBands:
851                                   items:
852                                     type: integer
853                                   type: array
854                               additionalProperties: false
855                               type: object
856                             type: array
857                           nrArFcn:
858                             oneOf:
859                               - type: integer
860                           sulInformation:
861                             properties:
862                               sulArFcn:
863                                 oneOf:
864                                   - type: integer
865                               sulTransmissionBandwidth:
866                                 properties:
867                                   ncnrb:
868                                     oneOf:
869                                       - type: string
870                                       - type: integer
871                                   nrscs:
872                                     oneOf:
873                                       - type: string
874                                       - type: integer
875                                 additionalProperties: false
876                                 type: object
877                             additionalProperties: false
878                             type: object
879                         additionalProperties: false
880                         type: object
881                       transmissionBandwidth:
882                         properties:
883                           ncnrb:
884                             oneOf:
885                               - type: string
886                               - type: integer
887                           nrscs:
888                             oneOf:
889                               - type: string
890                               - type: integer
891                         additionalProperties: false
892                         type: object
893                     additionalProperties: false
894                     type: object
895                 additionalProperties: false
896                 type: object
897               configuredStac:
898                 type: string
899               nrMode:
900                 oneOf:
901                   - type: string
902                   - type: integer
903               nrPci:
904                 type: integer
905               servedPlmns:
906                 items:
907                   type: string
908                 type: array
909               stac5g:
910                 type: string
911               additionalCellInformation:
912                 $ref: '#/components/schemas/AdditionalCellInformation'
913             additionalProperties: false
914             type: object
915         additionalProperties: false
916         type: object
917       type: array
918     SetupFailure:
919       properties:
920         criticalityDiagnostics:
921           properties:
922             informationElementCriticalityDiagnostics:
923               items:
924                 properties:
925                   ieCriticality:
926                     oneOf:
927                       - type: string
928                       - type: integer
929                   ieId:
930                     type: integer
931                   typeOfError:
932                     oneOf:
933                       - type: string
934                       - type: integer
935                 additionalProperties: false
936                 type: object
937               type: array
938             procedureCode:
939               type: integer
940             procedureCriticality:
941               oneOf:
942                 - type: string
943                 - type: integer
944             triggeringMessage:
945               oneOf:
946                 - type: string
947                 - type: integer
948           additionalProperties: false
949           type: object
950         miscellaneousCause:
951           oneOf:
952             - type: string
953             - type: integer
954         networkLayerCause:
955           oneOf:
956             - type: string
957             - type: integer
958         protocolCause:
959           oneOf:
960             - type: string
961             - type: integer
962         timeToWait:
963           oneOf:
964             - type: string
965             - type: integer
966         transportLayerCause:
967           oneOf:
968             - type: string
969             - type: integer
970       additionalProperties: false
971       type: object
972     AddEnbRequest:
973       type: object
974       required:
975         - ranName
976         - globalNbId
977         - enb
978       properties:
979         ranName:
980           type: string
981         globalNbId:
982           properties:
983             nbId:
984               type: string
985             plmnId:
986               type: string
987         ip:
988           type: string
989         port:
990           type: integer
991         enb:
992           $ref: '#/components/schemas/Enb'
993       additionalProperties: false
994     AdditionalCellInformation:
995       properties:
996         cellLatitude:
997           type: number
998         cellLongitude:
999           type: number
1000         antennaHeight:
1001           type: number
1002         antennaAzimuthDirection:
1003           type: number
1004         antennaTiltAngle:
1005           type: number
1006         antennaMaxTransmit:
1007           type: number
1008         antennaMaxGain:
1009           type: number
1010         sectorId:
1011           type: integer
1012       type: object
1013     NodebResponse:
1014       properties:
1015         connectionStatus:
1016           oneOf:
1017             - type: string
1018             - type: integer
1019         enb:
1020           $ref: '#/components/schemas/Enb'
1021         failureType:
1022           oneOf:
1023             - type: string
1024             - type: integer
1025         globalNbId:
1026           properties:
1027             nbId:
1028               type: string
1029             plmnId:
1030               type: string
1031           type: object
1032         gnb:
1033           $ref: '#/components/schemas/Gnb'
1034         ip:
1035           type: string
1036         nodeType:
1037           oneOf:
1038             - type: string
1039             - type: integer
1040         port:
1041           type: integer
1042         ranName:
1043           type: string
1044         setupFailure:
1045           $ref: '#/components/schemas/SetupFailure'
1046         setupFromNetwork:
1047           type: boolean
1048       additionalProperties: false
1049       type: object