X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=o2ims%2Fviews%2Falarm_route.py;h=e7a642564c648ed534fc010d3f872a2edc15f87a;hb=7e4e326be2e53db31632eff22168784b89d40de2;hp=11fad030da08847a5661612376a5069cf5f23654;hpb=debfbda4ecd836cb931b81d64b5fd579ac0d3f2a;p=pti%2Fo2.git diff --git a/o2ims/views/alarm_route.py b/o2ims/views/alarm_route.py index 11fad03..e7a6425 100644 --- a/o2ims/views/alarm_route.py +++ b/o2ims/views/alarm_route.py @@ -17,10 +17,12 @@ 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 +from o2ims.views.alarm_dto import AlarmDTO, SubscriptionDTO, \ + MonitoringApiV1DTO from o2common.helper import o2logging logger = o2logging.get_logger(__name__) @@ -35,6 +37,10 @@ def configure_api_route(): # ---------- API versions ---------- # @api_monitoring_v1.route("/v1/api_versions") class VersionRouter(Resource): + model = MonitoringApiV1DTO.api_version_info_get + + @api_monitoring_v1.doc('Get Monitoring API version') + @api_monitoring_v1.marshal_list_with(model) def get(self): return { 'uriPrefix': request.base_url.rsplit('/', 1)[0], @@ -81,6 +87,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 +131,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) @@ -141,7 +148,7 @@ class SubscriptionsListRouter(Resource): model = SubscriptionDTO.subscription_get 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, @@ -185,13 +192,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( 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 @@ -203,7 +214,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', @@ -234,7 +245,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)