docs/ncmp-async-events.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2023 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _asyncEvents:
   7
   8
   9 CPS Async Events
  10 ################
  11
  12 .. toctree::
  13    :maxdepth: 1
  14
  15 Introduction
  16 ============
  17
  18 Async events are triggered when a valid topic has been detected in a passthrough operation.
  19
  20 :download:`NCMP request response event schema <schemas/ncmp-async-request-response-event-schema-v1.json>`
  21
  22 Event header
  23 ^^^^^^^^^^^^
  24
  25 .. code-block:: json
  26
  27     {
  28         "eventId"               : "001",
  29         "eventCorrelationId"    : "cps-001",
  30         "eventTime"             : "2022-09-28T12:24:21.003+0000",
  31         "eventTarget"           : "test-topic",
  32         "eventType"             : "org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent",
  33         "eventSchema"           : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
  34         "forwarded-Event"       : { }
  35     }
  36
  37 Forwarded-Event Payload
  38 ^^^^^^^^^^^^^^^^^^^^^^^
  39
  40 .. code-block:: json
  41
  42     "Forwarded-Event": {
  43         "eventId"               : "002",
  44         "eventCorrelationId"    : "cps-001",
  45         "eventTime"             : "2022-09-28T12:24:18.340+0000",
  46         "eventTarget"           : "test-topic",
  47         "eventType"             : "org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent",
  48         "eventSchema"           : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
  49         "eventSource"           : "org.onap.cps.ncmp.dmi",
  50         "response-data-schema"  : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
  51         "response-status"       : "OK",
  52         "response-code"         : "200",
  53         "response-data"         : { }
  54     }