Add INF-320 support attribute-based filter

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

diff --git a/o2ims/views/alarm_route.py b/o2ims/views/alarm_route.py
index 91ca8f8..21fed6d 100644 (file)
--- a/o2ims/views/alarm_route.py
+++ b/o2ims/views/alarm_route.py
@@ -12,9 +12,11 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-from flask_restx import Resource
+from flask import request
+from flask_restx import Resource, reqparse
 
 from o2common.service.messagebus import MessageBus
+from o2common.views.pagination_route import link_header, PAGE_PARAM
 from o2ims.views import alarm_view
 from o2ims.views.api_ns import api_monitoring_v1
 from o2ims.views.alarm_dto import AlarmDTO, SubscriptionDTO
@@ -31,18 +33,78 @@ def configure_api_route():
 
 # ----------  Alarm Event Record ---------- #
 @api_monitoring_v1.route("/alarms")
+@api_monitoring_v1.param(PAGE_PARAM,
+                         'Page number of the results to fetch.' +
+                         ' Default: 1',
+                         _in='query', default=1)
+@api_monitoring_v1.param(
+    'all_fields',
+    'Set any value for show all fields. This value will cover "fields" ' +
+    'and "all_fields".',
+    _in='query')
+@api_monitoring_v1.param(
+    'fields',
+    'Set fields to show, split by comma, "/" for parent and children.' +
+    ' Like "name,parent/children". This value will cover' +
+    ' "exculde_fields".',
+    _in='query')
+@api_monitoring_v1.param(
+    'exclude_fields',
+    'Set fields to exclude showing, split by comma, "/" for parent and ' +
+    'children. Like "name,parent/children". This value will cover ' +
+    '"exclude_default".',
+    _in='query')
+@api_monitoring_v1.param(
+    'exclude_default',
+    'Exclude showing all default fields, Set "true" to enable.',
+    _in='query')
+@api_monitoring_v1.param(
+    'exclude_default',
+    'Exclude showing all default fields, Set "true" to enable.',
+    _in='query')
 class AlarmListRouter(Resource):
 
     model = AlarmDTO.alarm_event_record_get
 
     @api_monitoring_v1.marshal_list_with(model)
     def get(self):
-        return alarm_view.alarm_event_records(bus.uow)
+        parser = reqparse.RequestParser()
+        parser.add_argument(PAGE_PARAM, location='args')
+        parser.add_argument('filter', location='args')
+        args = parser.parse_args()
+        kwargs = {}
+        if args.nextpage_opaque_marker is not None:
+            kwargs['page'] = args.nextpage_opaque_marker
+        kwargs['filter'] = args.filter if args.filter is not None else ''
+
+        ret = alarm_view.alarm_event_records(bus.uow, **kwargs)
+        return link_header(request.full_path, ret)
 
 
 @api_monitoring_v1.route("/alarms/<alarmEventRecordId>")
 @api_monitoring_v1.param('alarmEventRecordId', 'ID of the alarm event record')
 @api_monitoring_v1.response(404, 'Alarm Event Record not found')
+@api_monitoring_v1.param(
+    'all_fields',
+    'Set any value for show all fields. This value will cover "fields" ' +
+    'and "all_fields".',
+    _in='query')
+@api_monitoring_v1.param(
+    'fields',
+    'Set fields to show, split by comma, "/" for parent and children.' +
+    ' Like "name,parent/children". This value will cover' +
+    ' "exculde_fields".',
+    _in='query')
+@api_monitoring_v1.param(
+    'exclude_fields',
+    'Set fields to exclude showing, split by comma, "/" for parent and ' +
+    'children. Like "name,parent/children". This value will cover ' +
+    '"exclude_default".',
+    _in='query')
+@api_monitoring_v1.param(
+    'exclude_default',
+    'Exclude showing all default fields, Set "true" to enable.',
+    _in='query')
 class AlarmGetRouter(Resource):
 
     model = AlarmDTO.alarm_event_record_get
@@ -67,8 +129,47 @@ class SubscriptionsListRouter(Resource):
 
     @api_monitoring_v1.doc('List alarm subscriptions')
     @api_monitoring_v1.marshal_list_with(model)
+    @api_monitoring_v1.param(
+        PAGE_PARAM,
+        'Page number of the results to fetch. Default: 1',
+        _in='query', default=1)
+    @api_monitoring_v1.param(
+        'all_fields',
+        'Set any value for show all fields. This value will cover "fields" ' +
+        'and "all_fields".',
+        _in='query')
+    @api_monitoring_v1.param(
+        'fields',
+        'Set fields to show, split by comma, "/" for parent and children.' +
+        ' Like "name,parent/children". This value will cover' +
+        ' "exculde_fields".',
+        _in='query')
+    @api_monitoring_v1.param(
+        'exclude_fields',
+        'Set fields to exclude showing, split by comma, "/" for parent and ' +
+        'children. Like "name,parent/children". This value will cover ' +
+        '"exclude_default".',
+        _in='query')
+    @api_monitoring_v1.param(
+        'exclude_default',
+        'Exclude showing all default fields, Set "true" to enable.',
+        _in='query')
+    @api_monitoring_v1.param(
+        'exclude_default',
+        'Exclude showing all default fields, Set "true" to enable.',
+        _in='query')
     def get(self):
-        return alarm_view.subscriptions(bus.uow)
+        parser = reqparse.RequestParser()
+        parser.add_argument(PAGE_PARAM, location='args')
+        parser.add_argument('filter', location='args')
+        args = parser.parse_args()
+        kwargs = {}
+        if args.nextpage_opaque_marker is not None:
+            kwargs['page'] = args.nextpage_opaque_marker
+        kwargs['filter'] = args.filter if args.filter is not None else ''
+
+        ret = alarm_view.subscriptions(bus.uow, **kwargs)
+        return link_header(request.full_path, ret)
 
     @api_monitoring_v1.doc('Create a alarm subscription')
     @api_monitoring_v1.expect(expect)
@@ -88,6 +189,27 @@ class SubscriptionGetDelRouter(Resource):
 
     @api_monitoring_v1.doc('Get Alarm Subscription by ID')
     @api_monitoring_v1.marshal_with(model)
+    @api_monitoring_v1.param(
+        'all_fields',
+        'Set any value for show all fields. This value will cover "fields" ' +
+        'and "all_fields".',
+        _in='query')
+    @api_monitoring_v1.param(
+        'fields',
+        'Set fields to show, split by comma, "/" for parent and children.' +
+        ' Like "name,parent/children". This value will cover' +
+        ' "exculde_fields".',
+        _in='query')
+    @api_monitoring_v1.param(
+        'exclude_fields',
+        'Set fields to exclude showing, split by comma, "/" for parent and ' +
+        'children. Like "name,parent/children". This value will cover ' +
+        '"exclude_default".',
+        _in='query')
+    @api_monitoring_v1.param(
+        'exclude_default',
+        'Exclude showing all default fields, Set "true" to enable.',
+        _in='query')
     def get(self, alarmSubscriptionID):
         result = alarm_view.subscription_one(
             alarmSubscriptionID, bus.uow)