Prepare Swagger for the 3 APIs

Modify the swagger for following changes:
- Get All NodeB States Request (existing method, the response was changed)
- Get NodeB State Request (new method)
- RAN Health Check Request (new method)

Issue-ID: RIC-260
Change-Id: I8209a6956a4e48ade6da2e4a38321fee01609bff
Signed-off-by: subhash kumar singh <subh.singh@samsung.com>

diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml
index 7ee4a30..317a72a 100644 (file)
--- a/Swagger/E2Manager_API.yaml
+++ b/Swagger/E2Manager_API.yaml
@@ -1,3 +1,20 @@
+# ==================================================================================
+#       Copyright (c) 2019-2020 Nokia
+#       Copyright (c) 2018-2020 AT&T Intellectual Property.
+#       Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
+#
+#   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.
+# ==================================================================================
 openapi: 3.0.0
 info:
   title: E2 Manager Service
@@ -192,6 +209,37 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+  /nodeb/health:
+    put:
+      tags:
+        - nodeb
+      summary: E2 manager is requested to check connectivity with all E2 nodes or a list of E2 nodes
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                ranList:
+                  type: array
+                  items:
+                    type: string
+        required: false
+      responses:
+        '202':
+          description: 'Request accepted'
+        '404':
+          description: RAN not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Error
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse' 
   /nodeb/shutdown:
     put:
       tags:
@@ -233,6 +281,37 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+  '/nodeb/states/{ranName}':
+    get:
+      summary: E2 manager is requested to report the health status of the connection to the E2 node
+      tags:
+        - nodeb
+      parameters:
+        - name: ranName
+          in: path
+          required: true
+          description: Name of RAN to get Health check
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NodebIdentity'
+        '400':
+          description: Invalid input
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal error
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
   /nodeb/parameters:
     put:
       summary: Update e2mgr configuration
@@ -331,6 +410,10 @@ components:
           type: string
         connectionStatus:
           type: string
+        healthCheckTimestampSent:
+          type: integer
+        healthCheckTimestampReceived:
+          type: integer
       type: object
     ErrorResponse:
       type: object