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===================================
20 title: E2 Manager Service
21 description: E2 Manager Service APIs
24 - url: 'http://{apiRoot}/v1'
27 default: 'localhost:3800'
39 $ref: '#/components/schemas/SetupRequest'
45 description: Invalid input
47 application/problem+json:
49 $ref: '#/components/schemas/ErrorResponse'
51 description: Internal error
53 application/problem+json:
55 $ref: '#/components/schemas/ErrorResponse'
61 operationId: endcSetup
66 $ref: '#/components/schemas/SetupRequest'
72 description: Invalid input
76 $ref: '#/components/schemas/ErrorResponse'
78 description: Internal Error
80 application/problem+json:
82 $ref: '#/components/schemas/ErrorResponse'
87 summary: Get RAN by name
93 description: Name of RAN to return
98 description: Successful operation
102 $ref: '#/components/schemas/GetNodebResponse'
104 description: The specified RAN name is invalid
108 $ref: '#/components/schemas/ErrorResponse'
110 description: A RAN with the specified name was not found
112 application/problem+json:
114 $ref: '#/components/schemas/ErrorResponse'
116 description: Internal Error
118 application/problem+json:
120 $ref: '#/components/schemas/ErrorResponse'
126 Close all connections to the RANs
129 description: Successful operation
131 description: Internal Error
133 application/problem+json:
135 $ref: '#/components/schemas/ErrorResponse'
140 summary: Get RANs identities list
141 operationId: getNodebIdList
144 description: Successful operation
150 $ref: '#/components/schemas/NodebIdentity'
152 description: Internal Error
154 application/problem+json:
156 $ref: '#/components/schemas/ErrorResponse'
157 /nodeb-reset/{ranName}:
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.
168 description: Name of RAN to return
175 $ref: '#/components/schemas/ResetRequest'
179 description: Successful operation
181 description: Invalid input (invalid cause, RAN in wrong state)
183 application/problem+json:
185 $ref: '#/components/schemas/ErrorResponse'
187 description: A RAN with the specified name was not found
189 application/problem+json:
191 $ref: '#/components/schemas/ErrorResponse'
193 description: Internal Error
195 application/problem+json:
197 $ref: '#/components/schemas/ErrorResponse'
203 summary: E2 Manager Service Health Check
230 enum: [misc:control-processing-overload,
231 misc:hardware-failure,
232 misc:om-intervention,
233 misc:not-enough-user-plane-processing-resources,
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]
340 dlTransmissionBandwidth:
346 ulTransmissionBandwidth:
352 additionalProperties: false
356 additionalSpecialSubframeExtensionInfo:
358 additionalSpecialSubframePatternsExtension:
370 additionalProperties: false
372 additionalSpecialSubframeInfo:
374 additionalSpecialSubframePatterns:
386 additionalProperties: false
400 specialSubframePatterns:
404 additionalProperties: false
410 transmissionBandwidth:
414 additionalProperties: false
416 additionalProperties: false
424 freqBandIndicatorPriority:
428 mbmsServiceAreaIdentities:
435 radioframeAllocationOffset:
437 radioframeAllocationPeriod:
443 subframeAllocationType:
447 additionalProperties: false
465 additionalProperties: false
468 numberOfAntennaPorts:
478 prachConfigurationIndex:
480 prachFrequencyOffset:
484 zeroCorrelationZoneConfiguration:
486 additionalProperties: false
490 additionalProperties: false
493 additionalProperties: false
505 additionalProperties: false
530 additionalProperties: false
541 sulTransmissionBandwidth:
551 additionalProperties: false
553 additionalProperties: false
555 additionalProperties: false
568 additionalProperties: false
579 sulTransmissionBandwidth:
589 additionalProperties: false
591 additionalProperties: false
593 additionalProperties: false
595 additionalProperties: false
610 additionalProperties: false
621 sulTransmissionBandwidth:
631 additionalProperties: false
633 additionalProperties: false
635 additionalProperties: false
637 additionalProperties: false
639 additionalProperties: false
653 additionalProperties: false
656 servedNrCellInformation:
675 additionalProperties: false
686 sulTransmissionBandwidth:
696 additionalProperties: false
698 additionalProperties: false
700 additionalProperties: false
702 dlTransmissionBandwidth:
712 additionalProperties: false
725 additionalProperties: false
736 sulTransmissionBandwidth:
746 additionalProperties: false
748 additionalProperties: false
750 additionalProperties: false
752 ulTransmissionBandwidth:
762 additionalProperties: false
764 additionalProperties: false
779 additionalProperties: false
790 sulTransmissionBandwidth:
800 additionalProperties: false
802 additionalProperties: false
804 additionalProperties: false
806 transmissionBandwidth:
816 additionalProperties: false
818 additionalProperties: false
820 additionalProperties: false
836 additionalProperties: false
838 additionalProperties: false
841 additionalProperties: false
855 criticalityDiagnostics:
857 informationElementCriticalityDiagnostics:
870 additionalProperties: false
875 procedureCriticality:
883 additionalProperties: false
905 additionalProperties: false
907 additionalProperties: false
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'
920 description: Human readable text