src/SOL003/definitions/SOL003_def.yaml → src/SOL002/VNFFaultManagementNotification/definitions/SOL002VNFFaultManagementNotification_def.yaml

@@ -2,126 +2,135 @@
 # https://forge.etsi.org/etsi-forge-copyright-notice.txt
 
 definitions:
-  Alarm:
+  AlarmNotification:
     description: >
-      The alarm data type encapsulates information about an alarm.
+      This type represents an alarm notification about VNF faults.
+      This notification shall be triggered by the VNFM when:
+      * An alarm has been created.
+      * An alarm has been updated, e.g. if the severity of the alarm has
+        changed.
     type: object
     required:
       - id
-      - managedObjectId
-      - rootCauseFaultyResource
-      - alarmRaisedTime
-      - ackState
-      - perceivedSeverity
-      - eventTime
-      - eventType
-      - probableCause
-      - isRootCause
+      - notificationType
+      - subscriptionId
+      - timeStamp
+      - alarm
       - _links
     properties:
-      id: 
+      id:
+        description: >
+          Identifier of this notification. If a notification is sent multiple
+          times due to multiple subscriptions, the "id" attribute of all these
+          notifications shall have the same value.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
+      notificationType:
         description: >
-          Identifier of this Alarm information element.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
-      managedObjectId:
+          Discriminator for the different notification types. Shall be set to
+          "AlarmNotification" for this notification type.
+        type: string
+        enum:
+          - AlarmNotification
+      subscriptionId:
         description: >
-          Identifier of the affected VNF instance.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
-      rootCauseFaultyResource:
+          Identifier of the subscription that this notification relates to.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
+      timeStamp:
         description: >
-          The virtualised resources that are causing the VNF fault.
-        $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo"
-      alarmRaisedTime:
+          Date-time of the generation of the notification.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
+      alarm:
         description: >
-          Time stamp indicating when the alarm is raised by the managed
-          object.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
-      alarmChangedTime:
+          Information about an alarm including AlarmId, affected VNF
+          identifier, and FaultDetails.
+        $ref: "../../VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm"
+      _links:
         description: >
-          Time stamp indicating when the alarm was last changed. It shall be
-          present if the alarm has been updated.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
-      alarmClearedTime:
+          Links to resources related to this notification.
+        type: object
+        required:
+          - subscription
+        properties:
+          subscription:
+            description: >
+              Link to the related subscription.
+            $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
+
+  AlarmClearedNotification:
+    description: >
+      This type represents an alarm cleared notification about VNF faults.
+      The notification shall be triggered by the VNFM when an alarm has been
+      cleared.
+    type: object
+    required:
+      - id
+      - notificationType
+      - subscriptionId
+      - timeStamp
+      - alarmId
+      - alarmClearedTime
+      - _links
+    properties:
+      id:
         description: >
-          Time stamp indicating when the alarm was cleared. It shall be
-          present if the alarm has been cleared.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
-      ackState:
+          Identifier of this notification. If a notification is sent multiple
+          times due to multiple subscriptions, the "id" attribute of all these
+          notifications shall have the same value.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
+      notificationType:
         description: >
-          Acknowledgement state of the alarm. 
-          Permitted values:
-          * UNACKNOWLEDGED
-          * ACKNOWLEDGED.
+          Discriminator for the different notification types. Shall be set to
+          "AlarmClearedNotification" for this notification type.
         type: string
-        enum: 
-          - UNACKNOWLEDGED
-          - ACKNOWLEDGED
-      perceivedSeverity:
-        description: >
-          Perceived severity of the managed object failure.
-        $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
-      eventTime: 
+        enum:
+          - AlarmClearedNotification
+      subscriptionId:
         description: >
-          Time stamp indicating when the fault was observed.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
-      eventType:
+          Identifier of the subscription that this notification relates to.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
+      timeStamp:
         description: >
-          Type of event.
-        $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType"
-      faultType:
+          Date-time of the generation of the notification.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
+      alarmId:
         description: >
-          Additional information to clarify the type of the fault.
-        type: string
-      probableCause:
+          Alarm identifier.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
+      alarmClearedTime:
         description: >
-          Information about the probable cause of the fault.
-        type: string
-      isRootCause:
-        description: >
-          Attribute indicating if this fault is the root for other correlated
-          alarms. If TRUE, then the alarms listed in the attribute
-          CorrelatedAlarmId are caused by this fault.
-        type: boolean
-      correlatedAlarmIds:
-        description: >
-          List of identifiers of other alarms correlated to this fault.
-        type: array
-        items: 
-          $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
-      faultDetails:
-        description: >
-          Provides additional information about the fault.
-        type: array
-        items:
-          type: string
+          The time stamp indicating when the alarm was cleared.
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
       _links:
         description: >
-          Links for this resource.
+          Links to resources related to this notification.
         type: object
         required:
-          - self
+          - subscription
+          - alarm
         properties:
-          self:
+          subscription:
             description: >
-              URI of this resource.
-            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
-          objectInstance:
+              Link to the related subscription.
+            $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
+          alarm:
             description: >
-              Link to the resource representing the VNF instance to which the
-              notified alarm is correlated. Shall be present if the VNF
-              instance information is accessible as a resource.
-            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
+              Link to the resource that represents the related alarm.
+            $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
 
-  AlarmNotification:
+  AlarmListRebuiltNotification:
     description: >
-      This type represents an alarm notification about VNF faults.
+      This type represents a notification that the alarm list has been
+      rebuilt, e.g. if the VNFM detects its storage holding the alarm
+      list is corrupted.
+      The notification shall be triggered by the VNFM when the alarm list has
+      been rebuilt, e.g. because the VNFM has detected that its storage
+      holding the alarm list was corrupted.
     type: object
-    required: 
+    required:
       - id
       - notificationType
       - subscriptionId
       - timeStamp
-      - alarm
       - _links
     properties:
       id:
@@ -129,36 +138,35 @@ definitions:
           Identifier of this notification. If a notification is sent multiple
           times due to multiple subscriptions, the "id" attribute of all these
           notifications shall have the same value.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
       notificationType:
         description: >
           Discriminator for the different notification types. Shall be set to
-          "AlarmNotification" for this notification type.
+          "AlarmListRebuiltNotification" for this notification type.
         type: string
-        enum: 
-          - AlarmNotification
+        enum:
+          - AlarmListRebuiltNotification
       subscriptionId:
         description: >
           Identifier of the subscription that this notification relates to.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
       timeStamp:
         description: >
           Date-time of the generation of the notification.
-        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
-      alarm:
-        description: >
-          Information about an alarm including AlarmId, affected VNF
-          identifier, and FaultDetails.
-        $ref: "#/definitions/Alarm"
+        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
       _links:
         description: >
           Links to resources related to this notification.
         type: object
-        required: 
+        required:
           - subscription
-        properties: 
-          subscription: 
+          - alarms
+        properties:
+          subscription:
             description: >
               Link to the related subscription.
-            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
-  
\ No newline at end of file
+            $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
+          alarms:
+            description: >
+              Link to the alarm list, i.e. the "Alarms" resource.
+            $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
\ No newline at end of file

src/SOL002/VNFIndicator/definitions/VnfIndicatorNotificationsFilter_def.yaml

-definitions:
-
-  VnfIndicatorNotificationsFilter:
-    description: >
-      This type represents a subscription filter related to notifications about VNF indicator value changes.
-      At a particular nesting level in the filter structure, the following applies: 
-      All attributes shall match in order for the filter to match (logical "and" between different filter attributes).
-      If an attribute is an array, the attribute shall match if at least one of the values in the array matches
-      (logical "or" between the values of one filter attribute).
-    type: object
-    properties:
-      vnfInstanceSubscriptionFilter:
-        description: >
-          Filter criteria to select VNF instances about which to notify. This attribute shall not be included
-          when the VNFM sends a subscription request to a particular VNF instance.
-        $ref: 'VnfInstanceSubscriptionFilter_def.yaml#/definitions/VnfInstanceSubscriptionFilter'                  
-      indicatorIds:
-        description: >
-          Match particular VNF indicator identifiers. 
-        type: array
-        items:
-          $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd'
-        
-

src/SOL002/VNFIndicator/responses/VNFIndicator_resp.yaml

-responses:
-  409:
-    description: >
-      Another request is in progress that prohibits the fulfilment of
-      the current request, or the current resource state is inconsistent
-      with the request.
-    headers:
-      Content-Type:
-        description: The MIME type of the body of the response.
-        type: string
-        maximum: 1
-        minimum: 1
-      WWW-Authenticate:
-        description: >
-          Challenge if the corresponding HTTP request has not provided
-          authorization, or error details if the corresponding HTTP
-          request has provided an invalid authorization token.
-        type: string
-        maximum: 1
-        minimum: 0
-    schema:
-      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"