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)

{ncmp-root}/ncmp/v1/ch/

Scenario : DMI notifies NCMP of new cmhandles
Method : POST
URI : {ncmp-root}/ncmp/v1/ch/
Header :
    Content-Type: application/json

Body :
  {}

Body :
  {
      "dmi-plugin" : "system:5555", //should be resolvable sevicename in
      k8s DNS
      "createdcmhandles" : [ // Used for initial cm handle registrations or subsequent
                                 cmhandle creations (post initial registration)
                             {
                                 "cmhandle" : "rf4er5454",
                                 "additionalProperties" :
                                   {
                                       "subsystemId" : "system-001"
                                           "targetId" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=Kista001"
                                   }
                             },
                             {
                                 "cmhandle" : "dfget656",
                                 "additionalProperties" :
                                   {
                                       "subsystemId" : "system-001"
                                           "targetId" : "Subnetwork=Stockholm,MeContext=Kista,
ManagedElement=Kista-002"
                                   }
                             }
                             ...
                                 ...
      ],
      ...
    # Used for updates to cmhandles
      "updatedcmhandles" : # For example the cmhandle has got rehomes to a new 
      system.
    {
        "cmhandle" : "rf4er5454",
        "additionalProperties" :
          {
              "subsystemId" : "system-001"
                  "targetId" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=Kista001"
          }
    },
    {
        "cmhandle" : "dfget656",
        "additionalProperties" :
          {
              "subsystemId" : "system-001"
                  "targetId" : "Subnetwork=Stockholm,MeContext=Kista,
ManagedElement=Kista-002"
          }
    }
      ...
      ...
  ],
      // Used for deleted cmhandles
      "removedcmhandles" : [ "sfsdf", .... ], # array of cmhandles that have been deleted 
      from the network. ...
  }

Scenario : Get all cmhandles from NCMP for a given dmi-plugin. May be used
    for conciliation
Method : GET
URI : {ncmp-root}/ncmp/v1/dmi-plugins/{dmi-plugin}/ch
Header :
    Content-Type: application/json

Body :
    // EMPTY BODY

Success Response :
    HTTP/1.1 200 Ok
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
  {
      "cmhandles" : [
      {
          "cmhandle" : "sdf8fs0d8",
          "additionalProperties" : [
              "target" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=Kista001",
              "subSystem" : "system-001"
          ]
      },
      {
          "cmhandle" : "sdsd6567687",
          "additionalProperties" : [
              "target" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=Kista002",
              "subSystem" : "system-001"
          ]
      }
      ...
        }

Notify of change to CMHandle(s)

Topic : 'NCMP_INVENTORY' / sync request topic
Topic name should come from Data Catalog OR
should DMI registry store the topic from the initial
NCMP sync request?)

Topic : NCMP_INVENTORY


Event Body :
  {
      "dmi-plugin" : "sample-adapter:5555",
      "createdcmhandles" : # Newly discovered/created cmhandles
        {
            "cmhandle" : "rf4er5454",
            "additionalProperties" :
              {
                  "subsystemId" : "system-001"
                      "targetId" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=Kista001"
              }
        },
    {
        "cmhandle" : "dfget656",
        "additionalProperties" :
          {
              "subsystemId" : "system-001"
                  "targetId" : "Subnetwork=Stockholm,MeContext=Kista,
ManagedElement=Kista-002"
          }
    }
      ...
      ...
  ],
      "updatedcmhandles" : # For example the cmhandle has got rehomes to a new system.
    {
        "cmhandle" : "rf4er5454",
        "additionalProperties" :
          {
              "subsystemId" : "system-001"
                  "targetId" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=Kista001"
          }
    },
    {
        "cmhandle" : "dfget656",
        "additionalProperties" :
          {
              "subsystemId" : "system-001"
                  "targetId" : "Subnetwork=Stockholm,MeContext=Kista,
ManagedElement=Kista-002"
          }
    }
      ...
      ...
  ],
      "removedcmhandles" : [ "sfsdf", .... ], # array of cmhandles that have been deleted 
      from the network. ...
  }

Scenario : NCMP requests sync of cmhandle yang tree
Method : PUT
URI : {dmi-root}/dmi/v1/sync/ch/243234
Header :
    Content-Type: application/json
Body :
  {}


Body :
  {
      "additionalProperties" :
        {
            "subsystemId" : "sample-subsystemId"
                "targetId" : "Subnetwork=Stockholm,MeContext=Kista,ManagedElement=1"
        }
  }


Response :
    HTTP/1.1 200 OK
    Date: Thu, 26 Jan 2017 20:56:30 GMT
    Server: example-server
    Content-Type: application/yang-data-json
  {
      _3gpp-common-managed-element:ManagedElement [
  {
      id=1,
      ...
      _3gpp-nr-nrm-gnbdufunction:GNBDUFunction :[
      {
          id=1,
          nrsectcarr3gpp:NRSectorCarrier=1 { # level 2
          "_3gpp-common-top:id" : "NRSectorCarrier-1", # level 3
          "attributes" : { # level 3
              "txDirection" : "DL_AND_UL", # level 4
              "arfcnUL" : "55555", # level 4
                             ...
          }
      },
          ...
      ]
      }

{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" : [
          {
            ...
          }
          ]
        }
        ]
      }
      }