###
# ========================LICENSE_START=================================
# ORAN-OSC
# %%
# 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===================================
###
---
swagger: "2.0"
info:
  description: "Draft API for RIC e2-manager"
  version: "0.0.1"
  title: "RIC e2-manager"
  license:
    name: "Apache 2.0"
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "localhost"
basePath: "/e2/v1"
schemes:
  - "http"
paths:
  /e2/v1/health:
    get:
      summary: "Health check of E2 Manager"
      operationId: "getHealth"
      responses:
        200:
          description: "Health is good"
        500:
          description: "Health is poor"
  /e2/v1/setup:
    post:
      summary: "Set up connection to a RAN element"
      operationId: "setupRan"
      consumes:
        - "application/json"
      produces:
        - "application/json"
      parameters:
        - in: "body"
          name: "ranSetupRequest"
          description: "Setup request with host and port"
          required: true
          schema:
            $ref: "#/definitions/ranSetupRequest"
      responses:
        200:
          description: "Setup successful"
        400:
          description: "Invalid input"
definitions:
  ranSetupRequest:
    type: "object"
    properties:
      ranIp:
        type: "string"
        description: "IPv4/IPv6 address"
      ranPort:
        type: "integer"
        format: "int32"
        example: 80
      ranName:
        type: "string"
        description: "eNodeB/gNodeB name"