Versions Compared

Key

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

...

#IssueNotesDecision
1Do we need to update existing update notification to send delta notification or delta notification along with existing notification. 
29-Sep-2023: We decided to implement delta notification separately without changing the existing update notification. 
2Using Liquibase v. Yang Model for storing new metadata per anchor in CPS CoreNeeds discussions with architects
3generic text field OK for future refinement, maybe consider json?

Event Schema

For delta notification we can use the existing cps data update event schema (cps-data-update-event-schema.json). 

proposal for notification schema:

Cloud event Definition

#1idUUID of the event2source

Element

Name

Parent

Type

Mandatory

Description

Format

(example) Value

1Headerid
StringYesrandom id for cloud event header. UUID is suggested

2source
StringYessource of informationfixed value
urn:cps:org.onap.cps
3specversion
StringYescloud event version specfixed value1.0
4type
StringYestype of eventfixed valuedataUpdateEvent
5dataschema
StringYesdata schemafixed value
urn:
cps:org.onap.cps:data-updated-event-schema:
v14type
org.onap.cps.data-updated-delta-event
5content{
   "data":{
      "observedTimestamp":"
1.0.0
6Payloaddata
ObjectYesThe actual data payload. Details will be provided below.

7observedTimestampdataStringYesThe timespamp of the event. timestamp2024-01-17 12:34:43
",
      "dataspaceName":"testDataspace",
      "schemaSetName":"bookstore",
      "anchorName":"testAnchor",
      "operation":"CREATE",
      "xpath": "/"
   }
}
8dataspaceNamedataStringYesThe dataspace name where data is changed.
dataspace01
9schemaSetNamedataStringNoThe schemaset name for which data is changed.
bookstore
10anchorNamedataStringYesThe anchor name for which data is changed.
anchor01
11operationdataStringYesThe operation performed on data. 

CREATE

UPDATE

DELETE


12xpathdataStringYesThe XPath which is changed 
/bookstore


Controlling Notification

 It is important to control the delta notification for better performance. we need to decide on below options to control delta notification.

...