New alarm library v0.5.0

[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 373fc7a..e229422 100755 (executable)
--- a/api/xapp_rest_api.yaml
+++ b/api/xapp_rest_api.yaml
@@ -11,6 +11,21 @@ basePath: /ric/v1
 schemes:
   - http
 paths:
+  /config:
+    get:
+      summary: Returns the configuration of all xapps
+      tags:
+        - xapp
+      operationId: getXappConfigList
+      produces:
+        - application/json
+      responses:
+        '200':
+          description: successful query of xApp config
+          schema:
+            $ref: '#/definitions/XappConfigList'
+        '500':
+          description: Internal error
   /subscriptions:
     get:
       summary: Returns list of subscriptions
@@ -82,6 +97,10 @@ paths:
       - "common"
       summary: Unsubscribe X2AP events from Subscription Manager
       operationId: Unsubscribe
+      consumes:
+        - application/json
+      produces:
+        - application/json
       parameters:
         - name: subscriptionId
           in: path
@@ -96,6 +115,21 @@ paths:
         '500':
           description: Internal error
 definitions:
+  XAppConfig:
+    type: object
+    required:
+      - metadata
+      - config
+    properties:
+      metadata:
+        $ref: '#/definitions/ConfigMetadata'
+      config:
+        type: object
+        description: Configuration in JSON format
+  XappConfigList:
+    type: array
+    items:
+      $ref: '#/definitions/XAppConfig'
   SubscriptionType:
     type: string
     enum:
@@ -242,23 +276,28 @@ definitions:
         type: integer
       PolicyParameterValue:
         type: integer
-  SubscriptionResponseItem:
+  SubscriptionInstance:
     type: object
     required:
-      - SubscriptionId
       - RequestorId
       - InstanceId
     properties:
-      SubscriptionId:
-        type: string
       RequestorId:
         type: integer
       InstanceId:
         type: integer
   SubscriptionResponse:
-    type: array
-    items:
-      $ref: '#/definitions/SubscriptionResponseItem'
+    type: object
+    required:
+      - SubscriptionId
+      - SubscriptionInstances
+    properties:
+      SubscriptionId:
+        type: string
+      SubscriptionInstances:
+        type: array
+        items:
+          $ref: '#/definitions/SubscriptionInstance'
   SubscriptionData:
     type: object
     properties: