Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleNCMP Async Request Response Event

NcmpAsyncRequestResponse Event Object

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
eventIDstringThe unique id identifying the event generated by DMIx

eventCorrelationIdstring

The request id passed by NCMP

x

eventTimestringThe timestamp when original event occurredx

eventTargetstringThe target of the eventx

eventTypestringThe type of the eventx

eventSchemastring

The event schema for async request response events

x

eventSchemaVersionstring

The event schema version for async request response events

x

eventEventThe payload of an event

Defined by event object below
forwardedEventForwardedEventThe 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)

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
eventIDstringThe unique id identifying the event generated by DMI
xOnly in payload in v1 of the payload schema.  To be removed in v2 version (will be in the header only)
eventCorrelationIdstring

The request id passed by NCMP


xas above
eventTimestringThe timestamp when original event occurred
xas above
eventTargetstringThe target of the event
xas above
eventTypestringThe type of the event
xas above
eventSchemastring

The event schema for async request response events


xas above
eventSourcestring

The source of the event


x
response-data-schemastring

The received schema of response data


x
response-statusstring

The received status of the response


x


response-codestring

The received code of the response


x
response-dataobject

The data payload


xcontains payload of type object

Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
eventIDstringThe unique id identifying the event generated by DMI
?Can NCMP put these in the header and remove them from the 'forwardedEvent'
eventCorrelationIdstring

The request id passed by NCMP


?as above
eventTimestringThe timestamp when original event occurred
?as above
eventTargetstringThe target of the event
?as above
eventTypestringThe type of the event
?as above
eventSchemastring

The event schema for async request response events


?as above
eventSchemaVersionstring

The event schema version for async request response events


?as above
eventSourcestring

The source of the event


?as above
response-data-schemastring

The received schema of response data


x
response-statusstring

The received status of the response


x


response-codestring

The received code of the response


x
response-dataobject

The data payload


xcontains payload of type object


Proposed New Schema:
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-1660


FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
eventIDstringThe unique id identifying the event generated by DMI


eventCorrelationIdstring

The request id passed by NCMP




eventTimestringThe timestamp when original event occurred


eventSourcestringThe source of the event

What value should contain in this?
eventTypestringThe type of the event


eventSchemastring

The event schema for async request response events




eventSchemaVersionstring

The event schema version for async request response events




eventEventThe payload of an event

Defined by event object below

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
eventCorrelationIdstring

The request id passed by NCMP



as above
responseStatusstring

The received status of the response




responseCodestring

The received code of the response




privatePropertiesobjectContains the additional/extra properties.
type (existingJavaType) has value which we agree on 
the point 12 in the Issues&Decisions:
responseDataobject

The data payload



contains payload of type object


...