X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=o2ims%2Fviews%2Falarm_route.py;h=4f0b15c1e80dc9882f6ccbf6465555c75b1192a7;hb=02f067858baaa32bce3fc65109c8db3b3927dd85;hp=8b03880f086d0a5236f44663ce124630f1afbe47;hpb=4e221e2f91b6a960e31befcf3aa24a1b4e065afc;p=pti%2Fo2.git diff --git a/o2ims/views/alarm_route.py b/o2ims/views/alarm_route.py index 8b03880..4f0b15c 100644 --- a/o2ims/views/alarm_route.py +++ b/o2ims/views/alarm_route.py @@ -17,7 +17,8 @@ from flask_restx import Resource, reqparse from o2common.service.messagebus import MessageBus from o2common.views.pagination_route import link_header, PAGE_PARAM -from o2common.views.route_exception import NotFoundException +from o2common.views.route_exception import NotFoundException, \ + BadRequestException from o2ims.views import alarm_view from o2ims.views.api_ns import api_ims_monitoring as api_monitoring_v1 from o2ims.views.alarm_dto import AlarmDTO, SubscriptionDTO @@ -35,6 +36,7 @@ def configure_api_route(): # ---------- API versions ---------- # @api_monitoring_v1.route("/v1/api_versions") class VersionRouter(Resource): + @api_monitoring_v1.doc('Get Monitoring API version') def get(self): return { 'uriPrefix': request.base_url.rsplit('/', 1)[0], @@ -81,6 +83,7 @@ class AlarmListRouter(Resource): model = AlarmDTO.alarm_event_record_get + @api_monitoring_v1.doc('Get Alarm Event Record List') @api_monitoring_v1.marshal_list_with(model) def get(self): parser = reqparse.RequestParser() @@ -124,7 +127,7 @@ class AlarmGetRouter(Resource): model = AlarmDTO.alarm_event_record_get - @api_monitoring_v1.doc('Get AlarmEventRecord') + @api_monitoring_v1.doc('Get Alarm Event Record Information') @api_monitoring_v1.marshal_with(model) def get(self, alarmEventRecordId): result = alarm_view.alarm_event_record_one(alarmEventRecordId, bus.uow) @@ -139,10 +142,9 @@ class AlarmGetRouter(Resource): class SubscriptionsListRouter(Resource): model = SubscriptionDTO.subscription_get - expect = SubscriptionDTO.subscription - post_resp = SubscriptionDTO.subscription_post_resp + expect = SubscriptionDTO.subscription_create - @api_monitoring_v1.doc('List alarm subscriptions') + @api_monitoring_v1.doc('Get Alarm Subscription List') @api_monitoring_v1.marshal_list_with(model) @api_monitoring_v1.param( PAGE_PARAM, @@ -186,11 +188,17 @@ class SubscriptionsListRouter(Resource): 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.doc('Create a Alarm Subscription') @api_monitoring_v1.expect(expect) - @api_monitoring_v1.marshal_with(post_resp, code=201) + @api_monitoring_v1.marshal_with( + model, code=201, + mask='{alarmSubscriptionId,callback,consumerSubscriptionId,filter}') def post(self): data = api_monitoring_v1.payload + callback = data.get('callback', None) + if not callback: + raise BadRequestException('The callback parameter is required') + result = alarm_view.subscription_create(data, bus.uow) return result, 201 @@ -202,7 +210,7 @@ class SubscriptionGetDelRouter(Resource): model = SubscriptionDTO.subscription_get - @api_monitoring_v1.doc('Get Alarm Subscription by ID') + @api_monitoring_v1.doc('Get Alarm Subscription Information') @api_monitoring_v1.marshal_with(model) @api_monitoring_v1.param( 'all_fields', @@ -233,7 +241,7 @@ class SubscriptionGetDelRouter(Resource): raise NotFoundException( "Subscription {} doesn't exist".format(alarmSubscriptionID)) - @api_monitoring_v1.doc('Delete subscription by ID') + @api_monitoring_v1.doc('Delete an Alarm Subscription') @api_monitoring_v1.response(200, 'Subscription deleted') def delete(self, alarmSubscriptionID): result = alarm_view.subscription_delete(alarmSubscriptionID, bus.uow)