diff --git a/api-ref/source/api-ref-fm-v1-fault.rst b/api-ref/source/api-ref-fm-v1-fault.rst index aa39a394..a8628953 100644 --- a/api-ref/source/api-ref-fm-v1-fault.rst +++ b/api-ref/source/api-ref-fm-v1-fault.rst @@ -160,6 +160,7 @@ itemNotFound (404) :widths: 20, 20, 20, 60 "include_suppress (Optional)", "query", "xsd:boolean", "This optional parameter when set to true (include_suppress=true) specifies to include suppressed alarms in output." + "expand (Optional)", "query", "xsd:boolean", "This optional parameter when set to true (expand=true) specifies that the response should contains the same response parameters as when querying for a specific alarm." **Response parameters** @@ -386,6 +387,7 @@ itemNotFound (404) "alarms (Optional)", "query", "xsd:boolean", "This optional parameter when set to true (alarms=true) specifies that only alarm event log records should be returned." "logs (Optional)", "query", "xsd:boolean", "This optional parameter when set to true (logs=true) specifies that only customer log records should be returned." "include_suppress (Optional)", "query", "xsd:boolean", "This optional parameter when set to true (include_suppress=true) specifies to include suppressed alarms in output." + "expand (Optional)", "query", "xsd:boolean", "This optional parameter when set to true (expand=true) specifies that the response should contains the same response parameters as when querying for a specific event log." **Response parameters** diff --git a/fm-rest-api/centos/build_srpm.data b/fm-rest-api/centos/build_srpm.data index a8b255df..917b7c11 100644 --- a/fm-rest-api/centos/build_srpm.data +++ b/fm-rest-api/centos/build_srpm.data @@ -1,2 +1,2 @@ SRC_DIR="fm" -TIS_PATCH_VER=1 +TIS_PATCH_VER=2 diff --git a/fm-rest-api/fm/fm/api/controllers/v1/alarm.py b/fm-rest-api/fm/fm/api/controllers/v1/alarm.py index bd55bb8f..5c59c9ae 100644 --- a/fm-rest-api/fm/fm/api/controllers/v1/alarm.py +++ b/fm-rest-api/fm/fm/api/controllers/v1/alarm.py @@ -1,5 +1,5 @@ # -# Copyright (c) 2018 Wind River Systems, Inc. +# Copyright (c) 2018-2019 Wind River Systems, Inc. # # SPDX-License-Identifier: Apache-2.0 # @@ -276,9 +276,9 @@ class AlarmController(rest.RestController): sort_dir=sort_dir) @wsme_pecan.wsexpose(AlarmCollection, [Query], - types.uuid, int, wtypes.text, wtypes.text, bool) + types.uuid, int, wtypes.text, wtypes.text, bool, bool) def get_all(self, q=[], marker=None, limit=None, sort_key='id', - sort_dir='asc', include_suppress=False): + sort_dir='asc', include_suppress=False, expand=False): """Retrieve a list of alarm. :param marker: pagination marker for large data sets. @@ -286,9 +286,11 @@ class AlarmController(rest.RestController): :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param include_suppress: filter on suppressed alarms. Default: False + :param expand: filter for getting all the data of the alarm. + Default: False """ return self._get_alarm_collection(marker, limit, sort_key, - sort_dir, q=q, + sort_dir, expand=expand, q=q, include_suppress=include_suppress) @wsme_pecan.wsexpose(AlarmCollection, types.uuid, int, diff --git a/fm-rest-api/fm/fm/api/controllers/v1/event_log.py b/fm-rest-api/fm/fm/api/controllers/v1/event_log.py index 9f4a804f..d39a1e23 100644 --- a/fm-rest-api/fm/fm/api/controllers/v1/event_log.py +++ b/fm-rest-api/fm/fm/api/controllers/v1/event_log.py @@ -1,5 +1,5 @@ # -# Copyright (c) 2018 Wind River Systems, Inc. +# Copyright (c) 2018-2019 Wind River Systems, Inc. # # SPDX-License-Identifier: Apache-2.0 # @@ -237,10 +237,10 @@ class EventLogController(rest.RestController): @wsme_pecan.wsexpose(EventLogCollection, [Query], types.uuid, int, wtypes.text, wtypes.text, - bool, bool, bool) + bool, bool, bool, bool) def get_all(self, q=[], marker=None, limit=None, sort_key='timestamp', sort_dir='desc', alarms=False, logs=False, - include_suppress=False): + include_suppress=False, expand=False): """Retrieve a list of event_log. :param marker: pagination marker for large data sets. @@ -250,10 +250,12 @@ class EventLogController(rest.RestController): :param alarms: filter on alarms. Default: False :param logs: filter on logs. Default: False :param include_suppress: filter on suppressed alarms. Default: False + :param expand: filter for getting all the data of the event. + Default: False """ return self._get_eventlog_collection(marker, limit, sort_key, - sort_dir, q=q, alarms=alarms, - logs=logs, + sort_dir, expand=expand, q=q, + alarms=alarms, logs=logs, include_suppress=include_suppress) @wsme_pecan.wsexpose(EventLogCollection, types.uuid, int, diff --git a/python-fmclient/centos/build_srpm.data b/python-fmclient/centos/build_srpm.data index ac0082f8..58d7aee2 100644 --- a/python-fmclient/centos/build_srpm.data +++ b/python-fmclient/centos/build_srpm.data @@ -1,2 +1,2 @@ SRC_DIR="fmclient" -TIS_PATCH_VER=1 +TIS_PATCH_VER=2 diff --git a/python-fmclient/fmclient/fmclient/v1/alarm.py b/python-fmclient/fmclient/fmclient/v1/alarm.py index 2177af18..4dad79b5 100755 --- a/python-fmclient/fmclient/fmclient/v1/alarm.py +++ b/python-fmclient/fmclient/fmclient/v1/alarm.py @@ -1,5 +1,5 @@ # -# Copyright (c) 2018 Wind River Systems, Inc. +# Copyright (c) 2018-2019 Wind River Systems, Inc. # # SPDX-License-Identifier: Apache-2.0 # @@ -21,11 +21,13 @@ class AlarmManager(base.Manager): return '/v1/alarms/%s' % id if id else '/v1/alarms' def list(self, q=None, limit=None, marker=None, sort_key=None, - sort_dir=None, include_suppress=False): + sort_dir=None, include_suppress=False, expand=False): params = [] if include_suppress: params.append('include_suppress=True') + if expand: + params.append('expand=True') if limit: params.append('limit=%s' % str(limit)) if marker: diff --git a/python-fmclient/fmclient/fmclient/v1/event_log.py b/python-fmclient/fmclient/fmclient/v1/event_log.py index 22357af7..67dac78f 100644 --- a/python-fmclient/fmclient/fmclient/v1/event_log.py +++ b/python-fmclient/fmclient/fmclient/v1/event_log.py @@ -1,5 +1,5 @@ # -# Copyright (c) 2018 Wind River Systems, Inc. +# Copyright (c) 2018-2019 Wind River Systems, Inc. # # SPDX-License-Identifier: Apache-2.0 # @@ -21,7 +21,8 @@ class EventLogManager(base.Manager): def _path(id=None): return '/v1/event_log/%s' % id if id else '/v1/event_log' - def list(self, q=None, limit=None, marker=None, alarms=False, logs=False, include_suppress=False): + def list(self, q=None, limit=None, marker=None, alarms=False, logs=False, + include_suppress=False, expand=False): params = [] if limit: params.append('limit=%s' % str(limit)) @@ -29,6 +30,8 @@ class EventLogManager(base.Manager): params.append('marker=%s' % str(marker)) if include_suppress: params.append('include_suppress=True') + if expand: + params.append('expand=True') if alarms is True and logs is False: params.append('alarms=True') elif alarms is False and logs is True: