The team thinks that the information should instead be provided in the form of a ‘host-name’ and a ‘port’  (there was some debate on service-name v. host-name but it was settled on host-name)

e.g. "dmi-plugin" : { <host-name>,  <port> }

Where the host-name is unique. (the DB might assign an internal unique ID for each entry but that is just for indexing and x-referencing in a relation DB and this ID is not to be used/ exposed externally)

{dmi-root}/dmi/v1/data/ch/<cmhandle>/ds/ncmp-datastore:running/{parent-data-resource-identifier}

{

<new-yang-data-resource>

}

Content-Type: application/json

"data" payload : yang-data+json

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}

{
<yang-data-for-merging>
}

Content-Type: application/json

"data" payload : yang-data+json

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}

Content-Type: application/json

"data" payload : yang-patch+json

dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:operational/{resource-identifier}/{action}

input: {
"param1Name" :"param1Value”,
"param2Name" : "param2Value”

}

Note : If the "action" statement has no "input" section, the request message MUST NOT include a message-body

{dmi-root}/dmi/v1/operations/ch/<cm-handle>/ds/ncmp-datastore:operational/ {module-name}:{action}

{
input: {
"param1Name" : "param1Value”,
"param2Name" : "param2Value”
}
}

Note: If there is no "input" section, the request MUST NOT include a message-body

{dmiroot}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:operational/{resource-identifier}?fields={fields-expression}

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:operational/{resource-identifier}?fields={fields-expression}

{dmi-root}/dmi/v1/data/ch/{cm-handle}/ds/ncmp-datastore:operational/{resource-identifier}?depth={level}

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}

{

   data : {

            .... the complete tree config to be replaced

           }

}

{ncmp-root}/ncmp/v1/dmi-plugin/
{
    "dmi-plugin-id : { dmi-plugin-id }
     "dmi-source-id" : { unique-data-source-id }
}

dmi-plugin-id should be resolvable service name ink8s DNS

Scenario : Register/Create a new dmi-plugin data source in NCMP
Method : POST
URI : {ncmp-root}/ncmp/v1/dmi-plugin/

Header :
Content-Type: application/json

Body :
{
"dmi-plugin-id : "service:sample-service",
"dmi-source-id" : "sample"
}

Success Response :
HTTP/1.1 202 Accepted
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{}

Error Response:
HTTP/1.1 409 Conflict
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{
"error" : {
"error-type" : "protocol",
"error-tag" : "data exists",
"error-message" : "Datasource service:sample-service/sample already
registered/created"
}
}

An error will tell the DMI Plugin that this datasource has already been processed - no need to recover the cmhandles again.

Scenario
Remove a data source and all related NCMP handles from NCMP

Method :
DELETE
URI
{ncmp-root}/ncmp/v1/cmhandle-source/dmi-pluigin/service:sample-service/dmi-source/sample-dmi-source
Header :
Content-Type: application/json
Body :
{}

Success Response :
HTTP/1.1 202 Accepted
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{}

Error Response:
HTTP/1.1 409 Conflict
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{
"error" : {
"error-type" : "protocol",
"error-tag" : "data exists",
"error-message" : "Datasource service:sample-service/sample-dmi-source already
registered/created"
     }
}
An error will tell the DMI Plugin that this datasource has already been processed - no need to recover the cmhandles again.

NCMP requests cmhandles for a datasource (may be refresh of existing
datasource or for a newly registered datasource)

NCMP DMI plugin

{dmi-root}/v1/dmi-source/{unique-data-source-id}?topic={topic-id}

Content-Type: application/json

Note - the following will refresh ALL dmi data sources managed by a dmi plugin
{dmi-root}/v1/dmi-source?topic={topic-id}

Scenario : NCMP requests sync of cmhandles for a datasource
Method : GET
URI : {dmi-root}/v1/dmi-source/dmi-source-sample?topic={topic-id}
Header :
Content-Type: application/json
Body :
{}

Event Body :
{
"dmiPluginId" : "service:sample-service", //should be resolvable sevicename in k8s DNS
"dmi-source-id" : "sample-id"
"createcmhandles" : [
    {
       "cmhandle" : "sample-cmhandle-1",
       "additionalProperties" :
    {
        "subsystemId" : "sample-subsystemId-1"
         "targetId" : "sample-targedId-1"
     }
},
    {
         "cmhandle" : "sample-cmhandle-2",
         "additionalProperties" :
     {
         "subsystemId" : "sample-subsystemId-2"
           "targetId" : "sample-targedId-2"
     }
 }
...
...
],

Topic : NCMP_INVENTORY

Event Body :
  {
    "dmiPluginId" : "service:sample-service",
    "dmi-source-id" : "dmi-source-id-001"
      "createcmhandles" : # Newly discovered/created cmhandles
      {
        "cmhandle" : "cmhandle-001",
        "additionalProperties" :
          {
            "subsystemId" : "subsystemId-001"
              "targetId" : "targetId-001"
          }
      },
    {
      "cmhandle" : "cmhandle-002",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-002"
        }
    }
    ...
    ...
  ],
    "updatedcmhandles" : # For example the cmhandle has got rehomes to a new system.
    {
      "cmhandle" : "cmhandle-003",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-001"
        }
    },
    {
      "cmhandle" : "cmhandle-004",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-002"
        }
    }
    ...
    ...
  ],
    "removedcmhandles" : [ "cmhandle-005", .... ], # array of cmhandles that have been deleted
    from the network.
    "migratedcmhandles" : [
    {
      "cmhandle" : "cmhandle-005",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-001"
        }
    },
    {
      "cmhandle" : "cmhandle-006",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-002"
        }
    }
    ...
      ...
    ]
  }

{dmi-root}/dmi/v1/model/ch/<cm-handle>

Scenario : Get the model data for a given cmhandle

Method : PUT

URI : {dmi-root}/dmi/v1/model/ch/cmhandle-001?fields=ietf-yang-library:modules-set

Header :
Content-Type: application/json
Accept: application/json

Body :

{
  "operation" : "read",
  "cmhandle" : "cmhandle-001",
  "additionalProperties" : [
    "target" : "sample-target",
    "subSystem" : "subSystem-001"
  ]
}

Response:

  {
    "cmHandle" : "cmhandle-001",
    "ietf-yang-library:modules-set" : [ # from RFC 8525
    {
      "name" : "123456",
      "module" : [
      {
        "name" : "store",
        "revision" : "2020-12-09",
        "namespace" : "org:onap:cps:test:store",
        "submodule" : [
        {
          "name" : "bookstore",
          "revision" : "2020-12-17",
          "namespace" : "org:onap:cps:test:bookstore",
          "submodule" : [
          {
            ...
          }
          ]
        }
        ]
      },
      {
        "name" : "ietf-yang-library",
        "revision" : "2016-06-21",
        "namespace" : "urn:ietf:params:xml:ns:yang:ietfyang-library"
      }
      ]
    }
      }