Docs: update API example of O-Cloud and resourcePool

[pti/o2.git] / o2ims / views / alarm_dto.py

diff --git a/o2ims/views/alarm_dto.py b/o2ims/views/alarm_dto.py
index da95a55..f4aac49 100644 (file)
--- a/o2ims/views/alarm_dto.py
+++ b/o2ims/views/alarm_dto.py
@@ -14,6 +14,7 @@
 
 from flask_restx import fields
 
+from o2common.views.flask_restx_fields import Json2Dict
 from o2ims.views.api_ns import api_ims_monitoring as api_monitoring_v1
 
 
@@ -24,13 +25,27 @@ class AlarmDTO:
         {
             'alarmEventRecordId': fields.String(
                 required=True,
+                example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
                 description='Alarm Event Record ID'),
             'resourceTypeId': fields.String,
+            'resourceTypeID': fields.String(attribute='resourceTypeId'),
             'resourceId': fields.String,
+            'resourceID': fields.String(attribute='resourceId'),
             'alarmDefinitionId': fields.String,
+            'alarmDefinitionID': fields.String(attribute='alarmDefinitionId'),
+            'probableCauseId': fields.String,
+            'probableCauseID': fields.String(attribute='probableCauseId'),
             'alarmRaisedTime': fields.String,
+            'alarmChangedTime': fields.String,
+            'alarmAcknowledgeTime': fields.String,
+            'alarmAcknowledged': fields.Boolean,
             'perceivedSeverity': fields.String,
+            'extensions': Json2Dict(attribute='extensions')
         }
+        # mask='{alarmEventRecordId,resourceTypeID,resourceID,' +
+        # 'alarmDefinitionID,probableCauseID,' +
+        # 'alarmRaisedTime,perceivedSeverity,alarmChangedTime,' +
+        # 'alarmAcknowledgeTime,alarmAcknowledged,extensions}'
     )
 
 
@@ -45,10 +60,11 @@ class SubscriptionDTO:
             'callback': fields.String,
             'consumerSubscriptionId': fields.String,
             'filter': fields.String,
-        }
+        },
+        mask='{alarmSubscriptionId,callback}'
     )
 
-    subscription = api_monitoring_v1.model(
+    subscription_create = api_monitoring_v1.model(
         "AlarmSubscriptionCreateDto",
         {
             'callback': fields.String(
@@ -58,12 +74,3 @@ class SubscriptionDTO:
             'filter': fields.String,
         }
     )
-
-    subscription_post_resp = api_monitoring_v1.model(
-        "AlarmSubscriptionCreatedRespDto",
-        {
-            'alarmSubscriptionId': fields.String(
-                required=True,
-                description='Alarm Subscription ID'),
-        }
-    )