Upgrade E2 manager spec to version 2019-08-13
[portal/ric-dashboard.git] / e2-mgr-client / src / main / resources / E2M_API_2019-08-13.yaml
1 # ========================LICENSE_START=================================
2 # O-RAN-SC
3 #
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
5 #
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
9 #
10 #      http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ========================LICENSE_END===================================
18 openapi: 3.0.0
19 info:
20   title: E2 Manager Service
21   description: E2 Manager Service APIs
22   version: 1.0.0
23 servers:
24   - url: 'http://{apiRoot}/v1'
25     variables:
26       apiRoot:
27         default: 'localhost:3800'
28 paths:
29   /nodeb/x2-setup:
30     post:
31       summary: X2 Setup
32       tags:
33         - nodeb
34       operationId: x2Setup
35       requestBody:
36         content:
37           application/json:
38             schema:
39               $ref: '#/components/schemas/SetupRequest'
40         required: true
41       responses:
42         '200':
43           description: Success
44         '400':
45           description: Invalid input
46           content:
47             application/problem+json:
48               schema:
49                 $ref: '#/components/schemas/ErrorResponse'
50         '500':
51           description: Internal error
52           content:
53             application/problem+json:
54               schema:
55                 $ref: '#/components/schemas/ErrorResponse'
56   /nodeb/endc-setup:
57     post:
58       tags:
59         - nodeb
60       summary: ENDC Setup
61       operationId: endcSetup
62       requestBody:
63         content:
64           application/json:
65             schema:
66               $ref: '#/components/schemas/SetupRequest'
67         required: true
68       responses:
69         '200':
70           description: Success
71         '400':
72           description: Invalid input
73           content:
74             application/json:
75               schema:
76                 $ref: '#/components/schemas/ErrorResponse'
77         '500':
78           description: Internal Error
79           content:
80             application/problem+json:
81               schema:
82                 $ref: '#/components/schemas/ErrorResponse'
83   '/nodeb/{ranName}':
84     get:
85       tags:
86         - nodeb
87       summary: Get RAN by name
88       operationId: getNb
89       parameters:
90         - name: ranName
91           in: path
92           required: true
93           description: Name of RAN to return
94           schema:
95             type: string
96       responses:
97         '200':
98           description: Successful operation
99           content:
100             application/json:
101               schema:
102                 $ref: '#/components/schemas/GetNodebResponse'
103         '400':
104           description: The specified RAN name is invalid
105           content:
106             application/json:
107               schema:
108                 $ref: '#/components/schemas/ErrorResponse'
109         '404':
110           description: A RAN with the specified name was not found
111           content:
112             application/problem+json:
113               schema:
114                 $ref: '#/components/schemas/ErrorResponse'
115         '500':
116           description: Internal Error
117           content:
118             application/problem+json:
119               schema:
120                 $ref: '#/components/schemas/ErrorResponse'
121   /nodeb/shutdown:
122     put:
123       tags:
124         - nodeb
125       summary: >-
126         Close all connections to the RANs
127       responses:
128         '204':
129           description: Successful operation
130         '500':
131           description: Internal Error
132           content:
133             application/problem+json:
134               schema:
135                 $ref: '#/components/schemas/ErrorResponse'
136   /nodeb-ids:
137     get:
138       tags:
139         - nodeb
140       summary: Get RANs identities list
141       operationId: getNodebIdList
142       responses:
143         '200':
144           description: Successful operation
145           content:
146             application/json:
147               schema:
148                 type: array
149                 items:
150                   $ref: '#/components/schemas/NodebIdentity'
151         '500':
152           description: Internal Error
153           content:
154             application/problem+json:
155               schema:
156                 $ref: '#/components/schemas/ErrorResponse'
157   /nodeb/{ranName}/reset:
158     put:
159       tags:
160         - nodeb
161       summary: >-
162         Upon receipt of this message, 'ranName' shall abort any other ongoing procedures over X2 between the RIC and the RAN. The RAN shall delete all the context information related to the RIC, except the application level configuration data exchanged during the X2 Setup or eNB Configuration Update procedures, and release the corresponding resource.
163       operationId: reset
164       parameters:
165         - name: ranName
166           in: path
167           required: true
168           description: Name of RAN to return
169           schema:
170             type: string
171       requestBody:
172         content:
173           application/json:
174             schema:
175               $ref: '#/components/schemas/ResetRequest'
176         required: false
177       responses:
178         '204':
179           description: Successful operation
180         '400':
181           description: Invalid input (invalid cause, RAN in wrong state)
182           content:
183             application/problem+json:
184               schema:
185                 $ref: '#/components/schemas/ErrorResponse'
186         '404':
187           description: A RAN with the specified name was not found
188           content:
189             application/problem+json:
190               schema:
191                 $ref: '#/components/schemas/ErrorResponse'
192         '500':
193           description: Internal Error
194           content:
195             application/problem+json:
196               schema:
197                 $ref: '#/components/schemas/ErrorResponse'
198
199   /health:
200     get:
201       tags:
202         - Health Check
203       summary: E2 Manager Service Health Check
204       responses:
205         '200':
206           description: OK
207 components:
208   schemas:
209     SetupRequest:
210       type: object
211       required:
212         - ranIp
213         - ranPort
214         - ranName
215       properties:
216         ranIp:
217           type: string
218         ranPort:
219           type: integer
220           format: uint16
221         ranName:
222           type: string
223     ResetRequest:
224       type: object
225       required:
226         - cause
227       properties:
228         cause:
229           type: string
230           enum: [misc:control-processing-overload,
231 misc:hardware-failure,
232 misc:om-intervention,
233 misc:not-enough-user-plane-processing-resources,
234 misc:unspecified,
235 protocol:transfer-syntax-error,
236 protocol:abstract-syntax-error-reject,
237 protocol:abstract-syntax-error-ignore-and-notify,
238 protocol:message-not-compatible-with-receiver-state,
239 protocol:semantic-error,
240 protocol:unspecified,
241 protocol:abstract-syntax-error-falsely-constructed-message,
242 transport:transport-resource-unavailable,
243 radioNetwork:handover-desirable-for-radio-reasons,
244 radioNetwork:time-critical-handover,
245 radioNetwork:resource-optimisation-handover,
246 radioNetwork:reduce-load-in-serving-cell,
247 radioNetwork:partial-handover,
248 radioNetwork:unknown-new-eNB-UE-X2AP-ID,
249 radioNetwork:unknown-old-eNB-UE-X2AP-ID,
250 radioNetwork:unknown-pair-of-UE-X2AP-ID,
251 radioNetwork:ho-target-not-allowed,
252 radioNetwork:tx2relocoverall-expiry,
253 radioNetwork:trelocprep-expiry,
254 radioNetwork:cell-not-available,
255 radioNetwork:no-radio-resources-available-in-target-cell,
256 radioNetwork:invalid-MME-GroupID,
257 radioNetwork:unknown-MME-Code,
258 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
259 radioNetwork:reportCharacteristicsEmpty,
260 radioNetwork:noReportPeriodicity,
261 radioNetwork:existingMeasurementID,
262 radioNetwork:unknown-eNB-Measurement-ID,
263 radioNetwork:measurement-temporarily-not-available,
264 radioNetwork:unspecified,
265 radioNetwork:load-balancing,
266 radioNetwork:handover-optimisation,
267 radioNetwork:value-out-of-allowed-range,
268 radioNetwork:multiple-E-RAB-ID-instances,
269 radioNetwork:switch-off-ongoing,
270 radioNetwork:not-supported-QCI-value,
271 radioNetwork:measurement-not-supported-for-the-object,
272 radioNetwork:tDCoverall-expiry,
273 radioNetwork:tDCprep-expiry,
274 radioNetwork:action-desirable-for-radio-reasons,
275 radioNetwork:reduce-load,
276 radioNetwork:resource-optimisation,
277 radioNetwork:time-critical-action,
278 radioNetwork:target-not-allowed,
279 radioNetwork:no-radio-resources-available,
280 radioNetwork:invalid-QoS-combination,
281 radioNetwork:encryption-algorithms-not-aupported,
282 radioNetwork:procedure-cancelled,
283 radioNetwork:rRM-purpose,
284 radioNetwork:improve-user-bit-rate,
285 radioNetwork:user-inactivity,
286 radioNetwork:radio-connection-with-UE-lost,
287 radioNetwork:failure-in-the-radio-interface-procedure,
288 radioNetwork:bearer-option-not-supported,
289 radioNetwork:mCG-Mobility,
290 radioNetwork:sCG-Mobility,
291 radioNetwork:count-reaches-max-value,
292 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
293 radioNetwork:pDCP-Overload]
294     NodebIdentity:
295       properties:
296         globalNbId:
297           properties:
298             nbId:
299               type: string
300             plmnId:
301               type: string
302           type: object
303         inventoryName:
304           type: string
305       type: object
306     GetNodebResponse:
307       properties:
308         connectionStatus:
309           oneOf:
310             - type: string
311             - type: integer
312         enb:
313           properties:
314             enbType:
315               oneOf:
316                 - type: string
317                 - type: integer
318             guGroupIds:
319               items:
320                 type: string
321               type: array
322             servedCells:
323               items:
324                 properties:
325                   bandwidthReducedSi:
326                     oneOf:
327                       - type: string
328                       - type: integer
329                   broadcastPlmns:
330                     items:
331                       type: string
332                     type: array
333                   cellId:
334                     type: string
335                   choiceEutraMode:
336                     properties:
337                       fdd:
338                         properties:
339                           dlTransmissionBandwidth:
340                             oneOf:
341                               - type: string
342                               - type: integer
343                           dlearFcn:
344                             type: integer
345                           ulTransmissionBandwidth:
346                             oneOf:
347                               - type: string
348                               - type: integer
349                           ulearFcn:
350                             type: integer
351                         additionalProperties: false
352                         type: object
353                       tdd:
354                         properties:
355                           additionalSpecialSubframeExtensionInfo:
356                             properties:
357                               additionalSpecialSubframePatternsExtension:
358                                 oneOf:
359                                   - type: string
360                                   - type: integer
361                               cyclicPrefixDl:
362                                 oneOf:
363                                   - type: string
364                                   - type: integer
365                               cyclicPrefixUl:
366                                 oneOf:
367                                   - type: string
368                                   - type: integer
369                             additionalProperties: false
370                             type: object
371                           additionalSpecialSubframeInfo:
372                             properties:
373                               additionalSpecialSubframePatterns:
374                                 oneOf:
375                                   - type: string
376                                   - type: integer
377                               cyclicPrefixDl:
378                                 oneOf:
379                                   - type: string
380                                   - type: integer
381                               cyclicPrefixUl:
382                                 oneOf:
383                                   - type: string
384                                   - type: integer
385                             additionalProperties: false
386                             type: object
387                           earFcn:
388                             type: integer
389                           specialSubframeInfo:
390                             properties:
391                               cyclicPrefixDl:
392                                 oneOf:
393                                   - type: string
394                                   - type: integer
395                               cyclicPrefixUl:
396                                 oneOf:
397                                   - type: string
398                                   - type: integer
399                               specialSubframePatterns:
400                                 oneOf:
401                                   - type: string
402                                   - type: integer
403                             additionalProperties: false
404                             type: object
405                           subframeAssignment:
406                             oneOf:
407                               - type: string
408                               - type: integer
409                           transmissionBandwidth:
410                             oneOf:
411                               - type: string
412                               - type: integer
413                         additionalProperties: false
414                         type: object
415                     additionalProperties: false
416                     type: object
417                   csgId:
418                     type: string
419                   eutraMode:
420                     oneOf:
421                       - type: string
422                       - type: integer
423                   freqBandIndicatorPriority:
424                     oneOf:
425                       - type: string
426                       - type: integer
427                   mbmsServiceAreaIdentities:
428                     items:
429                       type: string
430                     type: array
431                   mbsfnSubframeInfos:
432                     items:
433                       properties:
434                         radioframeAllocationOffset:
435                           type: integer
436                         radioframeAllocationPeriod:
437                           oneOf:
438                             - type: string
439                             - type: integer
440                         subframeAllocation:
441                           type: string
442                         subframeAllocationType:
443                           oneOf:
444                             - type: string
445                             - type: integer
446                       additionalProperties: false
447                       type: object
448                     type: array
449                   multibandInfos:
450                     items:
451                       type: integer
452                     type: array
453                   neighbourInfos:
454                     items:
455                       properties:
456                         earFcn:
457                           type: integer
458                         ecgi:
459                           type: string
460                         pci:
461                           type: integer
462                         tac:
463                           type: string
464                       additionalProperties: false
465                       type: object
466                     type: array
467                   numberOfAntennaPorts:
468                     oneOf:
469                       - type: string
470                       - type: integer
471                   pci:
472                     type: integer
473                   prachConfiguration:
474                     properties:
475                       highSpeedFlag:
476                         type: boolean
477                       prachConfigurationIndex:
478                         type: integer
479                       prachFrequencyOffset:
480                         type: integer
481                       rootSequenceIndex:
482                         type: integer
483                       zeroCorrelationZoneConfiguration:
484                         type: integer
485                     additionalProperties: false
486                     type: object
487                   tac:
488                     type: string
489                 additionalProperties: false
490                 type: object
491               type: array
492           additionalProperties: false
493           type: object
494         failureType:
495           oneOf:
496             - type: string
497             - type: integer
498         globalNbId:
499           properties:
500             nbId:
501               type: string
502             plmnId:
503               type: string
504           additionalProperties: false
505           type: object
506         gnb:
507           properties:
508             servedNrCells:
509               items:
510                 properties:
511                   nrNeighbourInfos:
512                     items:
513                       properties:
514                         choiceNrMode:
515                           properties:
516                             fdd:
517                               properties:
518                                 dlarFcnFreqInfo:
519                                   properties:
520                                     frequencyBands:
521                                       items:
522                                         properties:
523                                           nrFrequencyBand:
524                                             type: integer
525                                           supportedSulBands:
526                                             items:
527                                               type: integer
528                                             type: array
529                                         additionalProperties: false
530                                         type: object
531                                       type: array
532                                     nrArFcn:
533                                       oneOf:
534                                         - type: integer
535                                     sulInformation:
536                                       properties:
537                                         sulArFcn:
538                                           oneOf:
539                                             - type: integer
540                                         sulTransmissionBandwidth:
541                                           properties:
542                                             ncnrb:
543                                               oneOf:
544                                                 - type: string
545                                                 - type: integer
546                                             nrscs:
547                                               oneOf:
548                                                 - type: string
549                                                 - type: integer
550                                           additionalProperties: false
551                                           type: object
552                                       additionalProperties: false
553                                       type: object
554                                   additionalProperties: false
555                                   type: object
556                                 ularFcnFreqInfo:
557                                   properties:
558                                     frequencyBands:
559                                       items:
560                                         properties:
561                                           nrFrequencyBand:
562                                             type: integer
563                                           supportedSulBands:
564                                             items:
565                                               type: integer
566                                             type: array
567                                         additionalProperties: false
568                                         type: object
569                                       type: array
570                                     nrArFcn:
571                                       oneOf:
572                                         - type: integer
573                                     sulInformation:
574                                       properties:
575                                         sulArFcn:
576                                           oneOf:
577                                             - type: integer
578                                         sulTransmissionBandwidth:
579                                           properties:
580                                             ncnrb:
581                                               oneOf:
582                                                 - type: string
583                                                 - type: integer
584                                             nrscs:
585                                               oneOf:
586                                                 - type: string
587                                                 - type: integer
588                                           additionalProperties: false
589                                           type: object
590                                       additionalProperties: false
591                                       type: object
592                                   additionalProperties: false
593                                   type: object
594                               additionalProperties: false
595                               type: object
596                             tdd:
597                               properties:
598                                 arFcnNrFreqInfo:
599                                   properties:
600                                     frequencyBands:
601                                       items:
602                                         properties:
603                                           nrFrequencyBand:
604                                             type: integer
605                                           supportedSulBands:
606                                             items:
607                                               type: integer
608                                             type: array
609                                         additionalProperties: false
610                                         type: object
611                                       type: array
612                                     nrArFcn:
613                                       oneOf:
614                                         - type: integer
615                                     sulInformation:
616                                       properties:
617                                         sulArFcn:
618                                           oneOf:
619                                             - type: integer
620                                         sulTransmissionBandwidth:
621                                           properties:
622                                             ncnrb:
623                                               oneOf:
624                                                 - type: string
625                                                 - type: integer
626                                             nrscs:
627                                               oneOf:
628                                                 - type: string
629                                                 - type: integer
630                                           additionalProperties: false
631                                           type: object
632                                       additionalProperties: false
633                                       type: object
634                                   additionalProperties: false
635                                   type: object
636                               additionalProperties: false
637                               type: object
638                           additionalProperties: false
639                           type: object
640                         configuredStac:
641                           type: string
642                         nrCgi:
643                           type: string
644                         nrMode:
645                           oneOf:
646                             - type: string
647                             - type: integer
648                         nrPci:
649                           type: integer
650                         stac5g:
651                           type: string
652                       additionalProperties: false
653                       type: object
654                     type: array
655                   servedNrCellInformation:
656                     properties:
657                       cellId:
658                         type: string
659                       choiceNrMode:
660                         properties:
661                           fdd:
662                             properties:
663                               dlFreqInfo:
664                                 properties:
665                                   frequencyBands:
666                                     items:
667                                       properties:
668                                         nrFrequencyBand:
669                                           type: integer
670                                         supportedSulBands:
671                                           items:
672                                             type: integer
673                                           type: array
674                                       additionalProperties: false
675                                       type: object
676                                     type: array
677                                   nrArFcn:
678                                     oneOf:
679                                       - type: integer
680                                   sulInformation:
681                                     properties:
682                                       sulArFcn:
683                                         oneOf:
684                                           - type: integer
685                                       sulTransmissionBandwidth:
686                                         properties:
687                                           ncnrb:
688                                             oneOf:
689                                               - type: string
690                                               - type: integer
691                                           nrscs:
692                                             oneOf:
693                                               - type: string
694                                               - type: integer
695                                         additionalProperties: false
696                                         type: object
697                                     additionalProperties: false
698                                     type: object
699                                 additionalProperties: false
700                                 type: object
701                               dlTransmissionBandwidth:
702                                 properties:
703                                   ncnrb:
704                                     oneOf:
705                                       - type: string
706                                       - type: integer
707                                   nrscs:
708                                     oneOf:
709                                       - type: string
710                                       - type: integer
711                                 additionalProperties: false
712                                 type: object
713                               ulFreqInfo:
714                                 properties:
715                                   frequencyBands:
716                                     items:
717                                       properties:
718                                         nrFrequencyBand:
719                                           type: integer
720                                         supportedSulBands:
721                                           items:
722                                             type: integer
723                                           type: array
724                                       additionalProperties: false
725                                       type: object
726                                     type: array
727                                   nrArFcn:
728                                     oneOf:
729                                       - type: integer
730                                   sulInformation:
731                                     properties:
732                                       sulArFcn:
733                                         oneOf:
734                                           - type: integer
735                                       sulTransmissionBandwidth:
736                                         properties:
737                                           ncnrb:
738                                             oneOf:
739                                               - type: string
740                                               - type: integer
741                                           nrscs:
742                                             oneOf:
743                                               - type: string
744                                               - type: integer
745                                         additionalProperties: false
746                                         type: object
747                                     additionalProperties: false
748                                     type: object
749                                 additionalProperties: false
750                                 type: object
751                               ulTransmissionBandwidth:
752                                 properties:
753                                   ncnrb:
754                                     oneOf:
755                                       - type: string
756                                       - type: integer
757                                   nrscs:
758                                     oneOf:
759                                       - type: string
760                                       - type: integer
761                                 additionalProperties: false
762                                 type: object
763                             additionalProperties: false
764                             type: object
765                           tdd:
766                             properties:
767                               nrFreqInfo:
768                                 properties:
769                                   frequencyBands:
770                                     items:
771                                       properties:
772                                         nrFrequencyBand:
773                                           type: integer
774                                         supportedSulBands:
775                                           items:
776                                             type: integer
777                                           type: array
778                                       additionalProperties: false
779                                       type: object
780                                     type: array
781                                   nrArFcn:
782                                     oneOf:
783                                       - type: integer
784                                   sulInformation:
785                                     properties:
786                                       sulArFcn:
787                                         oneOf:
788                                           - type: integer
789                                       sulTransmissionBandwidth:
790                                         properties:
791                                           ncnrb:
792                                             oneOf:
793                                               - type: string
794                                               - type: integer
795                                           nrscs:
796                                             oneOf:
797                                               - type: string
798                                               - type: integer
799                                         additionalProperties: false
800                                         type: object
801                                     additionalProperties: false
802                                     type: object
803                                 additionalProperties: false
804                                 type: object
805                               transmissionBandwidth:
806                                 properties:
807                                   ncnrb:
808                                     oneOf:
809                                       - type: string
810                                       - type: integer
811                                   nrscs:
812                                     oneOf:
813                                       - type: string
814                                       - type: integer
815                                 additionalProperties: false
816                                 type: object
817                             additionalProperties: false
818                             type: object
819                         additionalProperties: false
820                         type: object
821                       configuredStac:
822                         type: string
823                       nrMode:
824                         oneOf:
825                           - type: string
826                           - type: integer
827                       nrPci:
828                         type: integer
829                       servedPlmns:
830                         items:
831                           type: string
832                         type: array
833                       stac5g:
834                         type: string
835                     additionalProperties: false
836                     type: object
837                 additionalProperties: false
838                 type: object
839               type: array
840           additionalProperties: false
841           type: object
842         ip:
843           type: string
844         nodeType:
845           oneOf:
846             - type: string
847             - type: integer
848         port:
849           type: integer
850         ranName:
851           type: string
852         setupFailure:
853           properties:
854             criticalityDiagnostics:
855               properties:
856                 informationElementCriticalityDiagnostics:
857                   items:
858                     properties:
859                       ieCriticality:
860                         oneOf:
861                           - type: string
862                           - type: integer
863                       ieId:
864                         type: integer
865                       typeOfError:
866                         oneOf:
867                           - type: string
868                           - type: integer
869                     additionalProperties: false
870                     type: object
871                   type: array
872                 procedureCode:
873                   type: integer
874                 procedureCriticality:
875                   oneOf:
876                     - type: string
877                     - type: integer
878                 triggeringMessage:
879                   oneOf:
880                     - type: string
881                     - type: integer
882               additionalProperties: false
883               type: object
884             miscellaneousCause:
885               oneOf:
886                 - type: string
887                 - type: integer
888             networkLayerCause:
889               oneOf:
890                 - type: string
891                 - type: integer
892             protocolCause:
893               oneOf:
894                 - type: string
895                 - type: integer
896             timeToWait:
897               oneOf:
898                 - type: string
899                 - type: integer
900             transportLayerCause:
901               oneOf:
902                 - type: string
903                 - type: integer
904           additionalProperties: false
905           type: object
906       additionalProperties: false
907       type: object
908     ErrorResponse:
909       type: object
910       required:
911         - errorCode
912         - errorMessage
913       properties:
914         errorCode:
915           type: string
916           description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
917         errorMessage:
918           type: string
919           description: Human readable text