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