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===================================
21 title: E2 Manager Service
22 description: E2 Manager Service APIs
25 - url: 'http://{apiRoot}/v1'
28 default: 'localhost:3800'
40 $ref: '#/components/schemas/SetupRequest'
46 description: Invalid input
48 application/problem+json:
50 $ref: '#/components/schemas/ErrorResponse'
52 description: Internal error
54 application/problem+json:
56 $ref: '#/components/schemas/ErrorResponse'
62 operationId: endcSetup
67 $ref: '#/components/schemas/SetupRequest'
73 description: Invalid input
77 $ref: '#/components/schemas/ErrorResponse'
79 description: Internal Error
81 application/problem+json:
83 $ref: '#/components/schemas/ErrorResponse'
88 summary: Get RAN by name
94 description: Name of RAN to return
99 description: Successful operation
103 $ref: '#/components/schemas/GetNodebResponse'
105 description: The specified RAN name is invalid
109 $ref: '#/components/schemas/ErrorResponse'
111 description: A RAN with the specified name was not found
113 application/problem+json:
115 $ref: '#/components/schemas/ErrorResponse'
117 description: Internal Error
119 application/problem+json:
121 $ref: '#/components/schemas/ErrorResponse'
127 Close all connections to the RANs
130 description: Successful operation
132 description: Internal Error
134 application/problem+json:
136 $ref: '#/components/schemas/ErrorResponse'
141 summary: Get RANs identities list
142 operationId: getNodebIdList
145 description: Successful operation
151 $ref: '#/components/schemas/NodebIdentity'
153 description: Internal Error
155 application/problem+json:
157 $ref: '#/components/schemas/ErrorResponse'
158 /nodeb/{ranName}/reset:
163 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.
169 description: Name of RAN to return
176 $ref: '#/components/schemas/ResetRequest'
180 description: Successful operation
182 description: Invalid input (invalid cause, RAN in wrong state)
184 application/problem+json:
186 $ref: '#/components/schemas/ErrorResponse'
188 description: A RAN with the specified name was not found
190 application/problem+json:
192 $ref: '#/components/schemas/ErrorResponse'
194 description: Internal Error
196 application/problem+json:
198 $ref: '#/components/schemas/ErrorResponse'
204 summary: E2 Manager Service Health Check
212 summary: Gets a list of all E2T Instances address and their associated RANs
215 description: Successful operation
221 $ref: '#/components/schemas/E2tIdentity'
223 description: Internal Error
225 application/problem+json:
227 $ref: '#/components/schemas/ErrorResponse'
251 enum: [misc:control-processing-overload,
252 misc:hardware-failure,
253 misc:om-intervention,
254 misc:not-enough-user-plane-processing-resources,
256 protocol:transfer-syntax-error,
257 protocol:abstract-syntax-error-reject,
258 protocol:abstract-syntax-error-ignore-and-notify,
259 protocol:message-not-compatible-with-receiver-state,
260 protocol:semantic-error,
261 protocol:unspecified,
262 protocol:abstract-syntax-error-falsely-constructed-message,
263 transport:transport-resource-unavailable,
264 transport:unspecified,
265 radioNetwork:handover-desirable-for-radio-reasons,
266 radioNetwork:time-critical-handover,
267 radioNetwork:resource-optimisation-handover,
268 radioNetwork:reduce-load-in-serving-cell,
269 radioNetwork:partial-handover,
270 radioNetwork:unknown-new-eNB-UE-X2AP-ID,
271 radioNetwork:unknown-old-eNB-UE-X2AP-ID,
272 radioNetwork:unknown-pair-of-UE-X2AP-ID,
273 radioNetwork:ho-target-not-allowed,
274 radioNetwork:tx2relocoverall-expiry,
275 radioNetwork:trelocprep-expiry,
276 radioNetwork:cell-not-available,
277 radioNetwork:no-radio-resources-available-in-target-cell,
278 radioNetwork:invalid-MME-GroupID,
279 radioNetwork:unknown-MME-Code,
280 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
281 radioNetwork:reportCharacteristicsEmpty,
282 radioNetwork:noReportPeriodicity,
283 radioNetwork:existingMeasurementID,
284 radioNetwork:unknown-eNB-Measurement-ID,
285 radioNetwork:measurement-temporarily-not-available,
286 radioNetwork:unspecified,
287 radioNetwork:load-balancing,
288 radioNetwork:handover-optimisation,
289 radioNetwork:value-out-of-allowed-range,
290 radioNetwork:multiple-E-RAB-ID-instances,
291 radioNetwork:switch-off-ongoing,
292 radioNetwork:not-supported-QCI-value,
293 radioNetwork:measurement-not-supported-for-the-object,
294 radioNetwork:tDCoverall-expiry,
295 radioNetwork:tDCprep-expiry,
296 radioNetwork:action-desirable-for-radio-reasons,
297 radioNetwork:reduce-load,
298 radioNetwork:resource-optimisation,
299 radioNetwork:time-critical-action,
300 radioNetwork:target-not-allowed,
301 radioNetwork:no-radio-resources-available,
302 radioNetwork:invalid-QoS-combination,
303 radioNetwork:encryption-algorithms-not-aupported,
304 radioNetwork:procedure-cancelled,
305 radioNetwork:rRM-purpose,
306 radioNetwork:improve-user-bit-rate,
307 radioNetwork:user-inactivity,
308 radioNetwork:radio-connection-with-UE-lost,
309 radioNetwork:failure-in-the-radio-interface-procedure,
310 radioNetwork:bearer-option-not-supported,
311 radioNetwork:mCG-Mobility,
312 radioNetwork:sCG-Mobility,
313 radioNetwork:count-reaches-max-value,
314 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
315 radioNetwork:pDCP-Overload]
361 dlTransmissionBandwidth:
367 ulTransmissionBandwidth:
373 additionalProperties: false
377 additionalSpecialSubframeExtensionInfo:
379 additionalSpecialSubframePatternsExtension:
391 additionalProperties: false
393 additionalSpecialSubframeInfo:
395 additionalSpecialSubframePatterns:
407 additionalProperties: false
421 specialSubframePatterns:
425 additionalProperties: false
431 transmissionBandwidth:
435 additionalProperties: false
437 additionalProperties: false
445 freqBandIndicatorPriority:
449 mbmsServiceAreaIdentities:
456 radioframeAllocationOffset:
458 radioframeAllocationPeriod:
464 subframeAllocationType:
468 additionalProperties: false
486 additionalProperties: false
489 numberOfAntennaPorts:
499 prachConfigurationIndex:
501 prachFrequencyOffset:
505 zeroCorrelationZoneConfiguration:
507 additionalProperties: false
511 additionalProperties: false
514 additionalProperties: false
526 additionalProperties: false
551 additionalProperties: false
562 sulTransmissionBandwidth:
572 additionalProperties: false
574 additionalProperties: false
576 additionalProperties: false
589 additionalProperties: false
600 sulTransmissionBandwidth:
610 additionalProperties: false
612 additionalProperties: false
614 additionalProperties: false
616 additionalProperties: false
631 additionalProperties: false
642 sulTransmissionBandwidth:
652 additionalProperties: false
654 additionalProperties: false
656 additionalProperties: false
658 additionalProperties: false
660 additionalProperties: false
674 additionalProperties: false
677 servedNrCellInformation:
696 additionalProperties: false
707 sulTransmissionBandwidth:
717 additionalProperties: false
719 additionalProperties: false
721 additionalProperties: false
723 dlTransmissionBandwidth:
733 additionalProperties: false
746 additionalProperties: false
757 sulTransmissionBandwidth:
767 additionalProperties: false
769 additionalProperties: false
771 additionalProperties: false
773 ulTransmissionBandwidth:
783 additionalProperties: false
785 additionalProperties: false
800 additionalProperties: false
811 sulTransmissionBandwidth:
821 additionalProperties: false
823 additionalProperties: false
825 additionalProperties: false
827 transmissionBandwidth:
837 additionalProperties: false
839 additionalProperties: false
841 additionalProperties: false
857 additionalProperties: false
859 additionalProperties: false
862 additionalProperties: false
876 criticalityDiagnostics:
878 informationElementCriticalityDiagnostics:
891 additionalProperties: false
896 procedureCriticality:
904 additionalProperties: false
926 additionalProperties: false
928 additionalProperties: false
938 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'
941 description: Human readable text
962 description: '500 - RNIB error, 501 - internal problem'
965 description: Human readable text