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'
125 summary: Close all connections to the RANs and delete the data from the nodeb-rnib DB
128 description: Successful operation
130 description: Internal Error
132 application/problem+json:
134 $ref: '#/components/schemas/ErrorResponse'
139 summary: E2 Manager Service Health Check
192 dlTransmissionBandwidth:
198 ulTransmissionBandwidth:
204 additionalProperties: false
208 additionalSpecialSubframeExtensionInfo:
210 additionalSpecialSubframePatternsExtension:
222 additionalProperties: false
224 additionalSpecialSubframeInfo:
226 additionalSpecialSubframePatterns:
238 additionalProperties: false
252 specialSubframePatterns:
256 additionalProperties: false
262 transmissionBandwidth:
266 additionalProperties: false
268 additionalProperties: false
276 freqBandIndicatorPriority:
280 mbmsServiceAreaIdentities:
287 radioframeAllocationOffset:
289 radioframeAllocationPeriod:
295 subframeAllocationType:
299 additionalProperties: false
317 additionalProperties: false
320 numberOfAntennaPorts:
330 prachConfigurationIndex:
332 prachFrequencyOffset:
336 zeroCorrelationZoneConfiguration:
338 additionalProperties: false
342 additionalProperties: false
345 additionalProperties: false
374 additionalProperties: false
385 sulTransmissionBandwidth:
395 additionalProperties: false
397 additionalProperties: false
399 additionalProperties: false
412 additionalProperties: false
423 sulTransmissionBandwidth:
433 additionalProperties: false
435 additionalProperties: false
437 additionalProperties: false
439 additionalProperties: false
454 additionalProperties: false
465 sulTransmissionBandwidth:
475 additionalProperties: false
477 additionalProperties: false
479 additionalProperties: false
481 additionalProperties: false
483 additionalProperties: false
497 additionalProperties: false
500 servedNrCellInformation:
519 additionalProperties: false
530 sulTransmissionBandwidth:
540 additionalProperties: false
542 additionalProperties: false
544 additionalProperties: false
546 dlTransmissionBandwidth:
556 additionalProperties: false
569 additionalProperties: false
580 sulTransmissionBandwidth:
590 additionalProperties: false
592 additionalProperties: false
594 additionalProperties: false
596 ulTransmissionBandwidth:
606 additionalProperties: false
608 additionalProperties: false
623 additionalProperties: false
634 sulTransmissionBandwidth:
644 additionalProperties: false
646 additionalProperties: false
648 additionalProperties: false
650 transmissionBandwidth:
660 additionalProperties: false
662 additionalProperties: false
664 additionalProperties: false
680 additionalProperties: false
682 additionalProperties: false
685 additionalProperties: false
699 criticalityDiagnostics:
701 informationElementCriticalityDiagnostics:
714 additionalProperties: false
719 procedureCriticality:
727 additionalProperties: false
749 additionalProperties: false
751 additionalProperties: false
761 description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
764 description: Human readable text