Further enhancements
[ric-plt/xapp-frame.git] / api / xapp_rest_api.yaml
index 74db6b9..8554ca2 100755 (executable)
@@ -191,27 +191,35 @@ definitions:
     properties:
       OctetString:
         type: string
-  SubscriptionDetails:
+  SubscriptionDetail:
     type: object
     required:
-      - EventTriggerList
+      - RequestorId
+      - InstanceId
+      - EventTriggers
       - ActionToBeSetupList
     properties:
-      EventTriggerList:
+      RequestorId:
+        type: integer
+        minimum: 0
+        maximum: 65535
+      InstanceId:
+        type: integer
+        minimum: 0
+        maximum: 65535
+      EventTriggers:
         $ref: '#/definitions/EventTriggerDefinition'
       ActionToBeSetupList:
         $ref: '#/definitions/ActionsToBeSetup'
   SubscriptionDetailsList:
     type: array
     items:
-      $ref: '#/definitions/SubscriptionDetails'
+      $ref: '#/definitions/SubscriptionDetail'
   SubscriptionParams:
     type: object
     required:
       - ClientEndpoint
       - Meid
-      - RequestorId
-      - InstanceId
       - RANFunctionID
       - SubscriptionDetails
     properties:
@@ -219,26 +227,22 @@ definitions:
         type: object
         description: xApp service address and port
         properties:
-          ServiceName:
+          Host:
             description: >-
-              xApp service address name like
-              'service-ricxapp-xappname-http.ricxapp'
+              xApp service address name like 'service-ricxapp-xappname-http.ricxapp'
             type: string
-          Port:
-            description: xApp service address port
+          HTTPPort:
+            description: xApp HTTP service address port
+            type: integer
+            minimum: 0
+            maximum: 65535
+          RMRPort:
+            description: xApp RMR service address port
             type: integer
             minimum: 0
             maximum: 65535
       Meid:
         type: string
-      RequestorId:
-        type: integer
-        minimum: 0
-        maximum: 65535
-      InstanceId:
-        type: integer
-        minimum: 0
-        maximum: 65535
       RANFunctionID:
         type: integer
         minimum: 0
@@ -275,7 +279,6 @@ definitions:
       ErrorCause:
         description: Empty string when no error.
         type: string
-
   SubscriptionData:
     type: object
     properties:
@@ -283,10 +286,14 @@ definitions:
         type: integer
       Meid:
         type: string
-      Endpoint:
+      ClientEndpoint:
         type: array
         items:
           type: string
+      SubscriptionInstances:
+        type: array
+        items:
+          $ref: '#/definitions/SubscriptionInstance'
   SubscriptionList:
     type: array
     description: A list of subscriptions