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/{ranName}/reset:
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 radioNetwork:handover-desirable-for-radio-reasons,
244 radioNetwork:time-critical-handover,
245 radioNetwork:resource-optimisation-handover,
246 radioNetwork:reduce-load-in-serving-cell,
247 radioNetwork:partial-handover,
248 radioNetwork:unknown-new-eNB-UE-X2AP-ID,
249 radioNetwork:unknown-old-eNB-UE-X2AP-ID,
250 radioNetwork:unknown-pair-of-UE-X2AP-ID,
251 radioNetwork:ho-target-not-allowed,
252 radioNetwork:tx2relocoverall-expiry,
253 radioNetwork:trelocprep-expiry,
254 radioNetwork:cell-not-available,
255 radioNetwork:no-radio-resources-available-in-target-cell,
256 radioNetwork:invalid-MME-GroupID,
257 radioNetwork:unknown-MME-Code,
258 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
259 radioNetwork:reportCharacteristicsEmpty,
260 radioNetwork:noReportPeriodicity,
261 radioNetwork:existingMeasurementID,
262 radioNetwork:unknown-eNB-Measurement-ID,
263 radioNetwork:measurement-temporarily-not-available,
264 radioNetwork:unspecified,
265 radioNetwork:load-balancing,
266 radioNetwork:handover-optimisation,
267 radioNetwork:value-out-of-allowed-range,
268 radioNetwork:multiple-E-RAB-ID-instances,
269 radioNetwork:switch-off-ongoing,
270 radioNetwork:not-supported-QCI-value,
271 radioNetwork:measurement-not-supported-for-the-object,
272 radioNetwork:tDCoverall-expiry,
273 radioNetwork:tDCprep-expiry,
274 radioNetwork:action-desirable-for-radio-reasons,
275 radioNetwork:reduce-load,
276 radioNetwork:resource-optimisation,
277 radioNetwork:time-critical-action,
278 radioNetwork:target-not-allowed,
279 radioNetwork:no-radio-resources-available,
280 radioNetwork:invalid-QoS-combination,
281 radioNetwork:encryption-algorithms-not-aupported,
282 radioNetwork:procedure-cancelled,
283 radioNetwork:rRM-purpose,
284 radioNetwork:improve-user-bit-rate,
285 radioNetwork:user-inactivity,
286 radioNetwork:radio-connection-with-UE-lost,
287 radioNetwork:failure-in-the-radio-interface-procedure,
288 radioNetwork:bearer-option-not-supported,
289 radioNetwork:mCG-Mobility,
290 radioNetwork:sCG-Mobility,
291 radioNetwork:count-reaches-max-value,
292 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
293 radioNetwork:pDCP-Overload]
339 dlTransmissionBandwidth:
345 ulTransmissionBandwidth:
351 additionalProperties: false
355 additionalSpecialSubframeExtensionInfo:
357 additionalSpecialSubframePatternsExtension:
369 additionalProperties: false
371 additionalSpecialSubframeInfo:
373 additionalSpecialSubframePatterns:
385 additionalProperties: false
399 specialSubframePatterns:
403 additionalProperties: false
409 transmissionBandwidth:
413 additionalProperties: false
415 additionalProperties: false
423 freqBandIndicatorPriority:
427 mbmsServiceAreaIdentities:
434 radioframeAllocationOffset:
436 radioframeAllocationPeriod:
442 subframeAllocationType:
446 additionalProperties: false
464 additionalProperties: false
467 numberOfAntennaPorts:
477 prachConfigurationIndex:
479 prachFrequencyOffset:
483 zeroCorrelationZoneConfiguration:
485 additionalProperties: false
489 additionalProperties: false
492 additionalProperties: false
504 additionalProperties: false
529 additionalProperties: false
540 sulTransmissionBandwidth:
550 additionalProperties: false
552 additionalProperties: false
554 additionalProperties: false
567 additionalProperties: false
578 sulTransmissionBandwidth:
588 additionalProperties: false
590 additionalProperties: false
592 additionalProperties: false
594 additionalProperties: false
609 additionalProperties: false
620 sulTransmissionBandwidth:
630 additionalProperties: false
632 additionalProperties: false
634 additionalProperties: false
636 additionalProperties: false
638 additionalProperties: false
652 additionalProperties: false
655 servedNrCellInformation:
674 additionalProperties: false
685 sulTransmissionBandwidth:
695 additionalProperties: false
697 additionalProperties: false
699 additionalProperties: false
701 dlTransmissionBandwidth:
711 additionalProperties: false
724 additionalProperties: false
735 sulTransmissionBandwidth:
745 additionalProperties: false
747 additionalProperties: false
749 additionalProperties: false
751 ulTransmissionBandwidth:
761 additionalProperties: false
763 additionalProperties: false
778 additionalProperties: false
789 sulTransmissionBandwidth:
799 additionalProperties: false
801 additionalProperties: false
803 additionalProperties: false
805 transmissionBandwidth:
815 additionalProperties: false
817 additionalProperties: false
819 additionalProperties: false
835 additionalProperties: false
837 additionalProperties: false
840 additionalProperties: false
854 criticalityDiagnostics:
856 informationElementCriticalityDiagnostics:
869 additionalProperties: false
874 procedureCriticality:
882 additionalProperties: false
904 additionalProperties: false
906 additionalProperties: false
916 description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
919 description: Human readable text