Merge "Binding interface IP address for REST Server"

[ric-plt/xapp-frame.git] / pkg / restapi / embedded_spec.go

diff --git a/pkg/restapi/embedded_spec.go b/pkg/restapi/embedded_spec.go
index 5fcc66f..4506519 100644 (file)
--- a/pkg/restapi/embedded_spec.go
+++ b/pkg/restapi/embedded_spec.go
@@ -29,7 +29,7 @@ func init() {
       "name": "Apache 2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     },
-    "version": "0.0.1"
+    "version": "0.0.2"
   },
   "host": "hostname",
   "basePath": "/ric/v1",
@@ -156,12 +156,10 @@ func init() {
   },
   "definitions": {
     "ActionDefinition": {
-      "description": "E2SM Octet string. ActionDefinition is an OPTIONAL IE",
-      "type": "object",
-      "properties": {
-        "OctetString": {
-          "type": "string"
-        }
+      "description": "E2SM byte array. ActionDefinition is an OPTIONAL IE",
+      "type": "array",
+      "items": {
+        "type": "integer"
       }
     },
     "ActionToBeSetup": {
@@ -220,18 +218,16 @@ func init() {
       }
     },
     "EventTriggerDefinition": {
-      "description": "E2SM Octet string",
-      "type": "object",
-      "properties": {
-        "OctetString": {
-          "type": "string"
-        }
+      "description": "E2SM byte array",
+      "type": "array",
+      "items": {
+        "type": "integer"
       }
     },
     "SubscriptionData": {
       "type": "object",
       "properties": {
-        "Endpoint": {
+        "ClientEndpoint": {
           "type": "array",
           "items": {
             "type": "string"
@@ -242,47 +238,58 @@ func init() {
         },
         "SubscriptionId": {
           "type": "integer"
+        },
+        "SubscriptionInstances": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/SubscriptionInstance"
+          }
         }
       }
     },
-    "SubscriptionDetails": {
+    "SubscriptionDetail": {
       "type": "object",
       "required": [
-        "EventTriggerList",
+        "XappEventInstanceId",
+        "EventTriggers",
         "ActionToBeSetupList"
       ],
       "properties": {
         "ActionToBeSetupList": {
           "$ref": "#/definitions/ActionsToBeSetup"
         },
-        "EventTriggerList": {
+        "EventTriggers": {
           "$ref": "#/definitions/EventTriggerDefinition"
+        },
+        "XappEventInstanceId": {
+          "type": "integer",
+          "maximum": 65535
         }
       }
     },
     "SubscriptionDetailsList": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/SubscriptionDetails"
+        "$ref": "#/definitions/SubscriptionDetail"
       }
     },
     "SubscriptionInstance": {
       "type": "object",
       "required": [
-        "RequestorId",
-        "InstanceId",
+        "XappEventInstanceId",
+        "E2EventInstanceId",
         "ErrorCause"
       ],
       "properties": {
+        "E2EventInstanceId": {
+          "type": "integer",
+          "maximum": 65535
+        },
         "ErrorCause": {
           "description": "Empty string when no error.",
           "type": "string"
         },
-        "InstanceId": {
-          "type": "integer",
-          "maximum": 65535
-        },
-        "RequestorId": {
+        "XappEventInstanceId": {
           "type": "integer",
           "maximum": 65535
         }
@@ -300,8 +307,6 @@ func init() {
       "required": [
         "ClientEndpoint",
         "Meid",
-        "RequestorId",
-        "InstanceId",
         "RANFunctionID",
         "SubscriptionDetails"
       ],
@@ -310,21 +315,22 @@ func init() {
           "description": "xApp service address and port",
           "type": "object",
           "properties": {
-            "Port": {
-              "description": "xApp service address port",
+            "HTTPPort": {
+              "description": "xApp HTTP service address port",
               "type": "integer",
               "maximum": 65535
             },
-            "ServiceName": {
+            "Host": {
               "description": "xApp service address name like 'service-ricxapp-xappname-http.ricxapp'",
               "type": "string"
+            },
+            "RMRPort": {
+              "description": "xApp RMR service address port",
+              "type": "integer",
+              "maximum": 65535
             }
           }
         },
-        "InstanceId": {
-          "type": "integer",
-          "maximum": 65535
-        },
         "Meid": {
           "type": "string"
         },
@@ -332,12 +338,12 @@ func init() {
           "type": "integer",
           "maximum": 4095
         },
-        "RequestorId": {
-          "type": "integer",
-          "maximum": 65535
-        },
         "SubscriptionDetails": {
           "$ref": "#/definitions/SubscriptionDetailsList"
+        },
+        "SubscriptionId": {
+          "description": "Optional subscription ID (Submgr allocates if not given)",
+          "type": "string"
         }
       }
     },
@@ -435,7 +441,7 @@ func init() {
       "name": "Apache 2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     },
-    "version": "0.0.1"
+    "version": "0.0.2"
   },
   "host": "hostname",
   "basePath": "/ric/v1",
@@ -562,12 +568,10 @@ func init() {
   },
   "definitions": {
     "ActionDefinition": {
-      "description": "E2SM Octet string. ActionDefinition is an OPTIONAL IE",
-      "type": "object",
-      "properties": {
-        "OctetString": {
-          "type": "string"
-        }
+      "description": "E2SM byte array. ActionDefinition is an OPTIONAL IE",
+      "type": "array",
+      "items": {
+        "type": "integer"
       }
     },
     "ActionToBeSetup": {
@@ -627,18 +631,16 @@ func init() {
       }
     },
     "EventTriggerDefinition": {
-      "description": "E2SM Octet string",
-      "type": "object",
-      "properties": {
-        "OctetString": {
-          "type": "string"
-        }
+      "description": "E2SM byte array",
+      "type": "array",
+      "items": {
+        "type": "integer"
       }
     },
     "SubscriptionData": {
       "type": "object",
       "properties": {
-        "Endpoint": {
+        "ClientEndpoint": {
           "type": "array",
           "items": {
             "type": "string"
@@ -649,48 +651,60 @@ func init() {
         },
         "SubscriptionId": {
           "type": "integer"
+        },
+        "SubscriptionInstances": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/SubscriptionInstance"
+          }
         }
       }
     },
-    "SubscriptionDetails": {
+    "SubscriptionDetail": {
       "type": "object",
       "required": [
-        "EventTriggerList",
+        "XappEventInstanceId",
+        "EventTriggers",
         "ActionToBeSetupList"
       ],
       "properties": {
         "ActionToBeSetupList": {
           "$ref": "#/definitions/ActionsToBeSetup"
         },
-        "EventTriggerList": {
+        "EventTriggers": {
           "$ref": "#/definitions/EventTriggerDefinition"
+        },
+        "XappEventInstanceId": {
+          "type": "integer",
+          "maximum": 65535,
+          "minimum": 0
         }
       }
     },
     "SubscriptionDetailsList": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/SubscriptionDetails"
+        "$ref": "#/definitions/SubscriptionDetail"
       }
     },
     "SubscriptionInstance": {
       "type": "object",
       "required": [
-        "RequestorId",
-        "InstanceId",
+        "XappEventInstanceId",
+        "E2EventInstanceId",
         "ErrorCause"
       ],
       "properties": {
-        "ErrorCause": {
-          "description": "Empty string when no error.",
-          "type": "string"
-        },
-        "InstanceId": {
+        "E2EventInstanceId": {
           "type": "integer",
           "maximum": 65535,
           "minimum": 0
         },
-        "RequestorId": {
+        "ErrorCause": {
+          "description": "Empty string when no error.",
+          "type": "string"
+        },
+        "XappEventInstanceId": {
           "type": "integer",
           "maximum": 65535,
           "minimum": 0
@@ -709,8 +723,6 @@ func init() {
       "required": [
         "ClientEndpoint",
         "Meid",
-        "RequestorId",
-        "InstanceId",
         "RANFunctionID",
         "SubscriptionDetails"
       ],
@@ -719,23 +731,24 @@ func init() {
           "description": "xApp service address and port",
           "type": "object",
           "properties": {
-            "Port": {
-              "description": "xApp service address port",
+            "HTTPPort": {
+              "description": "xApp HTTP service address port",
               "type": "integer",
               "maximum": 65535,
               "minimum": 0
             },
-            "ServiceName": {
+            "Host": {
               "description": "xApp service address name like 'service-ricxapp-xappname-http.ricxapp'",
               "type": "string"
+            },
+            "RMRPort": {
+              "description": "xApp RMR service address port",
+              "type": "integer",
+              "maximum": 65535,
+              "minimum": 0
             }
           }
         },
-        "InstanceId": {
-          "type": "integer",
-          "maximum": 65535,
-          "minimum": 0
-        },
         "Meid": {
           "type": "string"
         },
@@ -744,13 +757,34 @@ func init() {
           "maximum": 4095,
           "minimum": 0
         },
-        "RequestorId": {
+        "SubscriptionDetails": {
+          "$ref": "#/definitions/SubscriptionDetailsList"
+        },
+        "SubscriptionId": {
+          "description": "Optional subscription ID (Submgr allocates if not given)",
+          "type": "string"
+        }
+      }
+    },
+    "SubscriptionParamsClientEndpoint": {
+      "description": "xApp service address and port",
+      "type": "object",
+      "properties": {
+        "HTTPPort": {
+          "description": "xApp HTTP service address port",
           "type": "integer",
           "maximum": 65535,
           "minimum": 0
         },
-        "SubscriptionDetails": {
-          "$ref": "#/definitions/SubscriptionDetailsList"
+        "Host": {
+          "description": "xApp service address name like 'service-ricxapp-xappname-http.ricxapp'",
+          "type": "string"
+        },
+        "RMRPort": {
+          "description": "xApp RMR service address port",
+          "type": "integer",
+          "maximum": 65535,
+          "minimum": 0
         }
       }
     },