e2-mgr-client/src/main/resources/e2_manager_2019-05-15.yaml

   1 # ========================LICENSE_START=================================
   2 # O-RAN-SC
   3 # %%
   4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
   5 # %%
   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
   9 #
  10 #      http://www.apache.org/licenses/LICENSE-2.0
  11 #
  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===================================
  18 openapi: 3.0.0
  19 info:
  20   title: E2 Manager Service
  21   description: E2 Manager Service APIs
  22   version: 1.0.0
  23 servers:
  24   - url: 'http://{apiRoot}/v1'
  25     variables:
  26       apiRoot:
  27         default: 'localhost:3800'
  28 paths:
  29   /nodeb/x2-setup:
  30     post:
  31       summary: X2 Setup
  32       tags:
  33         - nodeb
  34       operationId: x2Setup
  35       requestBody:
  36         content:
  37           application/json:
  38             schema:
  39               $ref: '#/components/schemas/SetupRequest'
  40         required: true
  41       responses:
  42         '200':
  43           description: Success
  44         '400':
  45           description: Invalid input
  46           content:
  47             application/problem+json:
  48               schema:
  49                 $ref: '#/components/schemas/ErrorResponse'
  50         '500':
  51           description: Internal error
  52           content:
  53             application/problem+json:
  54               schema:
  55                 $ref: '#/components/schemas/ErrorResponse'
  56   /nodeb/endc-setup:
  57     post:
  58       tags:
  59         - nodeb
  60       summary: ENDC Setup
  61       operationId: endcSetup
  62       requestBody:
  63         content:
  64           application/json:
  65             schema:
  66               $ref: '#/components/schemas/SetupRequest'
  67         required: true
  68       responses:
  69         '200':
  70           description: Success
  71         '400':
  72           description: Invalid input
  73           content:
  74             application/json:
  75               schema:
  76                 $ref: '#/components/schemas/ErrorResponse'
  77         '500':
  78           description: Internal Error
  79           content:
  80             application/problem+json:
  81               schema:
  82                 $ref: '#/components/schemas/ErrorResponse'
  83   /health:
  84     get:
  85       tags:
  86         - Health Check
  87       summary: E2 Manager Service Health Check
  88       responses:
  89         '200':
  90           description: OK
  91 components:
  92   schemas:
  93     SetupRequest:
  94       type: object
  95       required:
  96         - ranIp
  97         - ranPort
  98         - ranName
  99       properties:
 100         ranIp:
 101           type: string
 102         ranPort:
 103           type: integer
 104           format: uint16
 105         ranName:
 106           type: string
 107     ErrorResponse:
 108       type: object
 109       required:
 110         - errorCode
 111         - errorMessage
 112       properties:
 113         errorCode:
 114           type: string
 115           description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
 116         errorMessage:
 117           type: string
 118           description: Human readable text