Extend Mock E2Mgr configuration to save state
[portal/ric-dashboard.git] / e2-mgr-client / src / main / resources / E2M_API_2019-08-15.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-reset/{ranName}:
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 transport:unspecified,
244 radioNetwork:handover-desirable-for-radio-reasons,
245 radioNetwork:time-critical-handover,
246 radioNetwork:resource-optimisation-handover,
247 radioNetwork:reduce-load-in-serving-cell,
248 radioNetwork:partial-handover,
249 radioNetwork:unknown-new-eNB-UE-X2AP-ID,
250 radioNetwork:unknown-old-eNB-UE-X2AP-ID,
251 radioNetwork:unknown-pair-of-UE-X2AP-ID,
252 radioNetwork:ho-target-not-allowed,
253 radioNetwork:tx2relocoverall-expiry,
254 radioNetwork:trelocprep-expiry,
255 radioNetwork:cell-not-available,
256 radioNetwork:no-radio-resources-available-in-target-cell,
257 radioNetwork:invalid-MME-GroupID,
258 radioNetwork:unknown-MME-Code,
259 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
260 radioNetwork:reportCharacteristicsEmpty,
261 radioNetwork:noReportPeriodicity,
262 radioNetwork:existingMeasurementID,
263 radioNetwork:unknown-eNB-Measurement-ID,
264 radioNetwork:measurement-temporarily-not-available,
265 radioNetwork:unspecified,
266 radioNetwork:load-balancing,
267 radioNetwork:handover-optimisation,
268 radioNetwork:value-out-of-allowed-range,
269 radioNetwork:multiple-E-RAB-ID-instances,
270 radioNetwork:switch-off-ongoing,
271 radioNetwork:not-supported-QCI-value,
272 radioNetwork:measurement-not-supported-for-the-object,
273 radioNetwork:tDCoverall-expiry,
274 radioNetwork:tDCprep-expiry,
275 radioNetwork:action-desirable-for-radio-reasons,
276 radioNetwork:reduce-load,
277 radioNetwork:resource-optimisation,
278 radioNetwork:time-critical-action,
279 radioNetwork:target-not-allowed,
280 radioNetwork:no-radio-resources-available,
281 radioNetwork:invalid-QoS-combination,
282 radioNetwork:encryption-algorithms-not-aupported,
283 radioNetwork:procedure-cancelled,
284 radioNetwork:rRM-purpose,
285 radioNetwork:improve-user-bit-rate,
286 radioNetwork:user-inactivity,
287 radioNetwork:radio-connection-with-UE-lost,
288 radioNetwork:failure-in-the-radio-interface-procedure,
289 radioNetwork:bearer-option-not-supported,
290 radioNetwork:mCG-Mobility,
291 radioNetwork:sCG-Mobility,
292 radioNetwork:count-reaches-max-value,
293 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
294 radioNetwork:pDCP-Overload]
295     NodebIdentity:
296       properties:
297         globalNbId:
298           properties:
299             nbId:
300               type: string
301             plmnId:
302               type: string
303           type: object
304         inventoryName:
305           type: string
306       type: object
307     GetNodebResponse:
308       properties:
309         connectionStatus:
310           oneOf:
311             - type: string
312             - type: integer
313         enb:
314           properties:
315             enbType:
316               oneOf:
317                 - type: string
318                 - type: integer
319             guGroupIds:
320               items:
321                 type: string
322               type: array
323             servedCells:
324               items:
325                 properties:
326                   bandwidthReducedSi:
327                     oneOf:
328                       - type: string
329                       - type: integer
330                   broadcastPlmns:
331                     items:
332                       type: string
333                     type: array
334                   cellId:
335                     type: string
336                   choiceEutraMode:
337                     properties:
338                       fdd:
339                         properties:
340                           dlTransmissionBandwidth:
341                             oneOf:
342                               - type: string
343                               - type: integer
344                           dlearFcn:
345                             type: integer
346                           ulTransmissionBandwidth:
347                             oneOf:
348                               - type: string
349                               - type: integer
350                           ulearFcn:
351                             type: integer
352                         additionalProperties: false
353                         type: object
354                       tdd:
355                         properties:
356                           additionalSpecialSubframeExtensionInfo:
357                             properties:
358                               additionalSpecialSubframePatternsExtension:
359                                 oneOf:
360                                   - type: string
361                                   - type: integer
362                               cyclicPrefixDl:
363                                 oneOf:
364                                   - type: string
365                                   - type: integer
366                               cyclicPrefixUl:
367                                 oneOf:
368                                   - type: string
369                                   - type: integer
370                             additionalProperties: false
371                             type: object
372                           additionalSpecialSubframeInfo:
373                             properties:
374                               additionalSpecialSubframePatterns:
375                                 oneOf:
376                                   - type: string
377                                   - type: integer
378                               cyclicPrefixDl:
379                                 oneOf:
380                                   - type: string
381                                   - type: integer
382                               cyclicPrefixUl:
383                                 oneOf:
384                                   - type: string
385                                   - type: integer
386                             additionalProperties: false
387                             type: object
388                           earFcn:
389                             type: integer
390                           specialSubframeInfo:
391                             properties:
392                               cyclicPrefixDl:
393                                 oneOf:
394                                   - type: string
395                                   - type: integer
396                               cyclicPrefixUl:
397                                 oneOf:
398                                   - type: string
399                                   - type: integer
400                               specialSubframePatterns:
401                                 oneOf:
402                                   - type: string
403                                   - type: integer
404                             additionalProperties: false
405                             type: object
406                           subframeAssignment:
407                             oneOf:
408                               - type: string
409                               - type: integer
410                           transmissionBandwidth:
411                             oneOf:
412                               - type: string
413                               - type: integer
414                         additionalProperties: false
415                         type: object
416                     additionalProperties: false
417                     type: object
418                   csgId:
419                     type: string
420                   eutraMode:
421                     oneOf:
422                       - type: string
423                       - type: integer
424                   freqBandIndicatorPriority:
425                     oneOf:
426                       - type: string
427                       - type: integer
428                   mbmsServiceAreaIdentities:
429                     items:
430                       type: string
431                     type: array
432                   mbsfnSubframeInfos:
433                     items:
434                       properties:
435                         radioframeAllocationOffset:
436                           type: integer
437                         radioframeAllocationPeriod:
438                           oneOf:
439                             - type: string
440                             - type: integer
441                         subframeAllocation:
442                           type: string
443                         subframeAllocationType:
444                           oneOf:
445                             - type: string
446                             - type: integer
447                       additionalProperties: false
448                       type: object
449                     type: array
450                   multibandInfos:
451                     items:
452                       type: integer
453                     type: array
454                   neighbourInfos:
455                     items:
456                       properties:
457                         earFcn:
458                           type: integer
459                         ecgi:
460                           type: string
461                         pci:
462                           type: integer
463                         tac:
464                           type: string
465                       additionalProperties: false
466                       type: object
467                     type: array
468                   numberOfAntennaPorts:
469                     oneOf:
470                       - type: string
471                       - type: integer
472                   pci:
473                     type: integer
474                   prachConfiguration:
475                     properties:
476                       highSpeedFlag:
477                         type: boolean
478                       prachConfigurationIndex:
479                         type: integer
480                       prachFrequencyOffset:
481                         type: integer
482                       rootSequenceIndex:
483                         type: integer
484                       zeroCorrelationZoneConfiguration:
485                         type: integer
486                     additionalProperties: false
487                     type: object
488                   tac:
489                     type: string
490                 additionalProperties: false
491                 type: object
492               type: array
493           additionalProperties: false
494           type: object
495         failureType:
496           oneOf:
497             - type: string
498             - type: integer
499         globalNbId:
500           properties:
501             nbId:
502               type: string
503             plmnId:
504               type: string
505           additionalProperties: false
506           type: object
507         gnb:
508           properties:
509             servedNrCells:
510               items:
511                 properties:
512                   nrNeighbourInfos:
513                     items:
514                       properties:
515                         choiceNrMode:
516                           properties:
517                             fdd:
518                               properties:
519                                 dlarFcnFreqInfo:
520                                   properties:
521                                     frequencyBands:
522                                       items:
523                                         properties:
524                                           nrFrequencyBand:
525                                             type: integer
526                                           supportedSulBands:
527                                             items:
528                                               type: integer
529                                             type: array
530                                         additionalProperties: false
531                                         type: object
532                                       type: array
533                                     nrArFcn:
534                                       oneOf:
535                                         - type: integer
536                                     sulInformation:
537                                       properties:
538                                         sulArFcn:
539                                           oneOf:
540                                             - type: integer
541                                         sulTransmissionBandwidth:
542                                           properties:
543                                             ncnrb:
544                                               oneOf:
545                                                 - type: string
546                                                 - type: integer
547                                             nrscs:
548                                               oneOf:
549                                                 - type: string
550                                                 - type: integer
551                                           additionalProperties: false
552                                           type: object
553                                       additionalProperties: false
554                                       type: object
555                                   additionalProperties: false
556                                   type: object
557                                 ularFcnFreqInfo:
558                                   properties:
559                                     frequencyBands:
560                                       items:
561                                         properties:
562                                           nrFrequencyBand:
563                                             type: integer
564                                           supportedSulBands:
565                                             items:
566                                               type: integer
567                                             type: array
568                                         additionalProperties: false
569                                         type: object
570                                       type: array
571                                     nrArFcn:
572                                       oneOf:
573                                         - type: integer
574                                     sulInformation:
575                                       properties:
576                                         sulArFcn:
577                                           oneOf:
578                                             - type: integer
579                                         sulTransmissionBandwidth:
580                                           properties:
581                                             ncnrb:
582                                               oneOf:
583                                                 - type: string
584                                                 - type: integer
585                                             nrscs:
586                                               oneOf:
587                                                 - type: string
588                                                 - type: integer
589                                           additionalProperties: false
590                                           type: object
591                                       additionalProperties: false
592                                       type: object
593                                   additionalProperties: false
594                                   type: object
595                               additionalProperties: false
596                               type: object
597                             tdd:
598                               properties:
599                                 arFcnNrFreqInfo:
600                                   properties:
601                                     frequencyBands:
602                                       items:
603                                         properties:
604                                           nrFrequencyBand:
605                                             type: integer
606                                           supportedSulBands:
607                                             items:
608                                               type: integer
609                                             type: array
610                                         additionalProperties: false
611                                         type: object
612                                       type: array
613                                     nrArFcn:
614                                       oneOf:
615                                         - type: integer
616                                     sulInformation:
617                                       properties:
618                                         sulArFcn:
619                                           oneOf:
620                                             - type: integer
621                                         sulTransmissionBandwidth:
622                                           properties:
623                                             ncnrb:
624                                               oneOf:
625                                                 - type: string
626                                                 - type: integer
627                                             nrscs:
628                                               oneOf:
629                                                 - type: string
630                                                 - type: integer
631                                           additionalProperties: false
632                                           type: object
633                                       additionalProperties: false
634                                       type: object
635                                   additionalProperties: false
636                                   type: object
637                               additionalProperties: false
638                               type: object
639                           additionalProperties: false
640                           type: object
641                         configuredStac:
642                           type: string
643                         nrCgi:
644                           type: string
645                         nrMode:
646                           oneOf:
647                             - type: string
648                             - type: integer
649                         nrPci:
650                           type: integer
651                         stac5g:
652                           type: string
653                       additionalProperties: false
654                       type: object
655                     type: array
656                   servedNrCellInformation:
657                     properties:
658                       cellId:
659                         type: string
660                       choiceNrMode:
661                         properties:
662                           fdd:
663                             properties:
664                               dlFreqInfo:
665                                 properties:
666                                   frequencyBands:
667                                     items:
668                                       properties:
669                                         nrFrequencyBand:
670                                           type: integer
671                                         supportedSulBands:
672                                           items:
673                                             type: integer
674                                           type: array
675                                       additionalProperties: false
676                                       type: object
677                                     type: array
678                                   nrArFcn:
679                                     oneOf:
680                                       - type: integer
681                                   sulInformation:
682                                     properties:
683                                       sulArFcn:
684                                         oneOf:
685                                           - type: integer
686                                       sulTransmissionBandwidth:
687                                         properties:
688                                           ncnrb:
689                                             oneOf:
690                                               - type: string
691                                               - type: integer
692                                           nrscs:
693                                             oneOf:
694                                               - type: string
695                                               - type: integer
696                                         additionalProperties: false
697                                         type: object
698                                     additionalProperties: false
699                                     type: object
700                                 additionalProperties: false
701                                 type: object
702                               dlTransmissionBandwidth:
703                                 properties:
704                                   ncnrb:
705                                     oneOf:
706                                       - type: string
707                                       - type: integer
708                                   nrscs:
709                                     oneOf:
710                                       - type: string
711                                       - type: integer
712                                 additionalProperties: false
713                                 type: object
714                               ulFreqInfo:
715                                 properties:
716                                   frequencyBands:
717                                     items:
718                                       properties:
719                                         nrFrequencyBand:
720                                           type: integer
721                                         supportedSulBands:
722                                           items:
723                                             type: integer
724                                           type: array
725                                       additionalProperties: false
726                                       type: object
727                                     type: array
728                                   nrArFcn:
729                                     oneOf:
730                                       - type: integer
731                                   sulInformation:
732                                     properties:
733                                       sulArFcn:
734                                         oneOf:
735                                           - type: integer
736                                       sulTransmissionBandwidth:
737                                         properties:
738                                           ncnrb:
739                                             oneOf:
740                                               - type: string
741                                               - type: integer
742                                           nrscs:
743                                             oneOf:
744                                               - type: string
745                                               - type: integer
746                                         additionalProperties: false
747                                         type: object
748                                     additionalProperties: false
749                                     type: object
750                                 additionalProperties: false
751                                 type: object
752                               ulTransmissionBandwidth:
753                                 properties:
754                                   ncnrb:
755                                     oneOf:
756                                       - type: string
757                                       - type: integer
758                                   nrscs:
759                                     oneOf:
760                                       - type: string
761                                       - type: integer
762                                 additionalProperties: false
763                                 type: object
764                             additionalProperties: false
765                             type: object
766                           tdd:
767                             properties:
768                               nrFreqInfo:
769                                 properties:
770                                   frequencyBands:
771                                     items:
772                                       properties:
773                                         nrFrequencyBand:
774                                           type: integer
775                                         supportedSulBands:
776                                           items:
777                                             type: integer
778                                           type: array
779                                       additionalProperties: false
780                                       type: object
781                                     type: array
782                                   nrArFcn:
783                                     oneOf:
784                                       - type: integer
785                                   sulInformation:
786                                     properties:
787                                       sulArFcn:
788                                         oneOf:
789                                           - type: integer
790                                       sulTransmissionBandwidth:
791                                         properties:
792                                           ncnrb:
793                                             oneOf:
794                                               - type: string
795                                               - type: integer
796                                           nrscs:
797                                             oneOf:
798                                               - type: string
799                                               - type: integer
800                                         additionalProperties: false
801                                         type: object
802                                     additionalProperties: false
803                                     type: object
804                                 additionalProperties: false
805                                 type: object
806                               transmissionBandwidth:
807                                 properties:
808                                   ncnrb:
809                                     oneOf:
810                                       - type: string
811                                       - type: integer
812                                   nrscs:
813                                     oneOf:
814                                       - type: string
815                                       - type: integer
816                                 additionalProperties: false
817                                 type: object
818                             additionalProperties: false
819                             type: object
820                         additionalProperties: false
821                         type: object
822                       configuredStac:
823                         type: string
824                       nrMode:
825                         oneOf:
826                           - type: string
827                           - type: integer
828                       nrPci:
829                         type: integer
830                       servedPlmns:
831                         items:
832                           type: string
833                         type: array
834                       stac5g:
835                         type: string
836                     additionalProperties: false
837                     type: object
838                 additionalProperties: false
839                 type: object
840               type: array
841           additionalProperties: false
842           type: object
843         ip:
844           type: string
845         nodeType:
846           oneOf:
847             - type: string
848             - type: integer
849         port:
850           type: integer
851         ranName:
852           type: string
853         setupFailure:
854           properties:
855             criticalityDiagnostics:
856               properties:
857                 informationElementCriticalityDiagnostics:
858                   items:
859                     properties:
860                       ieCriticality:
861                         oneOf:
862                           - type: string
863                           - type: integer
864                       ieId:
865                         type: integer
866                       typeOfError:
867                         oneOf:
868                           - type: string
869                           - type: integer
870                     additionalProperties: false
871                     type: object
872                   type: array
873                 procedureCode:
874                   type: integer
875                 procedureCriticality:
876                   oneOf:
877                     - type: string
878                     - type: integer
879                 triggeringMessage:
880                   oneOf:
881                     - type: string
882                     - type: integer
883               additionalProperties: false
884               type: object
885             miscellaneousCause:
886               oneOf:
887                 - type: string
888                 - type: integer
889             networkLayerCause:
890               oneOf:
891                 - type: string
892                 - type: integer
893             protocolCause:
894               oneOf:
895                 - type: string
896                 - type: integer
897             timeToWait:
898               oneOf:
899                 - type: string
900                 - type: integer
901             transportLayerCause:
902               oneOf:
903                 - type: string
904                 - type: integer
905           additionalProperties: false
906           type: object
907       additionalProperties: false
908       type: object
909     ErrorResponse:
910       type: object
911       required:
912         - errorCode
913         - errorMessage
914       properties:
915         errorCode:
916           type: string
917           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'
918         errorMessage:
919           type: string
920           description: Human readable text