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: E2 Manager Service Health Check
178 dlTransmissionBandwidth:
184 ulTransmissionBandwidth:
190 additionalProperties: false
194 additionalSpecialSubframeExtensionInfo:
196 additionalSpecialSubframePatternsExtension:
208 additionalProperties: false
210 additionalSpecialSubframeInfo:
212 additionalSpecialSubframePatterns:
224 additionalProperties: false
238 specialSubframePatterns:
242 additionalProperties: false
248 transmissionBandwidth:
252 additionalProperties: false
254 additionalProperties: false
262 freqBandIndicatorPriority:
266 mbmsServiceAreaIdentities:
273 radioframeAllocationOffset:
275 radioframeAllocationPeriod:
281 subframeAllocationType:
285 additionalProperties: false
303 additionalProperties: false
306 numberOfAntennaPorts:
316 prachConfigurationIndex:
318 prachFrequencyOffset:
322 zeroCorrelationZoneConfiguration:
324 additionalProperties: false
328 additionalProperties: false
331 additionalProperties: false
360 additionalProperties: false
371 sulTransmissionBandwidth:
381 additionalProperties: false
383 additionalProperties: false
385 additionalProperties: false
398 additionalProperties: false
409 sulTransmissionBandwidth:
419 additionalProperties: false
421 additionalProperties: false
423 additionalProperties: false
425 additionalProperties: false
440 additionalProperties: false
451 sulTransmissionBandwidth:
461 additionalProperties: false
463 additionalProperties: false
465 additionalProperties: false
467 additionalProperties: false
469 additionalProperties: false
483 additionalProperties: false
486 servedNrCellInformation:
505 additionalProperties: false
516 sulTransmissionBandwidth:
526 additionalProperties: false
528 additionalProperties: false
530 additionalProperties: false
532 dlTransmissionBandwidth:
542 additionalProperties: false
555 additionalProperties: false
566 sulTransmissionBandwidth:
576 additionalProperties: false
578 additionalProperties: false
580 additionalProperties: false
582 ulTransmissionBandwidth:
592 additionalProperties: false
594 additionalProperties: false
609 additionalProperties: false
620 sulTransmissionBandwidth:
630 additionalProperties: false
632 additionalProperties: false
634 additionalProperties: false
636 transmissionBandwidth:
646 additionalProperties: false
648 additionalProperties: false
650 additionalProperties: false
666 additionalProperties: false
668 additionalProperties: false
671 additionalProperties: false
685 criticalityDiagnostics:
687 informationElementCriticalityDiagnostics:
700 additionalProperties: false
705 procedureCriticality:
713 additionalProperties: false
735 additionalProperties: false
737 additionalProperties: false
747 description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
750 description: Human readable text