diff options
| author |   JosephKeenan <joseph.keenan@est.tech> | 2022-09-27 16:12:30 +0100 |
|---|---|---|
| committer | JosephKeenan <joseph.keenan@est.tech> | 2022-09-30 09:12:30 +0100 |
| commit | 52950bd82f680261458c082bd6d592fb4a14de12 (patch) | |
| tree | c480deee4b1d043975b4b88692a10c2f2f6d85bf /docs/cps-events.rst | |
| parent | ef0ddfc3e80ad3c2d7fdd884f83c739bf3a80734 (diff) | |
Async External Schema and related Read the doc
-updated cps-events to include schema and related information for async
operations
Issue-ID: CPS-1166
Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
Change-Id: I1d40b5dd650663c1089119a60304b0490dedb8e1
Diffstat (limited to 'docs/cps-events.rst')
| -rw-r--r-- | docs/cps-events.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/cps-events.rst b/docs/cps-events.rst index dce1a30feb..df37de3632 100644 --- 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 ================================ |