...
| Expand |
|---|
|
Current LCM Event Object| Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event | X |
| Mandatory | standard (id) | | eventCorrelationId | string | The id identifying the event. In LCMEvent this is always a cmhandleId | X |
| Optional
(extension fields will be optional now) | extension (correlationid) | | eventTime | string | The timestamp when original event occurred | X |
| Mandatory | standard (time) | | eventSource | string | The source of the event | X |
| Mandatory | standard (source) | | eventType | string | The type of the event | X |
| Mandatory | standard (type) | | eventSchema | string | The schema that this event adheres to. | X |
| Mandatory e.g. cps:org.onap.ncmp.cmhandle.lcm-event:1.0.0 | standard (dataschema) | eventSchemaVersion | string | The version of the schema that this event adheres to
| X |
| Mandatory e.g v1.0
| N/A included in 'dataschema' | | event | Event | The payload of an event |
| X | Mandatory | standard (data) | | N/A | N/A | The version of CNCF Specification | X |
| Specified by CNCF (value hardcoded) | standard (specversion) |
Type:Event (cps:org.onap.ncmp.cmhandle.lcm-event:v1)| Field | Type | Description | Header | Payload | Notes |
|---|
| cmHandleId | string | cmHandle id |
| X |
| | oldValues | Values | Values that represents the state of a cmHandle |
| X | Defined by values object below | | newValues | Values | Values that represents the state of a cmHandle |
| X | Defined by values object below |
Type:Values| Field | Type | Description | Header | Payload | Notes |
|---|
| dataSyncEnabled | string | cmHandle id |
| X |
| | cmHandleState | string | State of cmHandle |
| X | Enum: ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"] | | cmHandleProperties | object | cmHandle properties |
| X | List of Java <String, String> Maps |
|
...
| Expand |
|---|
|
AVC Event Object| Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event | X |
| Mandatory | standard (id) | | eventCorrelationId | string | The id identifying the event | X |
| Optional | extension(correlationid) | | eventTime | string | The timestamp when original event occurred | X |
| Optional | standard (time) | | eventSource | string | The source of the event | X |
| Optional | standard (source) | | eventType | string | The type of the event | X |
| Mandatory (e.g. cps:org.onap.cps.ncmp.events:avc-event) | standard (type) | | eventSchema | string | The schema that this event adheres to | X |
| Mandatory (e.g. cps:org.onap.cps.ncmp.events:avc-event-schema) | standard (dataschema) | eventSchemaVersion | string | The version of the schema that this event adheres to
| X |
| Mandatory | N/A included in 'dataschema' | | event | Event | The payload of an event |
|
| Mandatory | standard (data) |
Type: Event (cps:org.onap.cps.ncmp.events:avc-event-schema:v1)| Field | Type | Description | Header | Payload | Notes |
|---|
|
|
...
AVC Subscription Event (external Clients Apps → NCMP) : ON HOLD - kieran mccarthy to analyze further
Priyank Maheshwari We need to revisit this schema and include the cloud events fields. (At the moment this doesn't have proper fields)
| Excerpt |
|---|
| Expand |
|---|
| title | AVC Subscription Event |
|---|
| Subscription Event Object | Field | Type | Description | Header | Payload | Notes | CloudEvents Mapping |
|---|
version | string | The event type version | X |
|
| included in dataschema | | eventType | string | The event type | X |
|
| standard (type) | | source |
|
| NEW TBC, see issue #18 |
|
| X |
| NEW see decision #18, value <clientId> (same as in payload) TBC | standard (source) | | event | Event | The payload for an event | X |
| Defined by event object below | standard (data) |
Event Object (cps:org.onap.cps.ncmp.events:avc-subscription-event:v1)| Field | Type | Description | Header | Payload | Notes |
|---|
| subscription | Subscription | The subscription details |
| X | Defined by subscription object below | | dataType | DataType | The datatype content |
| X | Defined by dataType object below | | predicates | Predicates | Additional values to be added into the subscription |
| X | Defined by predicates object below |
Type: Subscription| Field | Type | Description | Header | Payload | Notes |
|---|
| clientID | string | The client ID |
| X |
| | name | string | The name of the subscription |
| X |
| | isTagged | boolean | optional parameter, default is false |
| X | default: false |
Type: DataType| Field | Type | Description | Header | Payload | Notes |
|---|
| dataspace | string | The dataspace name |
| X |
| | dataCategory | string | The category type of the data |
| X |
| | dataProvider | string | The provider name of the data |
| X |
| | schemaName | string | The name of the schema |
| X |
| | schemaVersion | string | The version of the schema |
| X |
|
Type: Predicates| Field | Type | Description | Header | Payload | Notes |
|---|
| targets | array | CM Handles to be targeted by the subscription |
| X |
| | datastore | string | datastore which is to be used by the subscription |
| X |
| | Xpath-filter | string | filter to be applied to the CM Handles through this event |
| X |
|
|
#4 DMI Async Request Response Event (DMI → NCMP)
...
| 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 |
|---|
| server | ONAP Jira |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| 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 |
|
...
| Expand |
|---|
| title | DMI Async Batch Response Event |
|---|
|
BatchResponseEvent 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 |
|
| OptionalMandatory. 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-async-batch-response-event-schema:v1) | Field | Type | Description | Header | Payload | Notes |
|---|
| No Properties defined (Entire event treated as single object) |
|
...
