X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=o2ims%2Fviews%2Falarm_route.py;h=74b8b5fc8b29819d5c0016af700396af6754ee43;hb=refs%2Fchanges%2F30%2F9430%2F3;hp=28bfd5cb3f67d4fad0a1ae14b5988f823dbf9dc9;hpb=8f7352951c11d939bae11422c00c87dc1f1d2a85;p=pti%2Fo2.git diff --git a/o2ims/views/alarm_route.py b/o2ims/views/alarm_route.py index 28bfd5c..74b8b5f 100644 --- a/o2ims/views/alarm_route.py +++ b/o2ims/views/alarm_route.py @@ -18,7 +18,7 @@ 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.api_ns import api_ims_monitoring as api_monitoring_v1 from o2ims.views.alarm_dto import AlarmDTO, SubscriptionDTO from o2common.helper import o2logging @@ -31,8 +31,22 @@ def configure_api_route(): bus = MessageBus.get_instance() +# ---------- API versions ---------- # +@api_monitoring_v1.route("/v1/api_versions") +class VersionRouter(Resource): + def get(self): + return { + 'uriPrefix': request.base_url.rsplit('/', 1)[0], + 'apiVersions': [{ + 'version': '1.0.0', + # 'isDeprecated': 'False', + # 'retirementDate': '' + }] + } + + # ---------- Alarm Event Record ---------- # -@api_monitoring_v1.route("/alarms") +@api_monitoring_v1.route("/v1/alarms") @api_monitoring_v1.param(PAGE_PARAM, 'Page number of the results to fetch.' + ' Default: 1', @@ -44,13 +58,13 @@ def configure_api_route(): _in='query') @api_monitoring_v1.param( 'fields', - 'Set fields to show, split by comman, "/" for parent and children.' + + '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 comman, "/" for parent and ' + + 'Set fields to exclude showing, split by comma, "/" for parent and ' + 'children. Like "name,parent/children". This value will cover ' + '"exclude_default".', _in='query') @@ -58,6 +72,10 @@ def configure_api_route(): 'exclude_default', 'Exclude showing all default fields, Set "true" to enable.', _in='query') +@api_monitoring_v1.param( + 'filter', + 'Filter of the query.', + _in='query') class AlarmListRouter(Resource): model = AlarmDTO.alarm_event_record_get @@ -66,16 +84,18 @@ class AlarmListRouter(Resource): def get(self): 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/") +@api_monitoring_v1.route("/v1/alarms/") @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( @@ -85,13 +105,13 @@ class AlarmListRouter(Resource): _in='query') @api_monitoring_v1.param( 'fields', - 'Set fields to show, split by comman, "/" for parent and children.' + + '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 comman, "/" for parent and ' + + 'Set fields to exclude showing, split by comma, "/" for parent and ' + 'children. Like "name,parent/children". This value will cover ' + '"exclude_default".', _in='query') @@ -114,7 +134,7 @@ class AlarmGetRouter(Resource): # ---------- Alarm Subscriptions ---------- # -@api_monitoring_v1.route("/alarmSubscriptions") +@api_monitoring_v1.route("/v1/alarmSubscriptions") class SubscriptionsListRouter(Resource): model = SubscriptionDTO.subscription_get @@ -134,13 +154,13 @@ class SubscriptionsListRouter(Resource): _in='query') @api_monitoring_v1.param( 'fields', - 'Set fields to show, split by comman, "/" for parent and children.' + + '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 comman, "/" for parent and ' + + 'Set fields to exclude showing, split by comma, "/" for parent and ' + 'children. Like "name,parent/children". This value will cover ' + '"exclude_default".', _in='query') @@ -148,13 +168,19 @@ class SubscriptionsListRouter(Resource): 'exclude_default', 'Exclude showing all default fields, Set "true" to enable.', _in='query') + @api_monitoring_v1.param( + 'filter', + 'Filter of the query.', + _in='query') def get(self): 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) @@ -168,7 +194,7 @@ class SubscriptionsListRouter(Resource): return result, 201 -@api_monitoring_v1.route("/alarmSubscriptions/") +@api_monitoring_v1.route("/v1/alarmSubscriptions/") @api_monitoring_v1.param('alarmSubscriptionID', 'ID of the Alarm Subscription') @api_monitoring_v1.response(404, 'Alarm Subscription not found') class SubscriptionGetDelRouter(Resource): @@ -184,13 +210,13 @@ class SubscriptionGetDelRouter(Resource): _in='query') @api_monitoring_v1.param( 'fields', - 'Set fields to show, split by comman, "/" for parent and children.' + + '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 comman, "/" for parent and ' + + 'Set fields to exclude showing, split by comma, "/" for parent and ' + 'children. Like "name,parent/children". This value will cover ' + '"exclude_default".', _in='query')