openstack/ironic
Code Issues Proposed changes

Notification event types have status 'error'

Browse Source 
Fixes the documentation to indicate that the notification
event types can have status 'error'. 'fail' is incorrect.
(11fcf6b710/ironic/objects/notification.py (L48))

Change-Id: I13c3f40430a4d7f8c07fdd9861b2d8712b8247a6
This commit is contained in:
Ruby Loo 2016-09-19 11:25:32 -04:00
parent 5259a8e245
commit 996fffb992
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/dev/notifications.rst
View File

@ -156,10 +156,10 @@ in the ironic notification base classes) and emit it::
When specifying the event_type, ``object`` will specify the object being acted When specifying the event_type, ``object`` will specify the object being acted
on, ``action`` will be a string describing what action is being performed on on, ``action`` will be a string describing what action is being performed on
that object, and ``status`` will be one of "start", "end", "fail", or that object, and ``status`` will be one of "start", "end", "error", or
"success". "start" and "end" are used to indicate when actions that are not "success". "start" and "end" are used to indicate when actions that are not
immediate begin and succeed. "success" is used to indicate when actions that immediate begin and succeed. "success" is used to indicate when actions that
are immediate succeed. "fail" is used to indicate when any type of action are immediate succeed. "error" is used to indicate when any type of action
fails, regardless of whether it's immediate or not. As a result of specifying fails, regardless of whether it's immediate or not. As a result of specifying
these parameters, event_type will be formatted as these parameters, event_type will be formatted as
``baremetal.<object>.<action>.<status>`` on the message bus. ``baremetal.<object>.<action>.<status>`` on the message bus.