1 # ========================LICENSE_START=================================
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
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
10 # http://www.apache.org/licenses/LICENSE-2.0
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===================================
19 # This source code is part of the near-RT RIC (RAN Intelligent Controller)
20 # platform project (RICP).
25 title: E2 Manager Service
26 description: E2 Manager Service APIs
29 - url: 'http://{apiRoot}/v1'
32 default: 'localhost:3800'
39 operationId: UpdateGnb
44 description: Name of GNB RAN to update
51 $ref: '#/components/schemas/UpdateGnbRequest'
55 description: Successful operation
59 $ref: '#/components/schemas/UpdateGnbResponse'
61 description: Invalid input
63 application/problem+json:
65 $ref: '#/components/schemas/ErrorResponse'
67 description: Internal error
69 application/problem+json:
71 $ref: '#/components/schemas/ErrorResponse'
73 description: Routing Manager Unavailable
75 application/problem+json:
77 $ref: '#/components/schemas/ErrorResponse'
81 summary: Get RAN by name
87 description: Name of RAN to return
92 description: Successful operation
96 $ref: '#/components/schemas/GetNodebResponse'
98 description: The specified RAN name is invalid
102 $ref: '#/components/schemas/ErrorResponse'
104 description: A RAN with the specified name was not found
106 application/problem+json:
108 $ref: '#/components/schemas/ErrorResponse'
110 description: Internal Error
112 application/problem+json:
114 $ref: '#/components/schemas/ErrorResponse'
119 summary: Close all connections to the RANs
122 description: 'Operation succeeded internally, outbound calls failed'
126 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
128 description: Successful operation
130 description: Internal Error
132 application/problem+json:
134 $ref: '#/components/schemas/ErrorResponse'
139 summary: Get RANs identities list
140 operationId: getNodebIdList
143 description: Successful operation
149 $ref: '#/components/schemas/NodebIdentity'
151 description: Internal Error
153 application/problem+json:
155 $ref: '#/components/schemas/ErrorResponse'
160 summary: E2 Manager Service Health Check
168 summary: Gets a list of all E2T Instances address and their associated RANs
171 description: Successful operation
177 $ref: '#/components/schemas/E2tIdentity'
179 description: Internal Error
181 application/problem+json:
183 $ref: '#/components/schemas/ErrorResponse'
212 additionalProperties: false
223 sulTransmissionBandwidth:
233 additionalProperties: false
235 additionalProperties: false
237 additionalProperties: false
250 additionalProperties: false
261 sulTransmissionBandwidth:
271 additionalProperties: false
273 additionalProperties: false
275 additionalProperties: false
277 additionalProperties: false
292 additionalProperties: false
303 sulTransmissionBandwidth:
313 additionalProperties: false
315 additionalProperties: false
317 additionalProperties: false
319 additionalProperties: false
321 additionalProperties: false
335 additionalProperties: false
338 servedNrCellInformation:
357 additionalProperties: false
368 sulTransmissionBandwidth:
378 additionalProperties: false
380 additionalProperties: false
382 additionalProperties: false
384 dlTransmissionBandwidth:
394 additionalProperties: false
407 additionalProperties: false
418 sulTransmissionBandwidth:
428 additionalProperties: false
430 additionalProperties: false
432 additionalProperties: false
434 ulTransmissionBandwidth:
444 additionalProperties: false
446 additionalProperties: false
461 additionalProperties: false
472 sulTransmissionBandwidth:
482 additionalProperties: false
484 additionalProperties: false
486 additionalProperties: false
488 transmissionBandwidth:
498 additionalProperties: false
500 additionalProperties: false
502 additionalProperties: false
518 additionalProperties: false
520 additionalProperties: false
528 ranFunctionDefinition:
532 additionalProperties: false
535 additionalProperties: false
537 additionalProperties: false
554 additionalProperties: false
579 additionalProperties: false
590 sulTransmissionBandwidth:
600 additionalProperties: false
602 additionalProperties: false
604 additionalProperties: false
617 additionalProperties: false
628 sulTransmissionBandwidth:
638 additionalProperties: false
640 additionalProperties: false
642 additionalProperties: false
644 additionalProperties: false
659 additionalProperties: false
670 sulTransmissionBandwidth:
680 additionalProperties: false
682 additionalProperties: false
684 additionalProperties: false
686 additionalProperties: false
688 additionalProperties: false
702 additionalProperties: false
705 servedNrCellInformation:
724 additionalProperties: false
735 sulTransmissionBandwidth:
745 additionalProperties: false
747 additionalProperties: false
749 additionalProperties: false
751 dlTransmissionBandwidth:
761 additionalProperties: false
774 additionalProperties: false
785 sulTransmissionBandwidth:
795 additionalProperties: false
797 additionalProperties: false
799 additionalProperties: false
801 ulTransmissionBandwidth:
811 additionalProperties: false
813 additionalProperties: false
828 additionalProperties: false
839 sulTransmissionBandwidth:
849 additionalProperties: false
851 additionalProperties: false
853 additionalProperties: false
855 transmissionBandwidth:
865 additionalProperties: false
867 additionalProperties: false
869 additionalProperties: false
885 additionalProperties: false
887 additionalProperties: false
895 ranFunctionDefinition:
899 additionalProperties: false
902 additionalProperties: false
916 criticalityDiagnostics:
918 informationElementCriticalityDiagnostics:
931 additionalProperties: false
936 procedureCriticality:
944 additionalProperties: false
966 additionalProperties: false
968 additionalProperties: false
1015 dlTransmissionBandwidth:
1021 ulTransmissionBandwidth:
1027 additionalProperties: false
1031 additionalSpecialSubframeExtensionInfo:
1033 additionalSpecialSubframePatternsExtension:
1045 additionalProperties: false
1047 additionalSpecialSubframeInfo:
1049 additionalSpecialSubframePatterns:
1061 additionalProperties: false
1065 specialSubframeInfo:
1075 specialSubframePatterns:
1079 additionalProperties: false
1085 transmissionBandwidth:
1089 additionalProperties: false
1091 additionalProperties: false
1099 freqBandIndicatorPriority:
1103 mbmsServiceAreaIdentities:
1110 radioframeAllocationOffset:
1112 radioframeAllocationPeriod:
1118 subframeAllocationType:
1122 additionalProperties: false
1140 additionalProperties: false
1143 numberOfAntennaPorts:
1153 prachConfigurationIndex:
1155 prachFrequencyOffset:
1159 zeroCorrelationZoneConfiguration:
1161 additionalProperties: false
1165 additionalProperties: false
1168 additionalProperties: false
1180 additionalProperties: false
1205 additionalProperties: false
1216 sulTransmissionBandwidth:
1226 additionalProperties: false
1228 additionalProperties: false
1230 additionalProperties: false
1243 additionalProperties: false
1254 sulTransmissionBandwidth:
1264 additionalProperties: false
1266 additionalProperties: false
1268 additionalProperties: false
1270 additionalProperties: false
1285 additionalProperties: false
1296 sulTransmissionBandwidth:
1306 additionalProperties: false
1308 additionalProperties: false
1310 additionalProperties: false
1312 additionalProperties: false
1314 additionalProperties: false
1328 additionalProperties: false
1331 servedNrCellInformation:
1350 additionalProperties: false
1361 sulTransmissionBandwidth:
1371 additionalProperties: false
1373 additionalProperties: false
1375 additionalProperties: false
1377 dlTransmissionBandwidth:
1387 additionalProperties: false
1400 additionalProperties: false
1411 sulTransmissionBandwidth:
1421 additionalProperties: false
1423 additionalProperties: false
1425 additionalProperties: false
1427 ulTransmissionBandwidth:
1437 additionalProperties: false
1439 additionalProperties: false
1454 additionalProperties: false
1465 sulTransmissionBandwidth:
1475 additionalProperties: false
1477 additionalProperties: false
1479 additionalProperties: false
1481 transmissionBandwidth:
1491 additionalProperties: false
1493 additionalProperties: false
1495 additionalProperties: false
1511 additionalProperties: false
1513 additionalProperties: false
1521 ranFunctionDefinition:
1523 ranFunctionRevision:
1525 additionalProperties: false
1528 additionalProperties: false
1542 criticalityDiagnostics:
1544 informationElementCriticalityDiagnostics:
1557 additionalProperties: false
1562 procedureCriticality:
1570 additionalProperties: false
1588 transportLayerCause:
1592 additionalProperties: false
1594 additionalProperties: false
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
1610 description: Human readable text
1611 RedButtonPartialSuccessResponseModel:
1618 description: Partial success reason
1639 description: '500 - RNIB error, 501 - internal problem'
1642 description: Human readable text