Code Review / ric-plt / e2mgr.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
[RIC-571] Increment Swagger version to 5.2.21
[ric-plt/e2mgr.git] / Swagger / E2Manager_API.yaml
diff --git a/Swagger/E2Manager_API.yaml b/Swagger/E2Manager_API.yaml
index 285f2d8..1bab2f6 100644 (file)
--- a/Swagger/E2Manager_API.yaml
+++ b/Swagger/E2Manager_API.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.0
 info:
   title: E2 Manager Service
   description: E2 Manager Service APIs
-  version: 5.2.9
+  version: 5.2.21
 servers:
   - url: 'http://{apiRoot}/v1'
     variables:
@@ -28,7 +28,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/GetNodebResponse'
+                $ref: '#/components/schemas/NodebResponse'
         '400':
           description: The specified RAN name is invalid
           content:
@@ -47,24 +47,93 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-  '/nodeb/{ranName}/update':
+  /nodeb/enb:
+    post:
+      summary: Add eNB
+      tags:
+        - nodeb
+      operationId: AddEnb
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AddEnbRequest'
+        required: true
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NodebResponse'
+        '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/enb/{ranName}':
+    delete:
+      tags:
+        - nodeb
+      summary: Delete eNB
+      operationId: DeleteEnb
+      parameters:
+        - name: ranName
+          in: path
+          required: true
+          description: Name of RAN to delete
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NodebResponse'
+        '400':
+          description: The specified RAN is not ENB
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: A RAN with the specified name was not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Error
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
     put:
-      summary: Update GNB
       tags:
         - nodeb
-      operationId: UpdateGnb
+      summary: Update eNB
+      operationId: UpdateEnb
       parameters:
         - name: ranName
           in: path
           required: true
-          description: Name of GNB RAN to update
+          description: Name of ENB ran to update
           schema:
             type: string
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/UpdateGnbRequest'
+              $ref: '#/components/schemas/UpdateEnbRequest'
         required: true
       responses:
         '200':
@@ -72,7 +141,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UpdateGnbResponse'
+                $ref: '#/components/schemas/NodebResponse'
         '400':
           description: Invalid input
           content:
@@ -85,17 +154,24 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-  '/nodeb/enb':
-    post:
-      summary: Add ENB
+  '/nodeb/gnb/{ranName}':
+    put:
+      summary: Update gNB Cells
       tags:
         - nodeb
-      operationId: AddEnb
+      operationId: UpdateGnb
+      parameters:
+        - name: ranName
+          in: path
+          required: true
+          description: Name of GNB RAN to update
+          schema:
+            type: string
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/AddEnbRequest'
+              $ref: '#/components/schemas/UpdateGnbRequest'
         required: true
       responses:
         '200':
@@ -103,7 +179,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/AddEnbResponse'
+                $ref: '#/components/schemas/NodebResponse'
         '400':
           description: Invalid input
           content:
@@ -116,7 +192,6 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-
   /nodeb/shutdown:
     put:
       tags:
@@ -137,7 +212,7 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-  /nodeb/ids:
+  /nodeb/states:
     get:
       tags:
         - nodeb
@@ -219,64 +294,6 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
 components:
   schemas:
-    AddEnbRequest:
-      type: object
-      required:
-        - ranName
-        - globalNbId
-        - enb
-      properties:
-        ranName:
-          type: string
-        globalNbId:
-          properties:
-            nbId:
-              type: string
-            plmnId:
-              type: string
-        ip:
-          type: string
-        port:
-          type: integer
-        enb:
-          $ref: '#/components/schemas/Enb'
-      additionalProperties: false
-
-    AddEnbResponse:
-      properties:
-        connectionStatus:
-          oneOf:
-            - type: string
-            - type: integer
-        failureType:
-          oneOf:
-            - type: string
-            - type: integer
-        globalNbId:
-          properties:
-            nbId:
-              type: string
-            plmnId:
-              type: string
-          additionalProperties: false
-          type: object
-        enb:
-          $ref: '#/components/schemas/Enb'
-        ip:
-          type: string
-        nodeType:
-          oneOf:
-            - type: string
-            - type: integer
-        port:
-          type: integer
-        ranName:
-          type: string
-        setupFailure:
-          $ref: '#/components/schemas/SetupFailure'
-      additionalProperties: false
-      type: object
-
     UpdateGnbRequest:
       type: object
       required:
@@ -285,40 +302,14 @@ components:
         servedNrCells:
           $ref: '#/components/schemas/ServedNrCells'
       additionalProperties: false
-    UpdateGnbResponse:
+    UpdateEnbRequest:
+      type: object
+      required:
+        - enb
       properties:
-        connectionStatus:
-          oneOf:
-            - type: string
-            - type: integer
-        failureType:
-          oneOf:
-            - type: string
-            - type: integer
-        globalNbId:
-          properties:
-            nbId:
-              type: string
-            plmnId:
-              type: string
-          additionalProperties: false
-          type: object
-        gnb:
-          $ref: '#/components/schemas/Gnb'
-        ip:
-          type: string
-        nodeType:
-          oneOf:
-            - type: string
-            - type: integer
-        port:
-          type: integer
-        ranName:
-          type: string
-        setupFailure:
-          $ref: '#/components/schemas/SetupFailure'
+        enb:
+          $ref: '#/components/schemas/Enb'
       additionalProperties: false
-      type: object
     SetConfiguration:
       type: object
       required:
@@ -339,41 +330,6 @@ components:
         inventoryName:
           type: string
       type: object
-    GetNodebResponse:
-      properties:
-        connectionStatus:
-          oneOf:
-            - type: string
-            - type: integer
-        enb:
-          $ref: '#/components/schemas/Enb'
-        failureType:
-          oneOf:
-            - type: string
-            - type: integer
-        globalNbId:
-          properties:
-            nbId:
-              type: string
-            plmnId:
-              type: string
-          type: object
-        gnb:
-          $ref: '#/components/schemas/Gnb'
-        ip:
-          type: string
-        nodeType:
-          oneOf:
-            - type: string
-            - type: integer
-        port:
-          type: integer
-        ranName:
-          type: string
-        setupFailure:
-          $ref: '#/components/schemas/SetupFailure'
-      additionalProperties: false
-      type: object
     ErrorResponse:
       type: object
       required:
@@ -601,6 +557,10 @@ components:
       type: object
     Gnb:
       properties:
+        gnbType:
+          oneOf:
+            - type: string
+            - type: integer
         servedNrCells:
           $ref: '#/components/schemas/ServedNrCells'
         ranFunctions:
@@ -1009,6 +969,28 @@ components:
             - type: integer
       additionalProperties: false
       type: object
+    AddEnbRequest:
+      type: object
+      required:
+        - ranName
+        - globalNbId
+        - enb
+      properties:
+        ranName:
+          type: string
+        globalNbId:
+          properties:
+            nbId:
+              type: string
+            plmnId:
+              type: string
+        ip:
+          type: string
+        port:
+          type: integer
+        enb:
+          $ref: '#/components/schemas/Enb'
+      additionalProperties: false
     AdditionalCellInformation:
       properties:
         cellLatitude:
@@ -1028,3 +1010,40 @@ components:
         sectorId:
           type: integer
       type: object
+    NodebResponse:
+      properties:
+        connectionStatus:
+          oneOf:
+            - type: string
+            - type: integer
+        enb:
+          $ref: '#/components/schemas/Enb'
+        failureType:
+          oneOf:
+            - type: string
+            - type: integer
+        globalNbId:
+          properties:
+            nbId:
+              type: string
+            plmnId:
+              type: string
+          type: object
+        gnb:
+          $ref: '#/components/schemas/Gnb'
+        ip:
+          type: string
+        nodeType:
+          oneOf:
+            - type: string
+            - type: integer
+        port:
+          type: integer
+        ranName:
+          type: string
+        setupFailure:
+          $ref: '#/components/schemas/SetupFailure'
+        setupFromNetwork:
+          type: boolean
+      additionalProperties: false
+      type: object