From 8060878b5ba944dbd611565faf044edfd130a3dd Mon Sep 17 00:00:00 2001
From: Mark McLoughlin <markmc@redhat.com>
Date: Mon, 3 Mar 2014 09:43:21 -0800
Subject: [PATCH] notify listener: document the metadata callback parameter

Add some details about what the metadata parameter contains.

Change-Id: I191c1c480c679534c1dede9aa85c51615faf0800
---
 oslo/messaging/notify/listener.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/oslo/messaging/notify/listener.py b/oslo/messaging/notify/listener.py
index 017f797f3..255c52c8a 100644
--- a/oslo/messaging/notify/listener.py
+++ b/oslo/messaging/notify/listener.py
@@ -71,7 +71,9 @@ in one of the targets and if an endpoint implements the method named like the
 priority
 
 Parameters to endpoint methods are the request context supplied by the client,
-the publisher_id of the notification message, the event_type, the payload.
+the publisher_id of the notification message, the event_type, the payload and
+metadata. The metadata parameter is a mapping containing a unique message_id
+and a timestamp.
 
 An endpoint method can return explicitly messaging.NotificationResult.HANDLED
 to acknowledge a message or messaging.NotificationResult.REQUEUE to requeue the