Subscription REST interface update

[ric-plt/xapp-frame.git] / api / xapp_rest_api.yaml

diff --git a/api/xapp_rest_api.yaml b/api/xapp_rest_api.yaml
index 38a34f9..8f08dd9 100644 (file)
--- a/api/xapp_rest_api.yaml
+++ b/api/xapp_rest_api.yaml
@@ -1,7 +1,7 @@
 swagger: '2.0'
 info:
   description: This is the initial REST API for RIC subscription
-  version: 0.0.2
+  version: 0.0.3
   title: RIC subscription
   license:
     name: Apache 2.0
@@ -122,11 +122,10 @@ definitions:
     items:
       $ref: '#/definitions/XAppConfig'
   ActionDefinition:
-    type: object
-    description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
-    properties:
-      OctetString:
-        type: string
+    type: array
+    description: E2SM byte array. ActionDefinition is an OPTIONAL IE
+    items:
+      type: integer
   SubsequentAction:
     description: SubsequentAction is an OPTIONAL IE
     type: object
@@ -185,11 +184,10 @@ definitions:
     items:
       $ref: '#/definitions/ActionToBeSetup'
   EventTriggerDefinition:
-    type: object
-    description: E2SM Octet string
-    properties:
-      OctetString:
-        type: string
+    type: array
+    description: E2SM byte array
+    items:
+      type: integer
   SubscriptionDetail:
     type: object
     required:
@@ -245,6 +243,25 @@ definitions:
         type: integer
         minimum: 0
         maximum: 4095
+      E2SubscriptionDirectives:
+        type: object
+        properties:
+          E2TimeoutTimerValue:
+            description: How long time response is waited from E2 node
+            type: integer
+            default: 2
+            minimum: 1
+            maximum: 10
+          E2RetryCount:
+            description: How many times E2 subscription request is retried
+            type: integer
+            default: 2
+            minimum: 0
+            maximum: 10
+          RMRRoutingNeeded:
+            description: Subscription needs RMR route from E2Term to xApp 
+            type: boolean
+            default: True
       SubscriptionDetails:
         $ref: '#/definitions/SubscriptionDetailsList'
   SubscriptionResponse:
@@ -265,6 +282,8 @@ definitions:
       - XappEventInstanceId
       - E2EventInstanceId
       - ErrorCause
+      - ErrorSource
+      - TimeoutType
     properties:
       XappEventInstanceId:
         type: integer
@@ -274,9 +293,32 @@ definitions:
         type: integer
         minimum: 0
         maximum: 65535
+      RejectCause:
+        description: Reason for REST subscription rejection.
+        type: string
+        default: None
+        enum:
+        - None
+        - REST-subscription-ongoing         # xApp should retry after delay
+        - REST-subscription-delete-ongoing  # xApp should retry after delay
+        - Invalid-REST-request-message
+        - REST-subscription-with-given-id-does-not-exist
+        - E2-interface-down
+        - Other
       ErrorCause:
-        description: Empty string when no error.
+        description: Descriptive error cause. Empty string when no error.
+        type: string
+        default: ''
+      ErrorSource:
+        description: Source of error cause.
+        type: string
+        default: None
+        enum: [None, SUBMGR, RTMGR, DBAAS, ASN1, E2Node]
+      TimeoutType:
+        description: Type timeout. xApp should retry if timeout occours.
         type: string
+        default: None
+        enum: [None, E2-Timeout, RTMGR-Timeout, DBAAS-Timeout]
   SubscriptionData:
     type: object
     properties: