Introduce 'qosStatus' and corresponding notification event to fix issue #38

code/API_definitions/qod-api.yaml

@@ -8,7 +8,7 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.8.0
+  version: 0.9.0
 externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/
@@ -224,6 +224,7 @@ components:
             - duration
             - startedAt
             - expiresAt
+            - qosStatus
           properties:
             id:
               $ref: "#/components/schemas/SessionId"
@@ -237,6 +238,8 @@ components:
               example: 1639566000
               description: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch
               format: int64
+            qosStatus:
+              $ref: "#/components/schemas/QosStatus"
             messages:
               type: array
               items:
@@ -325,20 +328,54 @@ components:
         * `QOS_S` - Qualifier for the requested QoS profile _S_
         * `QOS_M` - Qualifier for the requested QoS profile _M_
         * `QOS_L` - Qualifier for the requested QoS profile _L_
+
     Notification:
       type: object
       required:
         - sessionId
-        - event
+        - eventReports
       properties:
         sessionId:
           $ref: "#/components/schemas/SessionId"
+        eventReports:
+          type: array
+          items:
+            $ref: "#/components/schemas/EventReport"
+          minItems: 1
+          description: Contains the reported event and applicable information
+
+    EventReport:
+      type: object
+      required:
+        - event
+      properties:
         event:
           $ref: "#/components/schemas/SessionEvent"
+      discriminator:
+        propertyName: event
+        mapping:
+          QOS_STATUS_CHANGED: QosStatusChangedEventReport
+
+    QosStatusChangedEventReport:
+      allOf:
+        - $ref: '#/components/schemas/EventReport'
+        - type: object
+          required:
+            - qosStatus
+          properties:
+            qoStatus:
+              $ref: "#/components/schemas/QosStatus"
+            eventInfo:
+              type: string
+              enum:
+                - DURATION_EXPIRED
+                - NETWORK_TERMINATED
+
     SessionEvent:
       type: string
       enum:
-        - SESSION_TERMINATED
+        - QOS_STATUS_CHANGED
+
     ErrorInfo:
       type: object
       required:
@@ -419,6 +456,18 @@ components:
       required:
         - severity
         - description
+
+    QosStatus:
+      type: string
+      enum:
+        - REQUESTED
+        - AVAILABLE
+        - UNAVAILABLE
+      description: |
+        * `REQUESTED` - QoS has been requested by creating a session
+        * `AVAILABLE` - The requested QoS has been provided by the network
+        * `UNAVAILABLE` - The requested QoS cannot be provided by the network due to some reason
+
   responses:
     Generic400:
       description: Invalid input