Update E2 manager API to version 20190515

[portal/ric-dashboard.git] / e2-mgr-client / src / main / resources / e2_manager_2019-05-15.yaml

diff --git a/e2-mgr-client/src/main/resources/e2_manager_2019-05-15.yaml b/e2-mgr-client/src/main/resources/e2_manager_2019-05-15.yaml
new file mode 100644 (file)
index 0000000..20c4ec9
--- /dev/null
+++ b/e2-mgr-client/src/main/resources/e2_manager_2019-05-15.yaml
@@ -0,0 +1,118 @@
+# ========================LICENSE_START=================================
+# O-RAN-SC
+# %%
+# 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===================================
+openapi: 3.0.0
+info:
+  title: E2 Manager Service
+  description: E2 Manager Service APIs
+  version: 1.0.0
+servers:
+  - url: 'http://{apiRoot}/v1'
+    variables:
+      apiRoot:
+        default: 'localhost:3800'
+paths:
+  /nodeb/x2-setup:
+    post:
+      summary: X2 Setup
+      tags:
+        - nodeb
+      operationId: x2Setup
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SetupRequest'
+        required: true
+      responses:
+        '200':
+          description: Success
+        '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/endc-setup:
+    post:
+      tags:
+        - nodeb
+      summary: ENDC Setup
+      operationId: endcSetup
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SetupRequest'
+        required: true
+      responses:
+        '200':
+          description: Success
+        '400':
+          description: Invalid input
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Error
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /health:
+    get:
+      tags:
+        - Health Check
+      summary: E2 Manager Service Health Check
+      responses:
+        '200':
+          description: OK
+components:
+  schemas:
+    SetupRequest:
+      type: object
+      required:
+        - ranIp
+        - ranPort
+        - ranName
+      properties:
+        ranIp:
+          type: string
+        ranPort:
+          type: integer
+          format: uint16
+        ranName:
+          type: string
+    ErrorResponse:
+      type: object
+      required:
+        - errorCode
+        - errorMessage
+      properties:
+        errorCode:
+          type: string
+          description: '401 - corrupted json, 402 - validation error, 501 - internal problem'
+        errorMessage:
+          type: string
+          description: Human readable text