diff options
| author |   sourabh_sourabh <sourabh.sourabh@est.tech> | 2023-07-25 10:58:52 +0100 |
|---|---|---|
| committer | sourabh_sourabh <sourabh.sourabh@est.tech> | 2023-07-27 13:32:59 +0100 |
| commit | 9a76aa39090d0bcbbc41e78c80c2769aa1c5f6d1 (patch) | |
| tree | 1869f590dd1c915a66b09286ed90e13dded971b1 /docs/data-operation-events.rst | |
| parent | 0eb490aaf48c2abe1f9d911f080bf14692968d80 (diff) | |
Update RTD (CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation)
- Added information about data operation NCMP endpoint and kafka event
details.
- Re-structured "CPS-Events" and "Modeling" page.
Issue-ID:CPS-1785
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Change-Id: I2b077ccd7ccd6144a8f9f2183d927f922075f532
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Diffstat (limited to 'docs/data-operation-events.rst')
| -rw-r--r-- | docs/data-operation-events.rst | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/data-operation-events.rst b/docs/data-operation-events.rst new file mode 100644 index 0000000000..51ec1254af --- /dev/null +++ b/docs/data-operation-events.rst @@ -0,0 +1,64 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2023 Nordix Foundation + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING +.. _dataOperationEvents: + +CPS-NCMP Data Operations Events +############################### + +These events are based on the cloud events standard which is a specification for describing event data in common formats to provide interoperability across services, platforms and systems. + +Please refer to the `cloud events <https://cloudevents.io/>`_ for more details. + +Data operation response events +****************************** + +:download:`Data operation event schema <schemas/data-operation-event-schema-1.0.0.json>` + +Event headers example +^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: json + + { + "specversion": "1.0", + "id": "77b8f114-4562-4069-8234-6d059ff742ac", + "type": "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent", + "source": "DMI", + "dataschema": "urn:cps:org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent:1.0.0", + "time": "2020-12-01T00:00:00.000+0000", + "content-type": "application/json", + "data": "{some-key:some-value}", + "correlationid": "6ea5cb30ecfd4a938de36fdc07a5008f", + "destination": "client-topic" + } + +Data operation event headers +============================ + + +----------------+-----------------+------------------------------------------------------------------------+ + | Field name | Mandatory | Description | + +================+=================+========================================================================+ + | specversion | Yes | default : 1.0 | + +----------------+-----------------+------------------------------------------------------------------------+ + | id | Yes | UUID | + +----------------+-----------------+------------------------------------------------------------------------+ + | type | Yes | org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent | + +----------------+-----------------+------------------------------------------------------------------------+ + | source | Yes | NCMP / DMI | + +----------------+-----------------+------------------------------------------------------------------------+ + | dataschema | No | `urn:cps:org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent:1.0.0` | + +----------------+-----------------+------------------------------------------------------------------------+ + | time | No | ISO_TIMESTAMP_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSZ" | + +----------------+-----------------+------------------------------------------------------------------------+ + | content-type | No | default : application/json | + +----------------+-----------------+------------------------------------------------------------------------+ + | data | Yes | actual event/payload now would be under "data" field. | + +----------------+-----------------+------------------------------------------------------------------------+ + | correlationid | Yes | request id | + +----------------+-----------------+------------------------------------------------------------------------+ + | destination | Yes | client topic | + +----------------+-----------------+------------------------------------------------------------------------+ + |