from o2common.service.messagebus import MessageBus
from o2common.views.pagination_route import link_header, PAGE_PARAM
+from o2common.views.route_exception import NotFoundException, \
+ BadRequestException
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
bus = MessageBus.get_instance()
+# ---------- 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],
+ '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',
_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')
'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
+ @api_monitoring_v1.doc('Get Alarm Event Record List')
@api_monitoring_v1.marshal_list_with(model)
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/<alarmEventRecordId>")
+@api_monitoring_v1.route("/v1/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(
_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')
model = AlarmDTO.alarm_event_record_get
- @api_monitoring_v1.doc('Get resource type')
+ @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)
if result is not None:
return result
- api_monitoring_v1.abort(
- 404, "Resource type {} doesn't exist".format(alarmEventRecordId))
+ raise NotFoundException(
+ "Alarm Event Record {} doesn't exist".format(alarmEventRecordId))
# ---------- Alarm Subscriptions ---------- #
-@api_monitoring_v1.route("/alarmSubscriptions")
+@api_monitoring_v1.route("/v1/alarmSubscriptions")
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,
_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')
'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)
- @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
-@api_monitoring_v1.route("/alarmSubscriptions/<alarmSubscriptionID>")
+@api_monitoring_v1.route("/v1/alarmSubscriptions/<alarmSubscriptionID>")
@api_monitoring_v1.param('alarmSubscriptionID', 'ID of the Alarm Subscription')
@api_monitoring_v1.response(404, 'Alarm Subscription not found')
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',
_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')
alarmSubscriptionID, bus.uow)
if result is not None:
return result
- api_monitoring_v1.abort(404, "Subscription {} doesn't exist".format(
- alarmSubscriptionID))
+ raise NotFoundException(
+ "Subscription {} doesn't exist".format(alarmSubscriptionID))
- @api_monitoring_v1.doc('Delete subscription by ID')
- @api_monitoring_v1.response(204, 'Subscription deleted')
+ @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)
- return result, 204
+ return result, 200