From 996fffb992f63194f27dc909cfecc05f3c071170 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Mon, 19 Sep 2016 11:25:32 -0400 Subject: [PATCH] Notification event types have status 'error' Fixes the documentation to indicate that the notification event types can have status 'error'. 'fail' is incorrect. (https://github.com/openstack/ironic/blob/11fcf6b710857f01f6b2a7b3fbed28caabba2594/ironic/objects/notification.py#L48) Change-Id: I13c3f40430a4d7f8c07fdd9861b2d8712b8247a6 --- doc/source/dev/notifications.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/dev/notifications.rst b/doc/source/dev/notifications.rst index aee82e5bf9..9f4f611953 100644 --- a/doc/source/dev/notifications.rst +++ b/doc/source/dev/notifications.rst @@ -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 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 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 these parameters, event_type will be formatted as ``baremetal...`` on the message bus.