-# ========================LICENSE_START=================================
-# O-RAN-SC
-# %%
-# Copyright (C) 2019 AT&T Intellectual Property and Nokia
-# %%
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-# ========================LICENSE_END===================================
-openapi: 3.0.0
-info:
- title: E2 Manager Service
- description: This is a description of E2 manager service APIs
- version: 1.0.0
-servers:
- - url: http://{apiRoot}/nodeb/v1
- variables:
- apiRoot:
- default: localhost:3800
- description: >-
- E2 manager
-paths:
- /setup:
- post:
- summary: X2 Setup Request
- tags:
- - E2 Manager
- operationId: setup
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SetupRequest'
- required: true
- responses:
- '200':
- description: Request was handled successfuly
- '400':
- description: Invalid input
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '404':
- description: Resource not found
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '500':
- description: Internal server error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- default:
- description: Unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
-
- /endcSetup:
- post:
- tags:
- - E2 Manager
- summary: ENDC Setup Request
- operationId: endcSetup
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SetupRequest'
- required: true
- responses:
- '200':
- description: Request was handled successfuly
- '400':
- description: Invalid input
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '404':
- description: Resource not found
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '500':
- description: Internal server error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- default:
- description: Unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
-
- /health:
- get:
- tags:
- - E2 Manager
- summary: E2 Manager Service Health Check
- operationId: healthCheck
- responses:
- '200':
- description: OK
-components:
- schemas:
- SetupRequest:
- type: object
- required:
- - ranIp
- - ranPort
- - ranName
- properties:
- ranIp:
- type: string
- ranPort:
- type: integer
- format: uint16
- ranName:
- type: string
- ErrorResponse:
- type: object
- required:
- - errorCode
- - errorMessage
- properties:
- errorCode:
- type: string
- description: 401 - corrupted json, 402 - validation error, 501 - internal problem
- errorMessage:
- type: string
- description: Human readable text