Merge "Document PAP policy notifications"

2 files changed, 31 insertions, 0 deletions

diff --git a/docs/pap/notification/dmaap-pap-notif.json b/docs/pap/notification/dmaap-pap-notif.json
new file mode 100644
index 00000000..bfe9162b
--- /dev/null
+++ b/docs/pap/notification/dmaap-pap-notif.json
@@ -0,0 +1,23 @@
+{
+    "deployed-policies": [
+        {
+            "policy-type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
+            "policy-type-version": "1.0.0",
+            "policy-id": "onap.scaleout.tca",
+            "policy-version": "2.0.0",
+            "success-count": 3,
+            "failure-count": 0
+        }
+    ],
+    "undeployed-policies": [
+        {
+            "policy-type": "onap.policies.firewall",
+            "policy-type-version": "1.0.0",
+            "policy-id": "onap.firewall.tca",
+            "policy-version": "6.0.0",
+            "success-count": 3,
+            "failure-count": 0
+        }
+    ]
+}
+
diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst
index 97bcb825..d061c815 100644
--- a/docs/pap/pap.rst
+++ b/docs/pap/pap.rst
@@ -81,6 +81,14 @@ in the following table are transmitted via DMaaP:
    "PDP update", "Outgoing", "Assigns a PDP to a PDP Group and Subgroup; also deploys or undeploys policies from the PDP"
    "PDP state change", "Outgoing", "Changes the state of a PDP or all PDPs within a PDP Group or Subgroup"
 
+In addition, PAP generates notifications via the DMaaP Message Router when policies are successfully or unsuccessfully
+deployed (or undeployed) from all relevant PDPs.
+
+Here is a sample notification:
+
+.. literalinclude:: notification/dmaap-pap-notif.json
+    :language: json
+
 
 2 PAP REST API Swagger
 ======================