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

   1 ###
   2 # ========================LICENSE_START=================================
   3 # O-RAN-SC
   4 # %%
   5 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
   6 # %%
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #      http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 # ========================LICENSE_END===================================
  19 ###
  20 ---
  21 swagger: "2.0"
  22 info:
  23   description: "Draft API for RIC e2-manager"
  24   version: "0.0.1"
  25   title: "RIC e2-manager"
  26   license:
  27     name: "Apache 2.0"
  28     url: "http://www.apache.org/licenses/LICENSE-2.0.html"
  29 host: "localhost"
  30 basePath: "/e2/v1"
  31 schemes:
  32   - "http"
  33 paths:
  34   /e2/v1/health:
  35     get:
  36       summary: "Health check of E2 Manager"
  37       operationId: "getHealth"
  38       responses:
  39         200:
  40           description: "Health is good"
  41         500:
  42           description: "Health is poor"
  43   /e2/v1/setup:
  44     post:
  45       summary: "Set up connection to a RAN element"
  46       operationId: "setupRan"
  47       consumes:
  48         - "application/json"
  49       produces:
  50         - "application/json"
  51       parameters:
  52         - in: "body"
  53           name: "ranSetupRequest"
  54           description: "Setup request with host and port"
  55           required: true
  56           schema:
  57             $ref: "#/definitions/ranSetupRequest"
  58       responses:
  59         200:
  60           description: "Setup successful"
  61         400:
  62           description: "Invalid input"
  63 definitions:
  64   ranSetupRequest:
  65     type: "object"
  66     properties:
  67       ranIp:
  68         type: "string"
  69         description: "IPv4/IPv6 address"
  70       ranPort:
  71         type: "integer"
  72         format: "int32"
  73         example: 80
  74       ranName:
  75         type: "string"
  76         description: "eNodeB/gNodeB name"