1 # ==================================================================================
2 # Copyright (c) 2019-2020 Nokia
3 # Copyright (c) 2018-2020 AT&T Intellectual Property.
4 # Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
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 # ==================================================================================
20 title: E2 Manager Service
21 description: E2 Manager Service APIs
24 - url: 'http://{apiRoot}/v1'
27 default: 'localhost:3800'
33 summary: Get RAN by name
39 description: Name of RAN to return
44 description: Successful operation
48 $ref: '#/components/schemas/NodebResponse'
50 description: The specified RAN name is invalid
54 $ref: '#/components/schemas/ErrorResponse'
56 description: A RAN with the specified name was not found
58 application/problem+json:
60 $ref: '#/components/schemas/ErrorResponse'
62 description: Internal Error
64 application/problem+json:
66 $ref: '#/components/schemas/ErrorResponse'
77 $ref: '#/components/schemas/AddEnbRequest'
81 description: Successful operation
85 $ref: '#/components/schemas/NodebResponse'
87 description: Invalid input
89 application/problem+json:
91 $ref: '#/components/schemas/ErrorResponse'
93 description: Internal error
95 application/problem+json:
97 $ref: '#/components/schemas/ErrorResponse'
99 '/nodeb/enb/{ranName}':
104 operationId: DeleteEnb
109 description: Name of RAN to delete
114 description: Successful operation
118 $ref: '#/components/schemas/NodebResponse'
120 description: The specified RAN is not ENB
124 $ref: '#/components/schemas/ErrorResponse'
126 description: A RAN with the specified name was not found
128 application/problem+json:
130 $ref: '#/components/schemas/ErrorResponse'
132 description: Internal Error
134 application/problem+json:
136 $ref: '#/components/schemas/ErrorResponse'
141 operationId: UpdateEnb
146 description: Name of ENB ran to update
153 $ref: '#/components/schemas/UpdateEnbRequest'
157 description: Successful operation
161 $ref: '#/components/schemas/NodebResponse'
163 description: Invalid input
165 application/problem+json:
167 $ref: '#/components/schemas/ErrorResponse'
169 description: Internal error
171 application/problem+json:
173 $ref: '#/components/schemas/ErrorResponse'
174 '/nodeb/gnb/{ranName}':
176 summary: Update gNB Cells
179 operationId: UpdateGnb
184 description: Name of GNB RAN to update
191 $ref: '#/components/schemas/UpdateGnbRequest'
195 description: Successful operation
199 $ref: '#/components/schemas/NodebResponse'
201 description: Invalid input
203 application/problem+json:
205 $ref: '#/components/schemas/ErrorResponse'
207 description: Internal error
209 application/problem+json:
211 $ref: '#/components/schemas/ErrorResponse'
216 summary: E2 manager is requested to check connectivity with all E2 nodes or a list of E2 nodes
230 description: 'Request accepted'
232 description: RAN not found
234 application/problem+json:
236 $ref: '#/components/schemas/ErrorResponse'
238 description: Internal Error
240 application/problem+json:
242 $ref: '#/components/schemas/ErrorResponse'
247 summary: Close all connections to the RANs
250 description: 'Operation succeeded internally, outbound calls failed'
254 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
256 description: Successful operation
258 description: Internal Error
260 application/problem+json:
262 $ref: '#/components/schemas/ErrorResponse'
267 summary: Get RANs identities list
268 operationId: getNodebIdList
271 description: Successful operation
277 $ref: '#/components/schemas/NodebIdentity'
279 description: Internal Error
281 application/problem+json:
283 $ref: '#/components/schemas/ErrorResponse'
284 '/nodeb/states/{ranName}':
286 summary: E2 manager is requested to report the health status of the connection to the E2 node
293 description: Name of RAN to get Health check
298 description: Successful operation
302 $ref: '#/components/schemas/NodebIdentity'
304 description: Invalid input
306 application/problem+json:
308 $ref: '#/components/schemas/ErrorResponse'
310 description: Internal error
312 application/problem+json:
314 $ref: '#/components/schemas/ErrorResponse'
317 summary: Update e2mgr configuration
320 operationId: SetConfiguration
325 $ref: '#/components/schemas/SetConfiguration'
329 description: Successful operation
333 $ref: '#/components/schemas/SetConfiguration'
335 description: Invalid input
337 application/problem+json:
339 $ref: '#/components/schemas/ErrorResponse'
341 description: Internal error
343 application/problem+json:
345 $ref: '#/components/schemas/ErrorResponse'
350 summary: E2 Manager Service Health Check
358 summary: Gets a list of all E2T Instances address and their associated RANs
361 description: Successful operation
367 $ref: '#/components/schemas/E2tIdentity'
369 description: Internal Error
371 application/problem+json:
373 $ref: '#/components/schemas/ErrorResponse'
382 $ref: '#/components/schemas/ServedNrCells'
383 additionalProperties: false
390 $ref: '#/components/schemas/Enb'
391 additionalProperties: false
399 additionalProperties: false
413 healthCheckTimestampSent:
415 healthCheckTimestampReceived:
427 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
428 state, 404 - resource not found, 500 - RNIB error, 501 - internal
429 problem, 502 - RMR error, 503 - Routing Manager Unavailable
432 description: Human readable text
433 RedButtonPartialSuccessResponseModel:
440 description: Partial success reason
457 ranFunctionDefinition:
489 dlTransmissionBandwidth:
495 ulTransmissionBandwidth:
501 additionalProperties: false
505 additionalSpecialSubframeExtensionInfo:
507 additionalSpecialSubframePatternsExtension:
519 additionalProperties: false
521 additionalSpecialSubframeInfo:
523 additionalSpecialSubframePatterns:
535 additionalProperties: false
549 specialSubframePatterns:
553 additionalProperties: false
559 transmissionBandwidth:
563 additionalProperties: false
565 additionalProperties: false
573 freqBandIndicatorPriority:
577 mbmsServiceAreaIdentities:
584 radioframeAllocationOffset:
586 radioframeAllocationPeriod:
592 subframeAllocationType:
596 additionalProperties: false
614 additionalProperties: false
617 numberOfAntennaPorts:
627 prachConfigurationIndex:
629 prachFrequencyOffset:
633 zeroCorrelationZoneConfiguration:
638 additionalCellInformation:
639 $ref: '#/components/schemas/AdditionalCellInformation'
650 $ref: '#/components/schemas/ServedNrCells'
653 $ref: '#/components/schemas/RanFunction'
659 - servedNrCellInformation
684 additionalProperties: false
695 sulTransmissionBandwidth:
705 additionalProperties: false
707 additionalProperties: false
709 additionalProperties: false
722 additionalProperties: false
733 sulTransmissionBandwidth:
743 additionalProperties: false
745 additionalProperties: false
747 additionalProperties: false
749 additionalProperties: false
764 additionalProperties: false
775 sulTransmissionBandwidth:
785 additionalProperties: false
787 additionalProperties: false
789 additionalProperties: false
791 additionalProperties: false
793 additionalProperties: false
807 additionalProperties: false
810 servedNrCellInformation:
835 additionalProperties: false
846 sulTransmissionBandwidth:
856 additionalProperties: false
858 additionalProperties: false
860 additionalProperties: false
862 dlTransmissionBandwidth:
872 additionalProperties: false
885 additionalProperties: false
896 sulTransmissionBandwidth:
906 additionalProperties: false
908 additionalProperties: false
910 additionalProperties: false
912 ulTransmissionBandwidth:
922 additionalProperties: false
924 additionalProperties: false
939 additionalProperties: false
950 sulTransmissionBandwidth:
960 additionalProperties: false
962 additionalProperties: false
964 additionalProperties: false
966 transmissionBandwidth:
976 additionalProperties: false
978 additionalProperties: false
980 additionalProperties: false
996 additionalCellInformation:
997 $ref: '#/components/schemas/AdditionalCellInformation'
998 additionalProperties: false
1000 additionalProperties: false
1005 criticalityDiagnostics:
1007 informationElementCriticalityDiagnostics:
1020 additionalProperties: false
1025 procedureCriticality:
1033 additionalProperties: false
1051 transportLayerCause:
1055 additionalProperties: false
1077 $ref: '#/components/schemas/Enb'
1078 additionalProperties: false
1079 AdditionalCellInformation:
1087 antennaAzimuthDirection:
1105 $ref: '#/components/schemas/Enb'
1118 $ref: '#/components/schemas/Gnb'
1130 $ref: '#/components/schemas/SetupFailure'
1133 additionalProperties: false