Get interface for subscriptions

[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 dbdfced..f5a6f57 100755 (executable)
--- a/api/xapp_rest_api.yaml
+++ b/api/xapp_rest_api.yaml
@@ -11,6 +11,21 @@ basePath: /ric/v1
 schemes:
   - http
 paths:
+  /subscriptions:
+    get:
+      summary: Returns list of subscriptions
+      tags:
+        - "query"
+      operationId: getAllSubscriptions
+      produces:
+        - application/json
+      responses:
+        '200':
+          description: successful query of subscriptions
+          schema:
+            $ref: '#/definitions/SubscriptionList'
+        '500':
+          description: Internal error
   /subscriptions/report:
     post:
       tags:
@@ -162,4 +177,20 @@ definitions:
       RequestorId:
         type: integer
       TBD:
-        type: string
\ No newline at end of file
+        type: string
+  SubscriptionData:
+    type: object
+    properties:
+      SubscriptionId:
+        type: integer
+      Meid:
+        type: string
+      Endpoint:
+        type: array
+        items:
+          type: string
+  SubscriptionList:
+    type: array
+    description: A list of subscriptions
+    items:
+       $ref: '#/definitions/SubscriptionData'
\ No newline at end of file