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 and delete the data from the
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'
162 summary: E2 Manager Service Health Check
227 dlTransmissionBandwidth:
233 ulTransmissionBandwidth:
239 additionalProperties: false
243 additionalSpecialSubframeExtensionInfo:
245 additionalSpecialSubframePatternsExtension:
257 additionalProperties: false
259 additionalSpecialSubframeInfo:
261 additionalSpecialSubframePatterns:
273 additionalProperties: false
287 specialSubframePatterns:
291 additionalProperties: false
297 transmissionBandwidth:
301 additionalProperties: false
303 additionalProperties: false
311 freqBandIndicatorPriority:
315 mbmsServiceAreaIdentities:
322 radioframeAllocationOffset:
324 radioframeAllocationPeriod:
330 subframeAllocationType:
334 additionalProperties: false
352 additionalProperties: false
355 numberOfAntennaPorts:
365 prachConfigurationIndex:
367 prachFrequencyOffset:
371 zeroCorrelationZoneConfiguration:
373 additionalProperties: false
377 additionalProperties: false
380 additionalProperties: false
409 additionalProperties: false
420 sulTransmissionBandwidth:
430 additionalProperties: false
432 additionalProperties: false
434 additionalProperties: false
447 additionalProperties: false
458 sulTransmissionBandwidth:
468 additionalProperties: false
470 additionalProperties: false
472 additionalProperties: false
474 additionalProperties: false
489 additionalProperties: false
500 sulTransmissionBandwidth:
510 additionalProperties: false
512 additionalProperties: false
514 additionalProperties: false
516 additionalProperties: false
518 additionalProperties: false
532 additionalProperties: false
535 servedNrCellInformation:
554 additionalProperties: false
565 sulTransmissionBandwidth:
575 additionalProperties: false
577 additionalProperties: false
579 additionalProperties: false
581 dlTransmissionBandwidth:
591 additionalProperties: false
604 additionalProperties: false
615 sulTransmissionBandwidth:
625 additionalProperties: false
627 additionalProperties: false
629 additionalProperties: false
631 ulTransmissionBandwidth:
641 additionalProperties: false
643 additionalProperties: false
658 additionalProperties: false
669 sulTransmissionBandwidth:
679 additionalProperties: false
681 additionalProperties: false
683 additionalProperties: false
685 transmissionBandwidth:
695 additionalProperties: false
697 additionalProperties: false
699 additionalProperties: false
715 additionalProperties: false
717 additionalProperties: false
720 additionalProperties: false
734 criticalityDiagnostics:
736 informationElementCriticalityDiagnostics:
749 additionalProperties: false
754 procedureCriticality:
762 additionalProperties: false
784 additionalProperties: false
786 additionalProperties: false
796 description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
799 description: Human readable text