Merge "[RICPLT-209] - automation refactory setup"
[ric-plt/e2mgr.git] / Swagger / E2Manager_API.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
19 # This source code is part of the near-RT RIC (RAN Intelligent Controller)
20 # platform project (RICP).
21
22
23 openapi: 3.0.0
24 info:
25   title: E2 Manager Service
26   description: E2 Manager Service APIs
27   version: 4.0.0
28 servers:
29   - url: 'http://{apiRoot}/v1'
30     variables:
31       apiRoot:
32         default: 'localhost:3800'
33 paths:
34   '/nodeb/{ranName}':
35     put:
36       summary: Update GNB
37       tags:
38         - nodeb
39       operationId: UpdateGnb
40       parameters:
41         - name: ranName
42           in: path
43           required: true
44           description: Name of GNB RAN to update
45           schema:
46             type: string
47       requestBody:
48         content:
49           application/json:
50             schema:
51               $ref: '#/components/schemas/UpdateGnbRequest'
52         required: true
53       responses:
54         '200':
55           description: Successful operation
56           content:
57             application/json:
58               schema:
59                 $ref: '#/components/schemas/UpdateGnbResponse'
60         '400':
61           description: Invalid input
62           content:
63             application/problem+json:
64               schema:
65                 $ref: '#/components/schemas/ErrorResponse'
66         '500':
67           description: Internal error
68           content:
69             application/problem+json:
70               schema:
71                 $ref: '#/components/schemas/ErrorResponse'
72         '503':
73           description: Routing Manager Unavailable
74           content:
75             application/problem+json:
76               schema:
77                 $ref: '#/components/schemas/ErrorResponse'
78     get:
79       tags:
80         - nodeb
81       summary: Get RAN by name
82       operationId: getNb
83       parameters:
84         - name: ranName
85           in: path
86           required: true
87           description: Name of RAN to return
88           schema:
89             type: string
90       responses:
91         '200':
92           description: Successful operation
93           content:
94             application/json:
95               schema:
96                 $ref: '#/components/schemas/GetNodebResponse'
97         '400':
98           description: The specified RAN name is invalid
99           content:
100             application/json:
101               schema:
102                 $ref: '#/components/schemas/ErrorResponse'
103         '404':
104           description: A RAN with the specified name was not found
105           content:
106             application/problem+json:
107               schema:
108                 $ref: '#/components/schemas/ErrorResponse'
109         '500':
110           description: Internal Error
111           content:
112             application/problem+json:
113               schema:
114                 $ref: '#/components/schemas/ErrorResponse'
115   /nodeb/shutdown:
116     put:
117       tags:
118         - nodeb
119       summary: Close all connections to the RANs
120       responses:
121         '200':
122           description: 'Operation succeeded internally, outbound calls failed'
123           content:
124             application/json:
125               schema:
126                 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
127         '204':
128           description: Successful operation
129         '500':
130           description: Internal Error
131           content:
132             application/problem+json:
133               schema:
134                 $ref: '#/components/schemas/ErrorResponse'
135   /nodeb/ids:
136     get:
137       tags:
138         - nodeb
139       summary: Get RANs identities list
140       operationId: getNodebIdList
141       responses:
142         '200':
143           description: Successful operation
144           content:
145             application/json:
146               schema:
147                 type: array
148                 items:
149                   $ref: '#/components/schemas/NodebIdentity'
150         '500':
151           description: Internal Error
152           content:
153             application/problem+json:
154               schema:
155                 $ref: '#/components/schemas/ErrorResponse'
156   /health:
157     get:
158       tags:
159         - Health Check
160       summary: E2 Manager Service Health Check
161       responses:
162         '200':
163           description: OK
164   /e2t/list:
165     get:
166       tags:
167         - e2t
168       summary: Gets a list of all E2T Instances address and their associated RANs
169       responses:
170         '200':
171           description: Successful operation
172           content:
173             application/json:
174               schema:
175                 type: array
176                 items:
177                   $ref: '#/components/schemas/E2tIdentity'
178         '500':
179           description: Internal Error
180           content:
181             application/problem+json:
182               schema:
183                 $ref: '#/components/schemas/ErrorResponse'
184 components:
185   schemas:
186     UpdateGnbRequest:
187       type: object
188       properties:
189         gnb:
190           properties:
191             servedNrCells:
192               items:
193                 properties:
194                   nrNeighbourInfos:
195                     items:
196                       properties:
197                         choiceNrMode:
198                           properties:
199                             fdd:
200                               properties:
201                                 dlarFcnFreqInfo:
202                                   properties:
203                                     frequencyBands:
204                                       items:
205                                         properties:
206                                           nrFrequencyBand:
207                                             type: integer
208                                           supportedSulBands:
209                                             items:
210                                               type: integer
211                                             type: array
212                                         additionalProperties: false
213                                         type: object
214                                       type: array
215                                     nrArFcn:
216                                       oneOf:
217                                         - type: integer
218                                     sulInformation:
219                                       properties:
220                                         sulArFcn:
221                                           oneOf:
222                                             - type: integer
223                                         sulTransmissionBandwidth:
224                                           properties:
225                                             ncnrb:
226                                               oneOf:
227                                                 - type: string
228                                                 - type: integer
229                                             nrscs:
230                                               oneOf:
231                                                 - type: string
232                                                 - type: integer
233                                           additionalProperties: false
234                                           type: object
235                                       additionalProperties: false
236                                       type: object
237                                   additionalProperties: false
238                                   type: object
239                                 ularFcnFreqInfo:
240                                   properties:
241                                     frequencyBands:
242                                       items:
243                                         properties:
244                                           nrFrequencyBand:
245                                             type: integer
246                                           supportedSulBands:
247                                             items:
248                                               type: integer
249                                             type: array
250                                         additionalProperties: false
251                                         type: object
252                                       type: array
253                                     nrArFcn:
254                                       oneOf:
255                                         - type: integer
256                                     sulInformation:
257                                       properties:
258                                         sulArFcn:
259                                           oneOf:
260                                             - type: integer
261                                         sulTransmissionBandwidth:
262                                           properties:
263                                             ncnrb:
264                                               oneOf:
265                                                 - type: string
266                                                 - type: integer
267                                             nrscs:
268                                               oneOf:
269                                                 - type: string
270                                                 - type: integer
271                                           additionalProperties: false
272                                           type: object
273                                       additionalProperties: false
274                                       type: object
275                                   additionalProperties: false
276                                   type: object
277                               additionalProperties: false
278                               type: object
279                             tdd:
280                               properties:
281                                 arFcnNrFreqInfo:
282                                   properties:
283                                     frequencyBands:
284                                       items:
285                                         properties:
286                                           nrFrequencyBand:
287                                             type: integer
288                                           supportedSulBands:
289                                             items:
290                                               type: integer
291                                             type: array
292                                         additionalProperties: false
293                                         type: object
294                                       type: array
295                                     nrArFcn:
296                                       oneOf:
297                                         - type: integer
298                                     sulInformation:
299                                       properties:
300                                         sulArFcn:
301                                           oneOf:
302                                             - type: integer
303                                         sulTransmissionBandwidth:
304                                           properties:
305                                             ncnrb:
306                                               oneOf:
307                                                 - type: string
308                                                 - type: integer
309                                             nrscs:
310                                               oneOf:
311                                                 - type: string
312                                                 - type: integer
313                                           additionalProperties: false
314                                           type: object
315                                       additionalProperties: false
316                                       type: object
317                                   additionalProperties: false
318                                   type: object
319                               additionalProperties: false
320                               type: object
321                           additionalProperties: false
322                           type: object
323                         configuredStac:
324                           type: string
325                         nrCgi:
326                           type: string
327                         nrMode:
328                           oneOf:
329                             - type: string
330                             - type: integer
331                         nrPci:
332                           type: integer
333                         stac5g:
334                           type: string
335                       additionalProperties: false
336                       type: object
337                     type: array
338                   servedNrCellInformation:
339                     properties:
340                       cellId:
341                         type: string
342                       choiceNrMode:
343                         properties:
344                           fdd:
345                             properties:
346                               dlFreqInfo:
347                                 properties:
348                                   frequencyBands:
349                                     items:
350                                       properties:
351                                         nrFrequencyBand:
352                                           type: integer
353                                         supportedSulBands:
354                                           items:
355                                             type: integer
356                                           type: array
357                                       additionalProperties: false
358                                       type: object
359                                     type: array
360                                   nrArFcn:
361                                     oneOf:
362                                       - type: integer
363                                   sulInformation:
364                                     properties:
365                                       sulArFcn:
366                                         oneOf:
367                                           - type: integer
368                                       sulTransmissionBandwidth:
369                                         properties:
370                                           ncnrb:
371                                             oneOf:
372                                               - type: string
373                                               - type: integer
374                                           nrscs:
375                                             oneOf:
376                                               - type: string
377                                               - type: integer
378                                         additionalProperties: false
379                                         type: object
380                                     additionalProperties: false
381                                     type: object
382                                 additionalProperties: false
383                                 type: object
384                               dlTransmissionBandwidth:
385                                 properties:
386                                   ncnrb:
387                                     oneOf:
388                                       - type: string
389                                       - type: integer
390                                   nrscs:
391                                     oneOf:
392                                       - type: string
393                                       - type: integer
394                                 additionalProperties: false
395                                 type: object
396                               ulFreqInfo:
397                                 properties:
398                                   frequencyBands:
399                                     items:
400                                       properties:
401                                         nrFrequencyBand:
402                                           type: integer
403                                         supportedSulBands:
404                                           items:
405                                             type: integer
406                                           type: array
407                                       additionalProperties: false
408                                       type: object
409                                     type: array
410                                   nrArFcn:
411                                     oneOf:
412                                       - type: integer
413                                   sulInformation:
414                                     properties:
415                                       sulArFcn:
416                                         oneOf:
417                                           - type: integer
418                                       sulTransmissionBandwidth:
419                                         properties:
420                                           ncnrb:
421                                             oneOf:
422                                               - type: string
423                                               - type: integer
424                                           nrscs:
425                                             oneOf:
426                                               - type: string
427                                               - type: integer
428                                         additionalProperties: false
429                                         type: object
430                                     additionalProperties: false
431                                     type: object
432                                 additionalProperties: false
433                                 type: object
434                               ulTransmissionBandwidth:
435                                 properties:
436                                   ncnrb:
437                                     oneOf:
438                                       - type: string
439                                       - type: integer
440                                   nrscs:
441                                     oneOf:
442                                       - type: string
443                                       - type: integer
444                                 additionalProperties: false
445                                 type: object
446                             additionalProperties: false
447                             type: object
448                           tdd:
449                             properties:
450                               nrFreqInfo:
451                                 properties:
452                                   frequencyBands:
453                                     items:
454                                       properties:
455                                         nrFrequencyBand:
456                                           type: integer
457                                         supportedSulBands:
458                                           items:
459                                             type: integer
460                                           type: array
461                                       additionalProperties: false
462                                       type: object
463                                     type: array
464                                   nrArFcn:
465                                     oneOf:
466                                       - type: integer
467                                   sulInformation:
468                                     properties:
469                                       sulArFcn:
470                                         oneOf:
471                                           - type: integer
472                                       sulTransmissionBandwidth:
473                                         properties:
474                                           ncnrb:
475                                             oneOf:
476                                               - type: string
477                                               - type: integer
478                                           nrscs:
479                                             oneOf:
480                                               - type: string
481                                               - type: integer
482                                         additionalProperties: false
483                                         type: object
484                                     additionalProperties: false
485                                     type: object
486                                 additionalProperties: false
487                                 type: object
488                               transmissionBandwidth:
489                                 properties:
490                                   ncnrb:
491                                     oneOf:
492                                       - type: string
493                                       - type: integer
494                                   nrscs:
495                                     oneOf:
496                                       - type: string
497                                       - type: integer
498                                 additionalProperties: false
499                                 type: object
500                             additionalProperties: false
501                             type: object
502                         additionalProperties: false
503                         type: object
504                       configuredStac:
505                         type: string
506                       nrMode:
507                         oneOf:
508                           - type: string
509                           - type: integer
510                       nrPci:
511                         type: integer
512                       servedPlmns:
513                         items:
514                           type: string
515                         type: array
516                       stac5g:
517                         type: string
518                     additionalProperties: false
519                     type: object
520                 additionalProperties: false
521                 type: object
522               type: array
523             ranFunctions:
524               items:
525                 properties:
526                   ranFunctionId:
527                     type: integer
528                   ranFunctionDefinition:
529                     type: string
530                   ranFunctionRevision:
531                     type: integer
532                 additionalProperties: false
533                 type: object
534               type: array
535           additionalProperties: false
536           type: object
537       additionalProperties: false
538     UpdateGnbResponse:
539       properties:
540         connectionStatus:
541           oneOf:
542             - type: string
543             - type: integer
544         failureType:
545           oneOf:
546             - type: string
547             - type: integer
548         globalNbId:
549           properties:
550             nbId:
551               type: string
552             plmnId:
553               type: string
554           additionalProperties: false
555           type: object
556         gnb:
557           properties:
558             servedNrCells:
559               items:
560                 properties:
561                   nrNeighbourInfos:
562                     items:
563                       properties:
564                         choiceNrMode:
565                           properties:
566                             fdd:
567                               properties:
568                                 dlarFcnFreqInfo:
569                                   properties:
570                                     frequencyBands:
571                                       items:
572                                         properties:
573                                           nrFrequencyBand:
574                                             type: integer
575                                           supportedSulBands:
576                                             items:
577                                               type: integer
578                                             type: array
579                                         additionalProperties: false
580                                         type: object
581                                       type: array
582                                     nrArFcn:
583                                       oneOf:
584                                         - type: integer
585                                     sulInformation:
586                                       properties:
587                                         sulArFcn:
588                                           oneOf:
589                                             - type: integer
590                                         sulTransmissionBandwidth:
591                                           properties:
592                                             ncnrb:
593                                               oneOf:
594                                                 - type: string
595                                                 - type: integer
596                                             nrscs:
597                                               oneOf:
598                                                 - type: string
599                                                 - type: integer
600                                           additionalProperties: false
601                                           type: object
602                                       additionalProperties: false
603                                       type: object
604                                   additionalProperties: false
605                                   type: object
606                                 ularFcnFreqInfo:
607                                   properties:
608                                     frequencyBands:
609                                       items:
610                                         properties:
611                                           nrFrequencyBand:
612                                             type: integer
613                                           supportedSulBands:
614                                             items:
615                                               type: integer
616                                             type: array
617                                         additionalProperties: false
618                                         type: object
619                                       type: array
620                                     nrArFcn:
621                                       oneOf:
622                                         - type: integer
623                                     sulInformation:
624                                       properties:
625                                         sulArFcn:
626                                           oneOf:
627                                             - type: integer
628                                         sulTransmissionBandwidth:
629                                           properties:
630                                             ncnrb:
631                                               oneOf:
632                                                 - type: string
633                                                 - type: integer
634                                             nrscs:
635                                               oneOf:
636                                                 - type: string
637                                                 - type: integer
638                                           additionalProperties: false
639                                           type: object
640                                       additionalProperties: false
641                                       type: object
642                                   additionalProperties: false
643                                   type: object
644                               additionalProperties: false
645                               type: object
646                             tdd:
647                               properties:
648                                 arFcnNrFreqInfo:
649                                   properties:
650                                     frequencyBands:
651                                       items:
652                                         properties:
653                                           nrFrequencyBand:
654                                             type: integer
655                                           supportedSulBands:
656                                             items:
657                                               type: integer
658                                             type: array
659                                         additionalProperties: false
660                                         type: object
661                                       type: array
662                                     nrArFcn:
663                                       oneOf:
664                                         - type: integer
665                                     sulInformation:
666                                       properties:
667                                         sulArFcn:
668                                           oneOf:
669                                             - type: integer
670                                         sulTransmissionBandwidth:
671                                           properties:
672                                             ncnrb:
673                                               oneOf:
674                                                 - type: string
675                                                 - type: integer
676                                             nrscs:
677                                               oneOf:
678                                                 - type: string
679                                                 - type: integer
680                                           additionalProperties: false
681                                           type: object
682                                       additionalProperties: false
683                                       type: object
684                                   additionalProperties: false
685                                   type: object
686                               additionalProperties: false
687                               type: object
688                           additionalProperties: false
689                           type: object
690                         configuredStac:
691                           type: string
692                         nrCgi:
693                           type: string
694                         nrMode:
695                           oneOf:
696                             - type: string
697                             - type: integer
698                         nrPci:
699                           type: integer
700                         stac5g:
701                           type: string
702                       additionalProperties: false
703                       type: object
704                     type: array
705                   servedNrCellInformation:
706                     properties:
707                       cellId:
708                         type: string
709                       choiceNrMode:
710                         properties:
711                           fdd:
712                             properties:
713                               dlFreqInfo:
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                               dlTransmissionBandwidth:
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                               ulFreqInfo:
764                                 properties:
765                                   frequencyBands:
766                                     items:
767                                       properties:
768                                         nrFrequencyBand:
769                                           type: integer
770                                         supportedSulBands:
771                                           items:
772                                             type: integer
773                                           type: array
774                                       additionalProperties: false
775                                       type: object
776                                     type: array
777                                   nrArFcn:
778                                     oneOf:
779                                       - type: integer
780                                   sulInformation:
781                                     properties:
782                                       sulArFcn:
783                                         oneOf:
784                                           - type: integer
785                                       sulTransmissionBandwidth:
786                                         properties:
787                                           ncnrb:
788                                             oneOf:
789                                               - type: string
790                                               - type: integer
791                                           nrscs:
792                                             oneOf:
793                                               - type: string
794                                               - type: integer
795                                         additionalProperties: false
796                                         type: object
797                                     additionalProperties: false
798                                     type: object
799                                 additionalProperties: false
800                                 type: object
801                               ulTransmissionBandwidth:
802                                 properties:
803                                   ncnrb:
804                                     oneOf:
805                                       - type: string
806                                       - type: integer
807                                   nrscs:
808                                     oneOf:
809                                       - type: string
810                                       - type: integer
811                                 additionalProperties: false
812                                 type: object
813                             additionalProperties: false
814                             type: object
815                           tdd:
816                             properties:
817                               nrFreqInfo:
818                                 properties:
819                                   frequencyBands:
820                                     items:
821                                       properties:
822                                         nrFrequencyBand:
823                                           type: integer
824                                         supportedSulBands:
825                                           items:
826                                             type: integer
827                                           type: array
828                                       additionalProperties: false
829                                       type: object
830                                     type: array
831                                   nrArFcn:
832                                     oneOf:
833                                       - type: integer
834                                   sulInformation:
835                                     properties:
836                                       sulArFcn:
837                                         oneOf:
838                                           - type: integer
839                                       sulTransmissionBandwidth:
840                                         properties:
841                                           ncnrb:
842                                             oneOf:
843                                               - type: string
844                                               - type: integer
845                                           nrscs:
846                                             oneOf:
847                                               - type: string
848                                               - type: integer
849                                         additionalProperties: false
850                                         type: object
851                                     additionalProperties: false
852                                     type: object
853                                 additionalProperties: false
854                                 type: object
855                               transmissionBandwidth:
856                                 properties:
857                                   ncnrb:
858                                     oneOf:
859                                       - type: string
860                                       - type: integer
861                                   nrscs:
862                                     oneOf:
863                                       - type: string
864                                       - type: integer
865                                 additionalProperties: false
866                                 type: object
867                             additionalProperties: false
868                             type: object
869                         additionalProperties: false
870                         type: object
871                       configuredStac:
872                         type: string
873                       nrMode:
874                         oneOf:
875                           - type: string
876                           - type: integer
877                       nrPci:
878                         type: integer
879                       servedPlmns:
880                         items:
881                           type: string
882                         type: array
883                       stac5g:
884                         type: string
885                     additionalProperties: false
886                     type: object
887                 additionalProperties: false
888                 type: object
889               type: array
890             ranFunctions:
891               items:
892                 properties:
893                   ranFunctionId:
894                     type: integer
895                   ranFunctionDefinition:
896                     type: string
897                   ranFunctionRevision:
898                     type: integer
899                 additionalProperties: false
900                 type: object
901               type: array
902           additionalProperties: false
903           type: object
904         ip:
905           type: string
906         nodeType:
907           oneOf:
908             - type: string
909             - type: integer
910         port:
911           type: integer
912         ranName:
913           type: string
914         setupFailure:
915           properties:
916             criticalityDiagnostics:
917               properties:
918                 informationElementCriticalityDiagnostics:
919                   items:
920                     properties:
921                       ieCriticality:
922                         oneOf:
923                           - type: string
924                           - type: integer
925                       ieId:
926                         type: integer
927                       typeOfError:
928                         oneOf:
929                           - type: string
930                           - type: integer
931                     additionalProperties: false
932                     type: object
933                   type: array
934                 procedureCode:
935                   type: integer
936                 procedureCriticality:
937                   oneOf:
938                     - type: string
939                     - type: integer
940                 triggeringMessage:
941                   oneOf:
942                     - type: string
943                     - type: integer
944               additionalProperties: false
945               type: object
946             miscellaneousCause:
947               oneOf:
948                 - type: string
949                 - type: integer
950             networkLayerCause:
951               oneOf:
952                 - type: string
953                 - type: integer
954             protocolCause:
955               oneOf:
956                 - type: string
957                 - type: integer
958             timeToWait:
959               oneOf:
960                 - type: string
961                 - type: integer
962             transportLayerCause:
963               oneOf:
964                 - type: string
965                 - type: integer
966           additionalProperties: false
967           type: object
968       additionalProperties: false
969       type: object
970     NodebIdentity:
971       properties:
972         globalNbId:
973           properties:
974             nbId:
975               type: string
976             plmnId:
977               type: string
978           type: object
979         inventoryName:
980           type: string
981       type: object
982     GetNodebResponse:
983       properties:
984         connectionStatus:
985           oneOf:
986             - type: string
987             - type: integer
988         enb:
989           properties:
990             enbType:
991               oneOf:
992                 - type: string
993                 - type: integer
994             guGroupIds:
995               items:
996                 type: string
997               type: array
998             servedCells:
999               items:
1000                 properties:
1001                   bandwidthReducedSi:
1002                     oneOf:
1003                       - type: string
1004                       - type: integer
1005                   broadcastPlmns:
1006                     items:
1007                       type: string
1008                     type: array
1009                   cellId:
1010                     type: string
1011                   choiceEutraMode:
1012                     properties:
1013                       fdd:
1014                         properties:
1015                           dlTransmissionBandwidth:
1016                             oneOf:
1017                               - type: string
1018                               - type: integer
1019                           dlearFcn:
1020                             type: integer
1021                           ulTransmissionBandwidth:
1022                             oneOf:
1023                               - type: string
1024                               - type: integer
1025                           ulearFcn:
1026                             type: integer
1027                         additionalProperties: false
1028                         type: object
1029                       tdd:
1030                         properties:
1031                           additionalSpecialSubframeExtensionInfo:
1032                             properties:
1033                               additionalSpecialSubframePatternsExtension:
1034                                 oneOf:
1035                                   - type: string
1036                                   - type: integer
1037                               cyclicPrefixDl:
1038                                 oneOf:
1039                                   - type: string
1040                                   - type: integer
1041                               cyclicPrefixUl:
1042                                 oneOf:
1043                                   - type: string
1044                                   - type: integer
1045                             additionalProperties: false
1046                             type: object
1047                           additionalSpecialSubframeInfo:
1048                             properties:
1049                               additionalSpecialSubframePatterns:
1050                                 oneOf:
1051                                   - type: string
1052                                   - type: integer
1053                               cyclicPrefixDl:
1054                                 oneOf:
1055                                   - type: string
1056                                   - type: integer
1057                               cyclicPrefixUl:
1058                                 oneOf:
1059                                   - type: string
1060                                   - type: integer
1061                             additionalProperties: false
1062                             type: object
1063                           earFcn:
1064                             type: integer
1065                           specialSubframeInfo:
1066                             properties:
1067                               cyclicPrefixDl:
1068                                 oneOf:
1069                                   - type: string
1070                                   - type: integer
1071                               cyclicPrefixUl:
1072                                 oneOf:
1073                                   - type: string
1074                                   - type: integer
1075                               specialSubframePatterns:
1076                                 oneOf:
1077                                   - type: string
1078                                   - type: integer
1079                             additionalProperties: false
1080                             type: object
1081                           subframeAssignment:
1082                             oneOf:
1083                               - type: string
1084                               - type: integer
1085                           transmissionBandwidth:
1086                             oneOf:
1087                               - type: string
1088                               - type: integer
1089                         additionalProperties: false
1090                         type: object
1091                     additionalProperties: false
1092                     type: object
1093                   csgId:
1094                     type: string
1095                   eutraMode:
1096                     oneOf:
1097                       - type: string
1098                       - type: integer
1099                   freqBandIndicatorPriority:
1100                     oneOf:
1101                       - type: string
1102                       - type: integer
1103                   mbmsServiceAreaIdentities:
1104                     items:
1105                       type: string
1106                     type: array
1107                   mbsfnSubframeInfos:
1108                     items:
1109                       properties:
1110                         radioframeAllocationOffset:
1111                           type: integer
1112                         radioframeAllocationPeriod:
1113                           oneOf:
1114                             - type: string
1115                             - type: integer
1116                         subframeAllocation:
1117                           type: string
1118                         subframeAllocationType:
1119                           oneOf:
1120                             - type: string
1121                             - type: integer
1122                       additionalProperties: false
1123                       type: object
1124                     type: array
1125                   multibandInfos:
1126                     items:
1127                       type: integer
1128                     type: array
1129                   neighbourInfos:
1130                     items:
1131                       properties:
1132                         earFcn:
1133                           type: integer
1134                         ecgi:
1135                           type: string
1136                         pci:
1137                           type: integer
1138                         tac:
1139                           type: string
1140                       additionalProperties: false
1141                       type: object
1142                     type: array
1143                   numberOfAntennaPorts:
1144                     oneOf:
1145                       - type: string
1146                       - type: integer
1147                   pci:
1148                     type: integer
1149                   prachConfiguration:
1150                     properties:
1151                       highSpeedFlag:
1152                         type: boolean
1153                       prachConfigurationIndex:
1154                         type: integer
1155                       prachFrequencyOffset:
1156                         type: integer
1157                       rootSequenceIndex:
1158                         type: integer
1159                       zeroCorrelationZoneConfiguration:
1160                         type: integer
1161                     additionalProperties: false
1162                     type: object
1163                   tac:
1164                     type: string
1165                 additionalProperties: false
1166                 type: object
1167               type: array
1168           additionalProperties: false
1169           type: object
1170         failureType:
1171           oneOf:
1172             - type: string
1173             - type: integer
1174         globalNbId:
1175           properties:
1176             nbId:
1177               type: string
1178             plmnId:
1179               type: string
1180           additionalProperties: false
1181           type: object
1182         gnb:
1183           properties:
1184             servedNrCells:
1185               items:
1186                 properties:
1187                   nrNeighbourInfos:
1188                     items:
1189                       properties:
1190                         choiceNrMode:
1191                           properties:
1192                             fdd:
1193                               properties:
1194                                 dlarFcnFreqInfo:
1195                                   properties:
1196                                     frequencyBands:
1197                                       items:
1198                                         properties:
1199                                           nrFrequencyBand:
1200                                             type: integer
1201                                           supportedSulBands:
1202                                             items:
1203                                               type: integer
1204                                             type: array
1205                                         additionalProperties: false
1206                                         type: object
1207                                       type: array
1208                                     nrArFcn:
1209                                       oneOf:
1210                                         - type: integer
1211                                     sulInformation:
1212                                       properties:
1213                                         sulArFcn:
1214                                           oneOf:
1215                                             - type: integer
1216                                         sulTransmissionBandwidth:
1217                                           properties:
1218                                             ncnrb:
1219                                               oneOf:
1220                                                 - type: string
1221                                                 - type: integer
1222                                             nrscs:
1223                                               oneOf:
1224                                                 - type: string
1225                                                 - type: integer
1226                                           additionalProperties: false
1227                                           type: object
1228                                       additionalProperties: false
1229                                       type: object
1230                                   additionalProperties: false
1231                                   type: object
1232                                 ularFcnFreqInfo:
1233                                   properties:
1234                                     frequencyBands:
1235                                       items:
1236                                         properties:
1237                                           nrFrequencyBand:
1238                                             type: integer
1239                                           supportedSulBands:
1240                                             items:
1241                                               type: integer
1242                                             type: array
1243                                         additionalProperties: false
1244                                         type: object
1245                                       type: array
1246                                     nrArFcn:
1247                                       oneOf:
1248                                         - type: integer
1249                                     sulInformation:
1250                                       properties:
1251                                         sulArFcn:
1252                                           oneOf:
1253                                             - type: integer
1254                                         sulTransmissionBandwidth:
1255                                           properties:
1256                                             ncnrb:
1257                                               oneOf:
1258                                                 - type: string
1259                                                 - type: integer
1260                                             nrscs:
1261                                               oneOf:
1262                                                 - type: string
1263                                                 - type: integer
1264                                           additionalProperties: false
1265                                           type: object
1266                                       additionalProperties: false
1267                                       type: object
1268                                   additionalProperties: false
1269                                   type: object
1270                               additionalProperties: false
1271                               type: object
1272                             tdd:
1273                               properties:
1274                                 arFcnNrFreqInfo:
1275                                   properties:
1276                                     frequencyBands:
1277                                       items:
1278                                         properties:
1279                                           nrFrequencyBand:
1280                                             type: integer
1281                                           supportedSulBands:
1282                                             items:
1283                                               type: integer
1284                                             type: array
1285                                         additionalProperties: false
1286                                         type: object
1287                                       type: array
1288                                     nrArFcn:
1289                                       oneOf:
1290                                         - type: integer
1291                                     sulInformation:
1292                                       properties:
1293                                         sulArFcn:
1294                                           oneOf:
1295                                             - type: integer
1296                                         sulTransmissionBandwidth:
1297                                           properties:
1298                                             ncnrb:
1299                                               oneOf:
1300                                                 - type: string
1301                                                 - type: integer
1302                                             nrscs:
1303                                               oneOf:
1304                                                 - type: string
1305                                                 - type: integer
1306                                           additionalProperties: false
1307                                           type: object
1308                                       additionalProperties: false
1309                                       type: object
1310                                   additionalProperties: false
1311                                   type: object
1312                               additionalProperties: false
1313                               type: object
1314                           additionalProperties: false
1315                           type: object
1316                         configuredStac:
1317                           type: string
1318                         nrCgi:
1319                           type: string
1320                         nrMode:
1321                           oneOf:
1322                             - type: string
1323                             - type: integer
1324                         nrPci:
1325                           type: integer
1326                         stac5g:
1327                           type: string
1328                       additionalProperties: false
1329                       type: object
1330                     type: array
1331                   servedNrCellInformation:
1332                     properties:
1333                       cellId:
1334                         type: string
1335                       choiceNrMode:
1336                         properties:
1337                           fdd:
1338                             properties:
1339                               dlFreqInfo:
1340                                 properties:
1341                                   frequencyBands:
1342                                     items:
1343                                       properties:
1344                                         nrFrequencyBand:
1345                                           type: integer
1346                                         supportedSulBands:
1347                                           items:
1348                                             type: integer
1349                                           type: array
1350                                       additionalProperties: false
1351                                       type: object
1352                                     type: array
1353                                   nrArFcn:
1354                                     oneOf:
1355                                       - type: integer
1356                                   sulInformation:
1357                                     properties:
1358                                       sulArFcn:
1359                                         oneOf:
1360                                           - type: integer
1361                                       sulTransmissionBandwidth:
1362                                         properties:
1363                                           ncnrb:
1364                                             oneOf:
1365                                               - type: string
1366                                               - type: integer
1367                                           nrscs:
1368                                             oneOf:
1369                                               - type: string
1370                                               - type: integer
1371                                         additionalProperties: false
1372                                         type: object
1373                                     additionalProperties: false
1374                                     type: object
1375                                 additionalProperties: false
1376                                 type: object
1377                               dlTransmissionBandwidth:
1378                                 properties:
1379                                   ncnrb:
1380                                     oneOf:
1381                                       - type: string
1382                                       - type: integer
1383                                   nrscs:
1384                                     oneOf:
1385                                       - type: string
1386                                       - type: integer
1387                                 additionalProperties: false
1388                                 type: object
1389                               ulFreqInfo:
1390                                 properties:
1391                                   frequencyBands:
1392                                     items:
1393                                       properties:
1394                                         nrFrequencyBand:
1395                                           type: integer
1396                                         supportedSulBands:
1397                                           items:
1398                                             type: integer
1399                                           type: array
1400                                       additionalProperties: false
1401                                       type: object
1402                                     type: array
1403                                   nrArFcn:
1404                                     oneOf:
1405                                       - type: integer
1406                                   sulInformation:
1407                                     properties:
1408                                       sulArFcn:
1409                                         oneOf:
1410                                           - type: integer
1411                                       sulTransmissionBandwidth:
1412                                         properties:
1413                                           ncnrb:
1414                                             oneOf:
1415                                               - type: string
1416                                               - type: integer
1417                                           nrscs:
1418                                             oneOf:
1419                                               - type: string
1420                                               - type: integer
1421                                         additionalProperties: false
1422                                         type: object
1423                                     additionalProperties: false
1424                                     type: object
1425                                 additionalProperties: false
1426                                 type: object
1427                               ulTransmissionBandwidth:
1428                                 properties:
1429                                   ncnrb:
1430                                     oneOf:
1431                                       - type: string
1432                                       - type: integer
1433                                   nrscs:
1434                                     oneOf:
1435                                       - type: string
1436                                       - type: integer
1437                                 additionalProperties: false
1438                                 type: object
1439                             additionalProperties: false
1440                             type: object
1441                           tdd:
1442                             properties:
1443                               nrFreqInfo:
1444                                 properties:
1445                                   frequencyBands:
1446                                     items:
1447                                       properties:
1448                                         nrFrequencyBand:
1449                                           type: integer
1450                                         supportedSulBands:
1451                                           items:
1452                                             type: integer
1453                                           type: array
1454                                       additionalProperties: false
1455                                       type: object
1456                                     type: array
1457                                   nrArFcn:
1458                                     oneOf:
1459                                       - type: integer
1460                                   sulInformation:
1461                                     properties:
1462                                       sulArFcn:
1463                                         oneOf:
1464                                           - type: integer
1465                                       sulTransmissionBandwidth:
1466                                         properties:
1467                                           ncnrb:
1468                                             oneOf:
1469                                               - type: string
1470                                               - type: integer
1471                                           nrscs:
1472                                             oneOf:
1473                                               - type: string
1474                                               - type: integer
1475                                         additionalProperties: false
1476                                         type: object
1477                                     additionalProperties: false
1478                                     type: object
1479                                 additionalProperties: false
1480                                 type: object
1481                               transmissionBandwidth:
1482                                 properties:
1483                                   ncnrb:
1484                                     oneOf:
1485                                       - type: string
1486                                       - type: integer
1487                                   nrscs:
1488                                     oneOf:
1489                                       - type: string
1490                                       - type: integer
1491                                 additionalProperties: false
1492                                 type: object
1493                             additionalProperties: false
1494                             type: object
1495                         additionalProperties: false
1496                         type: object
1497                       configuredStac:
1498                         type: string
1499                       nrMode:
1500                         oneOf:
1501                           - type: string
1502                           - type: integer
1503                       nrPci:
1504                         type: integer
1505                       servedPlmns:
1506                         items:
1507                           type: string
1508                         type: array
1509                       stac5g:
1510                         type: string
1511                     additionalProperties: false
1512                     type: object
1513                 additionalProperties: false
1514                 type: object
1515               type: array
1516             ranFunctions:
1517               items:
1518                 properties:
1519                   ranFunctionId:
1520                     type: integer
1521                   ranFunctionDefinition:
1522                     type: string
1523                   ranFunctionRevision:
1524                     type: integer
1525                 additionalProperties: false
1526                 type: object
1527               type: array
1528           additionalProperties: false
1529           type: object
1530         ip:
1531           type: string
1532         nodeType:
1533           oneOf:
1534             - type: string
1535             - type: integer
1536         port:
1537           type: integer
1538         ranName:
1539           type: string
1540         setupFailure:
1541           properties:
1542             criticalityDiagnostics:
1543               properties:
1544                 informationElementCriticalityDiagnostics:
1545                   items:
1546                     properties:
1547                       ieCriticality:
1548                         oneOf:
1549                           - type: string
1550                           - type: integer
1551                       ieId:
1552                         type: integer
1553                       typeOfError:
1554                         oneOf:
1555                           - type: string
1556                           - type: integer
1557                     additionalProperties: false
1558                     type: object
1559                   type: array
1560                 procedureCode:
1561                   type: integer
1562                 procedureCriticality:
1563                   oneOf:
1564                     - type: string
1565                     - type: integer
1566                 triggeringMessage:
1567                   oneOf:
1568                     - type: string
1569                     - type: integer
1570               additionalProperties: false
1571               type: object
1572             miscellaneousCause:
1573               oneOf:
1574                 - type: string
1575                 - type: integer
1576             networkLayerCause:
1577               oneOf:
1578                 - type: string
1579                 - type: integer
1580             protocolCause:
1581               oneOf:
1582                 - type: string
1583                 - type: integer
1584             timeToWait:
1585               oneOf:
1586                 - type: string
1587                 - type: integer
1588             transportLayerCause:
1589               oneOf:
1590                 - type: string
1591                 - type: integer
1592           additionalProperties: false
1593           type: object
1594       additionalProperties: false
1595       type: object
1596     ErrorResponse:
1597       type: object
1598       required:
1599         - errorCode
1600         - errorMessage
1601       properties:
1602         errorCode:
1603           type: string
1604           description: >-
1605             401 - corrupted json, 402 - validation error, 403 - RAN in wrong
1606             state, 404 - resource not found, 500 - RNIB error, 501 - internal
1607             problem, 502 - RMR error, 503 - Routing Manager Unavailable
1608         errorMessage:
1609           type: string
1610           description: Human readable text
1611     RedButtonPartialSuccessResponseModel:
1612       type: object
1613       required:
1614         - message
1615       properties:
1616         message:
1617           type: string
1618           description: Partial success reason
1619     E2tIdentity:
1620       type: object
1621       required:
1622         - e2tAddress
1623         - ranNames
1624       properties:
1625         e2tAddress:
1626           type: string
1627         ranNames:
1628           items:
1629             type: string
1630           type: array
1631     E2tErrorResponse:
1632       type: object
1633       required:
1634         - errorCode
1635         - errorMessage
1636       properties:
1637         errorCode:
1638           type: string
1639           description: '500 - RNIB error, 501 - internal problem'
1640         errorMessage:
1641           type: string
1642           description: Human readable text