...
| Expand |
|---|
| title | NCMP Async Request Response Event |
|---|
|
NcmpAsyncRequestResponse Event Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI | x |
|
| | eventCorrelationId | string | The request id passed by NCMP | x |
|
| | eventTime | string | The timestamp when original event occurred | x |
|
| | eventTarget | string | The target of the event | x |
|
| | eventType | string | The type of the event | x |
|
| | eventSchema | string | The event schema for async request response events | x |
|
| | eventSchemaVersion | string | The event schema version for async request response events | x |
|
| | event | Event | The payload of an event |
|
| Defined by event object below | | forwardedEvent | ForwardedEvent | The payload of a forwarded event |
|
| Relation to Event field unclear, do we need 2 events at all see issue #7 |
Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)| Field | Type | Description | Kafka Header | Event Payload Field | 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 |
| | 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 | Kafka Header | Event Payload Field | 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: | Jira |
|---|
| server | ONAP Jira |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-1660 |
|---|
|
| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
|
|
| | eventCorrelationId | string | The request id passed by NCMP |
|
|
| | eventTime | string | The timestamp when original event occurred |
|
|
| | eventSource | string | The source of the event |
|
| What value should contain in this? Needs clarification, see issue #8 | | eventType | string | The type of the event |
|
|
| | eventSchema | string | The event schema for async request response events |
|
|
| | eventSchemaVersion | string | The event schema version for async request response events |
|
|
| | event | Event | The payload of an event |
|
| Defined by event object below |
Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventCorrelationId | string | The request id passed by NCMP |
|
| as above @Toine asked to add this property. | | responseStatus | string | The received status of the response |
|
|
| | responseCode | string | The received code of the response |
|
|
| | responseData | object | The data payload |
|
| contains payload of type object |
|
#6 Bulk Response Event (DMI → NCMP)
...
| Expand |
|---|
|
BatchResponseEvent Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI | x |
|
| | eventCorrelationId | string | The request id passed by NCMP | x |
|
| | eventTarget | string | The destination topic of the client | x |
|
| | eventTime | string | The timestamp when original event occurred | x |
|
| | eventType | string | The type of the event | x |
|
| | eventSchema | string | The event schema for async request response events | x |
|
| | eventSchemaVersion | string | The event schema version for async request response events | x |
|
| | event | Event | The payload of an event |
| x | java object not yet defined by schema, see issue #2 |
Type: Event (cps:org.onap.cps.ncmp.event.async:dmi-async-batch-response-event-schema:v1) | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| No Properties defined (Entire event treated as single object) |
|
#7
...
Batch 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
...
