X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fcps-events.rst;h=d487018e4f6d6ab8ccd1bfc55aa3283b74b8b9a8;hb=ce880216ec85aa12c1fda23c3abaf4bd16d9595d;hp=a28d4b05299ae932eb06965ca57089af0c0852e8;hpb=7a75eea4e388a04d8b67610ef53ed16db75489e6;p=cps.git

diff --git a/docs/cps-events.rst b/docs/cps-events.rst
index a28d4b052..d487018e4 100644
--- a/docs/cps-events.rst
+++ b/docs/cps-events.rst
@@ -8,39 +8,61 @@
 CPS Events
 ##########
 
-CPS Core
+CPS-NCMP
 ********
-..
-   Cps core events yet to be written
 
+Async events are triggered when a valid topic has been detected in a passthrough operation.
 
-CPS-NCMP
-********
+:download:`NCMP request response event schema <schemas/ncmp-async-request-response-event-schema-v1.json>`
 
-Lifecycle Management (LCM) Event
-================================
+Event header
+^^^^^^^^^^^^^
 
+.. code-block:: json
 
-Overview
---------
-Lifecycle management events are published as cm handle state transitions from one state to another.
+    {
+        "eventId"               : "001",
+        "eventCorrelationId"    : "cps-001",
+        "eventTime"             : "2022-09-28T12:24:21.003+0000",
+        "eventTarget"           : "test-topic",
+        "eventType"             : "org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent",
+        "eventSchema"           : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
+        "forwarded-Event"       : { }
+    }
 
+Forwarded-Event Payload
+^^^^^^^^^^^^^^^^^^^^^^^
 
-LCM events and state handler
-----------------------------
-The LCM events are triggered under the state handler which has the following responsibilities:
+.. code-block:: json
+
+    "Forwarded-Event": {
+        "eventId"               : "002",
+        "eventCorrelationId"    : "cps-001",
+        "eventTime"             : "2022-09-28T12:24:18.340+0000",
+        "eventTarget"           : "test-topic",
+        "eventType"             : "org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent",
+        "eventSchema"           : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
+        "eventSource"           : "org.onap.cps.ncmp.dmi",
+        "response-data-schema"  : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
+        "response-status"       : "OK",
+        "response-code"         : "200",
+        "response-data"         : { }
+    }
 
-#. Updating and persisting cm handle state based on the target state of the cm handle
 
-#. Create and calls to publish the LCM event based on the cm handle state transition that occured
+Lifecycle Management (LCM) Event
+================================
 
-	**3 possible event types:**
 
-	* Create
-	* Update
-	* Delete
+Overview
+--------
+LCM events for CM Handles are published when a CM Handle is created, deleted or another change in the cm handle state occurs.
 
+  **3 possible event types:**
 
+  * Create
+  * Update
+  * Delete
 
 LCM Event Schema
 ----------------
@@ -55,18 +77,18 @@ Events header
 ^^^^^^^^^^^^^
 *Event header prototype for all event types*
 
-.. code-block:: json
-
-	{
-  		"eventId"                : "00001",
-  		"eventCorrelationId      : "cmhandle-001",
-  		"eventTime"              : "2021-11-16T16:42:25-04:00",
-  		"eventSource"            : "org.onap.ncmp",
-  		"eventType"              : "org.onap.ncmp.cmhandle-lcm-event.create",
-  		"eventSchema"            : "org.onap.ncmp:cmhandle-lcm-event",
-  		"eventSchemaVersion"	   : "1.0"
-  		"event": ....
-	}
+.. code-block::
+
+  {
+      "eventId"                : "00001",
+      "eventCorrelationId      : "cmhandle-001",
+      "eventTime"              : "2021-11-16T16:42:25-04:00",
+      "eventSource"            : "org.onap.ncmp",
+      "eventType"              : "org.onap.ncmp.cmhandle-lcm-event.create",
+      "eventSchema"            : "org.onap.ncmp:cmhandle-lcm-event",
+      "eventSchemaVersion"     : "1.0",
+      "event"                  : ...
+  }
 
 Events payload
 ^^^^^^^^^^^^^^