CPS-2154: Response schema for DMI dataJob response
References
Assumptions
Assumption | Notes | |
---|---|---|
1 |
Issues & Decisions
Issue | Notes | Decision | |
---|---|---|---|
1 | Which Kafka topic should this proposed schema notify? | an existing Kafka topic, ncmp-async-m2m | |
2 | What should the event type be? | org.onap.cps.ncmp.events.async1_0_0.DataJobEvent (DataJobEvent) | |
3 | What should the event dataSchema be? | urn:cps:org.onap.cps.ncmp.events.async1_0_0.DataJobEvent:1.0.0 |
Cloud event Definition
The schema will be used to send dataJob result from DMI to an existing Kafka topic, ncmp-async-m2m
Status out of scope
Element | Name | Parent | Type | Mandatory | Description | Format | (example) Value | |
---|---|---|---|---|---|---|---|---|
1 | Header | header | Object | Yes | The header of the cloud event. Header details provided below | |||
2 | id | header | String | Yes | random id for cloud event header. UUID is suggested | |||
3 | source | header | String | Yes | source of information | dmi.<datajobid> | ncmp.12ac34e43556e | |
4 | specversion | header | String | Yes | cloud event version spec | fixed value | 1.0 | |
5 | type | header | String | Yes | type of event | fixed value | org.onap.cps.ncmp.events.async1_0_0.DataJobEvent | |
6 | dataschema | header | String | Yes | data schema | fixed value | urn:cps:org.onap.cps.ncmp.events.async1_0_0.DataJobEvent:1.0.0 | |
7 | correlationid | header | String | Yes | The dataJobId that this notification relates to | <datajobid> | 12ac34e43556e | |
8 | destination | header | String | Yes | The client kafka topic. The topic that the status will be sent to in the future | <free text> | result-topic | |
9 | Data | data | Object | Yes | Note: treat result as data, don't validate, don't parse | "responses": [ } } ] |