...
| Expand |
|---|
| title | NCMP Async Request Response Event |
|---|
|
NcmpAsyncRequestResponse Event Object| Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event generated by DMI | X |
|
| standard (id) | | eventCorrelationId | string | The request id passed by NCMP | X |
|
| extensions (correlationid) | | eventTime | string | The timestamp when original event occurred | X |
|
| standard (time) | | eventTarget | string | The target of the event | X |
|
| extensions (target) | | eventType | string | The type of the event | X |
|
| standard (type) | | source | string | The source of the event | X |
| NEW see decision #18, value 'ncmp' TBC | standard (source) | | eventSchema | string | The event schema for async request response events | X |
|
| standard (dataschema) | eventSchemaVersion | string | The event schema version for async request response events
| X |
|
| N/A included in 'dataschema' | | event | Event | The payload of an event |
| X | Defined by event object below | standard (data) | | forwardedEvent | ForwardedEvent | The payload of a forwarded event |
| X | Relation to Event field unclear, do we need 2 events at all see issue #7 | standard (data)
See new proposal below |
Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)| Field | Type | Description | Header | Payload | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
| X | Only in payload in v1 of the payload schema. To be removed in v2 version (will be in the header only) | | eventCorrelationId | string | The request id passed by NCMP |
| X | as above | | eventTime | string | The timestamp when original event occurred |
| X | as above | | eventTarget | string | The target of the event |
| X | as above | | eventType | string | The type of the event |
| X | as above | | eventSchema | string | The event schema for async request response events |
| X | as above | | eventSource | string | The source of the event |
| X | as above | | response-data-schema | string | The received schema of response data |
| X |
| | response-status | string | The received status of the response |
| X |
| | response-code | string | The received code of the response |
| X |
| | response-data | object | The data payload |
| X | contains payload of type object |
Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)| Field | Type | Description | Header | Payload | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
| ? | Can NCMP put these in the header and remove them from the 'forwardedEvent' | | eventCorrelationId | string | The request id passed by NCMP |
| ? | as above | | eventTime | string | The timestamp when original event occurred |
| ? | as above | | eventTarget | string | The target of the event |
| ? | as above | | eventType | string | The type of the event |
| ? | as above | | eventSchema | string | The event schema for async request response events |
| ? | as above | | eventSchemaVersion | string | The event schema version for async request response events |
| ? | as above | | eventSource | string | The source of the event |
| ? | as above | | response-data-schema | string | The received schema of response data |
| X |
| | response-status | string | The received status of the response |
| X |
| | response-code | string | The received code of the response |
| X |
| | response-data | object | The data payload |
| X | contains payload of type object |
Proposed New Schema:see | Jira Legacy |
|---|
| server | System Jira |
|---|
| serverId | 4733707d-2057-3a0f-ae5e-4fd8aff50176 |
|---|
| key | CPS-1660 |
|---|
|
| Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event generated by DMI | X |
|
| standard (id) | | eventCorrelationId | string | The request id passed by NCMP | X |
|
| extensions(correlationid) | | eventTime | string | The timestamp when original event occurred | X |
|
| standard (time) | | eventSource | string | The source of the event | X |
| What value should contain in this? Needs clarification, see issue #8 | standard (source) | | eventType | string | The type of the event | X |
|
| standard (type) | | eventSchema | string | The event schema for async request response events | X |
|
| standard (dataschema) | eventSchemaVersion | string | The event schema version for async request response events
| X |
|
| N/A included in 'dataschema' | | event | Event | The payload of an event |
| X | Defined by event object below | standard (data) |
Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)| Field | Type | Description | Header | Payload | Notes |
|---|
| eventCorrelationId | string | The request id passed by NCMP | X |
| as above @Toine asked to add this property. | | responseStatus | string | The received status of the response |
| X |
| | responseCode | string | The received code of the response |
| X |
| | responseData | object | The data payload |
| X | contains payload of type object |
|
#6
...
Data Operation (response) Event (DMI → NCMP)
Description
Batch (data) request will always result in asynchronous events (responses) sent to the client. This event is the response from DMI to NCMP. See 5 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (bulk / batch operations)#BulkRequestMessageFlow
| Expand |
|---|
| title | DMI Async Batch Response Event |
|---|
|
BatchResponseEvent DmiDataOperationEvent Object | Excerpt |
|---|
| Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event generated by DMI | X |
| Mandatory. Generated by DMI-Plugin | standard (id) | | eventCorrelationId | string | The request id passed by NCMP | X |
| Mandatory. This is requestId that NCMP sent to client as an ACK.
example : “request-1234" (UUID) | extension (correlationid) | | eventTarget | string | The destination topic of the client | X |
| Mandatory. TBC example: my-topic | extension (destination) | | source | string | The source of the event |
|
| Mandatory. example : dmi-plugin:enm-1 (dmi service name) | standard (source) | | eventTime | string | The timestamp when original event occurred | X |
| Optional. The timestamp should follow that on https://www.rfc-editor.org/rfc/rfc3339#section-5. This follows ISO 8601 and is what is used/referenced in 3GPP standards
example: 1985-04-12T23:20:50.52Z this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. | standard (time) | | eventType | string | The type of the event | X |
| Mandatory. NCMP owns eventType that would be used by dmi-plugins
The Convention of eventType and Schema names is under discussion, see open issue #17 on CPS-1515 Spike | standard (type) | | eventSchema | string | The event schema for async request response events | X |
| Mandatory.
The Convention of eventType and Schema names is under discussion, see open issue #17 on CPS-1515 Spike
| standard (dataschema) | eventSchemaVersion | string | The event schema version for async request response events
| X |
|
| N/A included in 'dataschema' | | event | Event | The payload of an event |
| X | java object not yet defined by schema, see issue #2 | standard (data) | | specversion | String | Version of CNCF spec | X |
| hardcoded value of 1.0 | standard (specversion) |
|
Type: Event (cps:org.onap.cps.ncmp.event.async:dmi-asyncdata-batch-responseoperation-event-schema:v1) | Field | Type | Description | Header | Payload | Notes |
|---|
| No Properties defined (Entire event treated as single object) |
|
#7
...
Data Operation (response) Event (NCMP → Client App)
Description
Batch (data) request will always result in asynchronous events (responses) sent to the client. This event is the response from DMI to NCMP. See 6 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (bulk / batch operations)#BulkRequestMessageFlow
| Expand |
|---|
| title | NCMP Async Batch Response Event - Client Topic |
|---|
|
BatchResponseEvent NcmpDataOperationEvent Object | Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event generated by DMI | X |
|
| standard (id) | | eventCorrelationId | string | The request id passed by NCMP | X |
|
| extensions (correlationid) | | eventTime | string | The timestamp when original event occurred | X |
|
| standard (time) | | eventType | string | The type of the event | X |
|
| standard (type) | | source | string | The source of the event | X |
| NEW see decision #18, value 'ncmp' TBC | standard (source) | | eventSchema | string | The event schema for async request response events | X |
|
| standard (dataschema) | eventSchemaVersion | string | The event schema version for async request response events
| X |
|
| N/A included in 'dataschema' | | event | Event | The payload of an event |
| X | Java object not yet defined by schema, see issue #2 | standard (data) |
Type: Event (cps:org.onap.cps.ncmp.event.async:ncmp-asyncdata-batch-responseoperation-event-schema:v1) | Field | Type | Description | Header | Payload | Notes |
|---|
| No Properties defined (Entire event treated as single object) |
|
CNCF Cloud Event alignment
Introduction
CNCF CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.
- These cloud events will be applied to all the internal and external events we have in CPS , NCMP and DMI Plugin.
- Cloud events will be taking care of the fields which are part of Headers or part of the actual payload (fields other than "data" are sent as Headers)
- These CNCF cloud events will be applied to all the events listed in above sections (LCM , DMI Data AVC etc.)
...
Before | After1 | CloudeEvent builder method | Example Value | Notes |
|---|
eventId | (ce_)id | .withId() |
| Mandatory |
eventSource | (ce_)source | .withSource() |
| Mandatory |
N/A | (ce_)specversion (default 1.0) | .v1() | 1.0 | Mandatory - This is the version of the cloud events |
eventType | (ce_)type | .withType() |
| Mandatory |
eventTime | (ce_)time | .withTime() |
| Optional (could be Mandatory for |
eventSchema | (ce_)dataschema | .withDataSchema() |
| Optional includes the version of the schema |
| content-type2 | withDataContentType() | application/json | Optional |
| eventCorrelationId | (ce_)correlationid | .withExtension() |
| Optional This will be part of the extensions field in the cloud events and all the restrictions of the attribute field naming applies to it. i.e these fields will be in the small case. This is marked as optional as it only applies to some events. |
| event | (ce_)data | .withData(json TBC) |
| Mandatory actual event/payload now would be under "data" field. |
...