[NETCONF-1152] RESTCONF DataTreeChange notifications use incorrect format

Tue, 12 Sep 2023 17:36:56 +0000

There are two distinct problems here. A JSON notification is encoded as:

{
  "urn-ietf-params-xml-ns-netconf-notification-1.0:notification": {
    "urn-opendaylight-params-xml-ns-yang-controller-md-sal-remote:data-changed-notification": {
      "data-change-event": [
        {
          "path": "/instance-identifier-patch-module:patch-cont/instance-identifier-patch-module:my-list1/instance-identifier-patch-module:my-list1[instance-identifier-patch-module:name='Althea']/instance-identifier-patch-module:name",
          "data": {
            "instance-identifier-patch-module:name": "Althea"
          },
          "operation": "updated"
        },
        {
          "path": "/instance-identifier-patch-module:patch-cont/instance-identifier-patch-module:my-list1/instance-identifier-patch-module:my-list1[instance-identifier-patch-module:name='Althea']/instance-identifier-patch-module:my-leaf12",
          "data": {
            "instance-identifier-patch-module:my-leaf12": "Bertha"
          },
          "operation": "created"
        },
        {
        "path": "/instance-identifier-patch-module:patch-cont/augment-instance-identifier-patch-module:patch-choice1/augment-instance-identifier-patch-module:case-leaf1",
        "data": {
          "augment-iip-module:case-leaf1": "ChoiceUpdate"
        },
          "operation": "updated"
        },
        {
          "path": "/instance-identifier-patch-module:patch-cont/augment-instance-identifier-patch-module:leaf1",
          "data": {
            "augment-iip-module:leaf1": "AugmentLeaf"
          },
          "operation": "updated"
        }
      ]
    },
    "event-time": "2022-02-18T18:04:25.214583+01:00"
  }
}

The first issue is that the top two elements have incorrect namespaces:

the first should be "ietf-restconf:notification", as per https://www.rfc-editor.org/rfc/rfc8040#page-72
the second should be "sal-remote:data-changed-notification" as per JSON encoding rules

The second problem, shared with XML encoding, is how 'path' element's name is encoded. This is using AbstractWebsocketSerializer.convertPath(), which is ... funky to say the least. It pretends to use the JSON encoding, but does not use module names but XMLNamespaces ... and changes them by replacing all ':'s with '-'s. Just to pick on it a bit more, it does not eliminate unneeded namespace references.

All of this needs to be fixed up, but means we are changing our external interface, so the fix should be only delivered to netconf-7.

OpenDaylight JIRA

[NETCONF-1152] RESTCONF DataTreeChange notifications use incorrect format