Async External Schema and related Read the doc

[cps.git] / docs / cps-events.rst

diff --git a/docs/cps-events.rst b/docs/cps-events.rst
index 34b5a5f..df37de3 100644 (file)
--- a/docs/cps-events.rst
+++ b/docs/cps-events.rst
@@ -11,6 +11,45 @@ CPS Events
 CPS-NCMP
 ********
 
+Async events are triggered when a valid topic has been detected in a passthrough operation.
+
+:download:`NCMP request response event schema <schemas/ncmp-async-request-response-event-schema-v1.json>`
+
+Event header
+^^^^^^^^^^^^^
+
+.. code-block:: json
+
+    {
+        "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
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. 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"         : { ... }
+    }
+
+
 Lifecycle Management (LCM) Event
 ================================
 
@@ -19,11 +58,11 @@ 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:**
+  **3 possible event types:**
 
-       * Create
-       * Update
-       * Delete
+  * Create
+  * Update
+  * Delete
 
 LCM Event Schema
 ----------------
@@ -40,16 +79,16 @@ Events header
 
 .. 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": ....
-       }
+  {
+      "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
 ^^^^^^^^^^^^^^