e2-mgr-client/src/main/resources/e2_manager_02052019.yaml

   1 # ========================LICENSE_START=================================
   2 # ORAN-OSC
   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: This is a description of E2 manager service APIs
  22   version: 1.0.0
  23 servers:
  24   - url: http://{apiRoot}/nodeb/v1
  25     variables:
  26       apiRoot:
  27         default: localhost:3800
  28         description: >-
  29            E2 manager
  30 paths:
  31   /setup:
  32     post:
  33       summary: X2 Setup Request
  34       tags:
  35         - X2 Setup Request
  36       operationId: setup
  37       requestBody:
  38         content:
  39           application/json:
  40             schema:
  41               $ref: '#/components/schemas/SetupRequest'
  42         required: true
  43       responses:
  44         '200':
  45           description: Request was handled successfuly
  46         '400':
  47           description: Invalid input
  48           content:
  49             application/json:
  50               schema:
  51                 $ref: '#/components/schemas/ErrorResponse'
  52         '404':
  53           description: Resource not found
  54           content:
  55             application/json:
  56               schema:
  57                 $ref: '#/components/schemas/ErrorResponse'
  58         '500':
  59           description: Internal server error
  60           content:
  61             application/json:
  62               schema:
  63                 $ref: '#/components/schemas/ErrorResponse'
  64         default:
  65           description: Unexpected error
  66           content:
  67             application/json:
  68               schema:
  69                 $ref: '#/components/schemas/ErrorResponse'
  70
  71   /endcSetup:
  72     post:
  73       tags:
  74         - ENDC Setup Request
  75       summary: ENDC Setup Request
  76       operationId: endcSetup
  77       requestBody:
  78         content:
  79           application/json:
  80             schema:
  81               $ref: '#/components/schemas/SetupRequest'
  82         required: true
  83       responses:
  84         '200':
  85           description: Request was handled successfuly
  86         '400':
  87           description: Invalid input
  88           content:
  89             application/json:
  90               schema:
  91                 $ref: '#/components/schemas/ErrorResponse'
  92         '404':
  93           description: Resource not found
  94           content:
  95             application/json:
  96               schema:
  97                 $ref: '#/components/schemas/ErrorResponse'
  98         '500':
  99           description: Internal server error
 100           content:
 101             application/json:
 102               schema:
 103                 $ref: '#/components/schemas/ErrorResponse'
 104         default:
 105           description: Unexpected error
 106           content:
 107             application/json:
 108               schema:
 109                 $ref: '#/components/schemas/ErrorResponse'
 110
 111   /health:
 112     get:
 113       tags:
 114         - Health Check
 115       summary: E2 Manager Service Health Check
 116       operationId: healthCheck
 117       responses:
 118         '200':
 119           description: OK
 120 components:
 121   schemas:
 122     SetupRequest:
 123       type: object
 124       required:
 125         - ranIp
 126         - ranPort
 127         - ranName
 128       properties:
 129         ranIp:
 130           type: string
 131         ranPort:
 132           type: integer
 133           format: uint16
 134         ranName:
 135           type: string
 136     ErrorResponse:
 137       type: object
 138       required:
 139         - errorCode
 140         - errorMessage
 141       properties:
 142         errorCode:
 143           type: string
 144           description: 401 - corrupted json, 402 - validation error, 501 - internal problem
 145         errorMessage:
 146           type: string
 147           description: Human readable text