From d1e3496716eda0135a3e85913570c0baf2f7c208 Mon Sep 17 00:00:00 2001
From: Dolph Mathews <dolph.mathews@gmail.com>
Date: Fri, 30 Aug 2013 07:28:54 -0500
Subject: [PATCH] add 'project' notifications to docs

In addition to adding a mention about 'project' notifications, I rewrote
a few bits of the notifications docs to make it easier to add new
resource types as we implement them (you only have to add them to the
list, rather than revising a bunch of disparate paragraphs).

blueprint notifications

Change-Id: I4792e5dd368d5404c252d6c7c8dc8813af7509d8
---
 doc/source/event_notifications.rst | 64 +++++++++++++++++-------------
 1 file changed, 37 insertions(+), 27 deletions(-)

diff --git a/doc/source/event_notifications.rst b/doc/source/event_notifications.rst
index 99b47c505b..835131c1f0 100644
--- a/doc/source/event_notifications.rst
+++ b/doc/source/event_notifications.rst
@@ -23,40 +23,50 @@ can use the data for billing, monitoring, or quota purposes.  This document
 describes the current inclusions and exclusions for Keystone usage
 notifications.
 
+Notifications for Create/Update/Delete Events
+=============================================
 
-Create/Delete/Update User
-=========================
+A notification is sent when a resource is successfully ``created``,
+``updated``, or ``deleted``. The following resource types (where a
+``<resource type>`` is always a singular noun) produce notifications:
 
-One notification is sent when a user
-is successfully created, deleted, or updated.
+- ``user``
+- ``project`` (i.e. "tenant")
 
-The following message is sent when create user finishes::
+The following message template is used to form a message when an operation on a
+resource completes successfully::
 
- {"event_type": "identity.user.created",
-  "message_id": "<message ID>",
-  "publisher_id": "identity.<hostname>",
-  "timestamp": "<timestamp>",
-  "priority": "INFO",
-  "payload":
-   {"resource_info": "<resource ID>"}}
+    {
+        "event_type": "identity.<resource type>.<operation>",
+        "message_id": "<message ID>",
+        "payload": {
+            "resource_info": "<resource ID>"
+        },
+        "priority": "INFO",
+        "publisher_id": "identity.<hostname>",
+        "timestamp": "<timestamp>"
+    }
 
-Notifications for deletes and updates are similar to those for creates, with
-``deleted`` or ``updated`` replacing ``created`` in the above notification.
-
-If the operation fails, the notification won't be sent, and no special
-error notification will be sent.  Information about the error is handled
-through normal exception paths.
+Notifications for create, update and delete events are all similar to each
+other, where either ``created``, ``updated`` or ``deleted`` is inserted as the
+``<operation>`` in the above notification's ``event_type``.
 
+If the operation fails, the notification won't be sent, and no special error
+notification will be sent.  Information about the error is handled through
+normal exception paths.
 
 Notification Example
-====================
+^^^^^^^^^^^^^^^^^^^^
 
-This is an example of a notification sent for user creation::
+This is an example of a notification sent for a newly created user::
 
- {"event_type": "identity.user.created",
-  "message_id": "0156ee79-b35f-4cef-ac37-d4a85f231c69",
-  "publisher_id": "identity.host1234",
-  "timestamp": "2013-08-29 19:03:45.960280",
-  "priority": "INFO",
-  "payload":
-   {"resource_info": "671da331c47d4e29bb6ea1d270154ec3"}}
+    {
+        "event_type": "identity.user.created",
+        "message_id": "0156ee79-b35f-4cef-ac37-d4a85f231c69",
+        "payload": {
+            "resource_info": "671da331c47d4e29bb6ea1d270154ec3"
+        },
+        "priority": "INFO",
+        "publisher_id": "identity.host1234",
+        "timestamp": "2013-08-29 19:03:45.960280"
+    }