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'
44 $ref: '#/components/schemas/SetupRequest'
50 description: Invalid input
52 application/problem+json:
54 $ref: '#/components/schemas/ErrorResponse'
56 description: Internal error
58 application/problem+json:
60 $ref: '#/components/schemas/ErrorResponse'
66 operationId: endcSetup
71 $ref: '#/components/schemas/SetupRequest'
77 description: Invalid input
81 $ref: '#/components/schemas/ErrorResponse'
83 description: Internal Error
85 application/problem+json:
87 $ref: '#/components/schemas/ErrorResponse'
92 summary: Get RAN by name
98 description: Name of RAN to return
103 description: Successful operation
107 $ref: '#/components/schemas/GetNodebResponse'
109 description: The specified RAN name is invalid
113 $ref: '#/components/schemas/ErrorResponse'
115 description: A RAN with the specified name was not found
117 application/problem+json:
119 $ref: '#/components/schemas/ErrorResponse'
121 description: Internal Error
123 application/problem+json:
125 $ref: '#/components/schemas/ErrorResponse'
131 Close all connections to the RANs
134 description: Successful operation
136 description: Internal Error
138 application/problem+json:
140 $ref: '#/components/schemas/ErrorResponse'
145 summary: Get RANs identities list
146 operationId: getNodebIdList
149 description: Successful operation
155 $ref: '#/components/schemas/NodebIdentity'
157 description: Internal Error
159 application/problem+json:
161 $ref: '#/components/schemas/ErrorResponse'
162 /nodeb/{ranName}/reset:
167 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.
173 description: Name of RAN to return
180 $ref: '#/components/schemas/ResetRequest'
184 description: Successful operation
186 description: Invalid input (invalid cause, RAN in wrong state)
188 application/problem+json:
190 $ref: '#/components/schemas/ErrorResponse'
192 description: A RAN with the specified name was not found
194 application/problem+json:
196 $ref: '#/components/schemas/ErrorResponse'
198 description: Internal Error
200 application/problem+json:
202 $ref: '#/components/schemas/ErrorResponse'
208 summary: E2 Manager Service Health Check
216 summary: Gets a list of all E2T Instances address and their associated RANs
219 description: Successful operation
225 $ref: '#/components/schemas/E2tIdentity'
227 description: Internal Error
229 application/problem+json:
231 $ref: '#/components/schemas/ErrorResponse'
255 enum: [misc:control-processing-overload,
256 misc:hardware-failure,
257 misc:om-intervention,
258 misc:not-enough-user-plane-processing-resources,
260 protocol:transfer-syntax-error,
261 protocol:abstract-syntax-error-reject,
262 protocol:abstract-syntax-error-ignore-and-notify,
263 protocol:message-not-compatible-with-receiver-state,
264 protocol:semantic-error,
265 protocol:unspecified,
266 protocol:abstract-syntax-error-falsely-constructed-message,
267 transport:transport-resource-unavailable,
268 transport:unspecified,
269 radioNetwork:handover-desirable-for-radio-reasons,
270 radioNetwork:time-critical-handover,
271 radioNetwork:resource-optimisation-handover,
272 radioNetwork:reduce-load-in-serving-cell,
273 radioNetwork:partial-handover,
274 radioNetwork:unknown-new-eNB-UE-X2AP-ID,
275 radioNetwork:unknown-old-eNB-UE-X2AP-ID,
276 radioNetwork:unknown-pair-of-UE-X2AP-ID,
277 radioNetwork:ho-target-not-allowed,
278 radioNetwork:tx2relocoverall-expiry,
279 radioNetwork:trelocprep-expiry,
280 radioNetwork:cell-not-available,
281 radioNetwork:no-radio-resources-available-in-target-cell,
282 radioNetwork:invalid-MME-GroupID,
283 radioNetwork:unknown-MME-Code,
284 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
285 radioNetwork:reportCharacteristicsEmpty,
286 radioNetwork:noReportPeriodicity,
287 radioNetwork:existingMeasurementID,
288 radioNetwork:unknown-eNB-Measurement-ID,
289 radioNetwork:measurement-temporarily-not-available,
290 radioNetwork:unspecified,
291 radioNetwork:load-balancing,
292 radioNetwork:handover-optimisation,
293 radioNetwork:value-out-of-allowed-range,
294 radioNetwork:multiple-E-RAB-ID-instances,
295 radioNetwork:switch-off-ongoing,
296 radioNetwork:not-supported-QCI-value,
297 radioNetwork:measurement-not-supported-for-the-object,
298 radioNetwork:tDCoverall-expiry,
299 radioNetwork:tDCprep-expiry,
300 radioNetwork:action-desirable-for-radio-reasons,
301 radioNetwork:reduce-load,
302 radioNetwork:resource-optimisation,
303 radioNetwork:time-critical-action,
304 radioNetwork:target-not-allowed,
305 radioNetwork:no-radio-resources-available,
306 radioNetwork:invalid-QoS-combination,
307 radioNetwork:encryption-algorithms-not-aupported,
308 radioNetwork:procedure-cancelled,
309 radioNetwork:rRM-purpose,
310 radioNetwork:improve-user-bit-rate,
311 radioNetwork:user-inactivity,
312 radioNetwork:radio-connection-with-UE-lost,
313 radioNetwork:failure-in-the-radio-interface-procedure,
314 radioNetwork:bearer-option-not-supported,
315 radioNetwork:mCG-Mobility,
316 radioNetwork:sCG-Mobility,
317 radioNetwork:count-reaches-max-value,
318 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
319 radioNetwork:pDCP-Overload]
365 dlTransmissionBandwidth:
371 ulTransmissionBandwidth:
377 additionalProperties: false
381 additionalSpecialSubframeExtensionInfo:
383 additionalSpecialSubframePatternsExtension:
395 additionalProperties: false
397 additionalSpecialSubframeInfo:
399 additionalSpecialSubframePatterns:
411 additionalProperties: false
425 specialSubframePatterns:
429 additionalProperties: false
435 transmissionBandwidth:
439 additionalProperties: false
441 additionalProperties: false
449 freqBandIndicatorPriority:
453 mbmsServiceAreaIdentities:
460 radioframeAllocationOffset:
462 radioframeAllocationPeriod:
468 subframeAllocationType:
472 additionalProperties: false
490 additionalProperties: false
493 numberOfAntennaPorts:
503 prachConfigurationIndex:
505 prachFrequencyOffset:
509 zeroCorrelationZoneConfiguration:
511 additionalProperties: false
515 additionalProperties: false
518 additionalProperties: false
530 additionalProperties: false
555 additionalProperties: false
566 sulTransmissionBandwidth:
576 additionalProperties: false
578 additionalProperties: false
580 additionalProperties: false
593 additionalProperties: false
604 sulTransmissionBandwidth:
614 additionalProperties: false
616 additionalProperties: false
618 additionalProperties: false
620 additionalProperties: false
635 additionalProperties: false
646 sulTransmissionBandwidth:
656 additionalProperties: false
658 additionalProperties: false
660 additionalProperties: false
662 additionalProperties: false
664 additionalProperties: false
678 additionalProperties: false
681 servedNrCellInformation:
700 additionalProperties: false
711 sulTransmissionBandwidth:
721 additionalProperties: false
723 additionalProperties: false
725 additionalProperties: false
727 dlTransmissionBandwidth:
737 additionalProperties: false
750 additionalProperties: false
761 sulTransmissionBandwidth:
771 additionalProperties: false
773 additionalProperties: false
775 additionalProperties: false
777 ulTransmissionBandwidth:
787 additionalProperties: false
789 additionalProperties: false
804 additionalProperties: false
815 sulTransmissionBandwidth:
825 additionalProperties: false
827 additionalProperties: false
829 additionalProperties: false
831 transmissionBandwidth:
841 additionalProperties: false
843 additionalProperties: false
845 additionalProperties: false
861 additionalProperties: false
863 additionalProperties: false
866 additionalProperties: false
880 criticalityDiagnostics:
882 informationElementCriticalityDiagnostics:
895 additionalProperties: false
900 procedureCriticality:
908 additionalProperties: false
930 additionalProperties: false
932 additionalProperties: false
942 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'
945 description: Human readable text
966 description: '500 - RNIB error, 501 - internal problem'
969 description: Human readable text