API to manipulate subscriber xApp list

Change-Id: Ibce357dc7a51cdee351971013596e5f12156da91
Signed-off-by: Balint Uveges <balint.uveges@nokia.com>

diff --git a/api/routing_manager.yaml b/api/routing_manager.yaml
index 1d88246..7a1e302 100644 (file)
--- a/api/routing_manager.yaml
+++ b/api/routing_manager.yaml
@@ -18,13 +18,13 @@
 #
 #
 #   Abstract:   Routing Manager's RESTful API definition
-#   Date:      29 March 2019
+#   Date:       28 August 2019
 #
 swagger: "2.0"
 info:
   title: Routing Manager
   description: "This is the Swagger/OpenAPI 2.0 definition of Routing Manager's Northbound API."
-  version: "0.3.0"
+  version: "0.4.0"
   license:
     name: "Apache 2.0"
     url: "http://www.apache.org/licenses/LICENSE-2.0.html"
@@ -126,6 +126,38 @@ paths:
           description: "Invalid data"
         201:
           description: "Xapp Subscription data received"
+  /handles/xapp-subscription-handle/{subscription_id}:
+    put:
+      tags:
+      - "handle"
+      summary: "API for updating the subscriber xApp list"
+      description: "By performing a PUT method on a xapp-subscription-handle/{subscription_id} resource, the API caller is able to update the Routing manager about the list of subscriber xApps related to the subscription denoted by the {subsription_id}."
+      operationId: "update_xapp_subscription_handle"
+      consumes:
+      - "application/json"
+#      - "application/yaml"
+      produces:
+      - "application/json"
+#      - "application/yaml"
+      parameters:
+        - in: path
+          name: subscription_id
+          required: true
+          type: integer
+          format: "uint16"
+          description: "Subscription ID"
+        - in: body
+          name: xapp-list
+          description: "xApp list"
+          required: true
+          schema:
+           $ref: "#/definitions/xapp-list"
+      responses:
+        400:
+          description: "Invalid data"
+        201:
+          description: "Xapp list received"
+  
 definitions:
   health-status:
     type: "object"
@@ -164,9 +196,27 @@ definitions:
         maximum: 65535
       subscription_id: #subscription sequence number
         type: "integer"
-        format: "int16" 
+        format: "int16"
+  xapp-list:
+    type: "array"
+    items:
+      $ref: '#/definitions/xapp-element'
+  xapp-element:
+    type: "object"
+    required:
+      - "address"
+      - "port"
+    properties:
+      address:
+        type: "string" #This is the xapp instance hostname or ip address
+      port: #xapp instance port address
+        type: "integer"
+        format: "uint16"
+        minimum: 0
+        maximum: 65535
 
 externalDocs:
   description: "Routing Manager"
   url: "http://placeholder"
 
+