X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=api%2Frouting_manager.yaml;h=f4f852d6f31a21e1be5f18223271659d02b9bb6d;hb=a8596ec6db91b8a45a1a21421a726b9b05ce7d48;hp=1d88246a96e79e6da61018ecdb48eff4b2d4a4c9;hpb=e90dddabfdb89ff8cd7ed52dba4849efd2d8edf9;p=ric-plt%2Frtmgr.git

diff --git a/api/routing_manager.yaml b/api/routing_manager.yaml
index 1d88246..f4f852d 100644
--- a/api/routing_manager.yaml
+++ b/api/routing_manager.yaml
@@ -14,17 +14,22 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+#
+#   This source code is part of the near-RT RIC (RAN Intelligent Controller)
+#   platform project (RICP).
+#
 #==================================================================================
 #
 #
+#
 #   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 +131,58 @@ paths:
           description: "Invalid data"
         201:
           description: "Xapp Subscription data received"
+    delete:
+      tags:
+      - "handle"
+      summary: "API for deleting an xapp subscription"
+      description: "By performing the delete operation on xapp-subscription-handle resource, the API caller will be able to update routing manager about the deletion of an xapp's subscription"
+      operationId: "delete_xapp_subscription_handle"
+      consumes:
+      - "application/json"
+      parameters:
+      - in: "body"
+        name: "xapp-subscription-data"
+        description: "xApp related subscription data"
+        required: true
+        schema:
+          $ref: "#/definitions/xapp-subscription-data"
+      responses:
+        204:
+          description: "Content not found"
+        200:
+          description: "Xapp Subscription deleted"
+  /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"
@@ -139,8 +196,7 @@ definitions:
     type: "object"
     properties:
       id:
-        type: "integer"
-        format: "int64"
+        type: "string"
       event:
         type: "string"
       version:
@@ -164,9 +220,27 @@ definitions:
         maximum: 65535
       subscription_id: #subscription sequence number
         type: "integer"
-        format: "int16" 
+        format: "int32"
+  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"
 
+