Versions Compared

Key

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

Table of Contents

...

DMI notifies NCMP of new , deleted or changed cmhandles DMI Plugin NCMP. Including initial registration
Scenario : DMI notifies NCMP of new cmhandles
Method : POST
URI : {ncmpRoot}/ncmp/v1/ch/
Header :
Content-Type: application/json


Request Body

Request Body : {
      "dmiDataPlugin" : "onap.dmi.data-plugin",
      "dmiModelPlugin" : "onap.dmi.model-plugin",

      "createdCmHandles" : [ {   "cmHandle" : "rf4er5454",
                                 "cmHandleProperties" :
                                   { "subSystemId" : "system-001" }
                             }, {..} ],
      "updatedCmHandles" : [ .. ],
      "removedCmHandles" : [ "node-1", "node-2" , ... ]
  }


json attributes:

  • "dmiDataPlugin"/"dmiModel" are resolvable service names
  • "createdCmHandles" used for initial cm handle registrations or subsequent
    cmhandle creations
  • "updatedCmHandles"
    Used for updates to cmhandles. Same structure as for create handles
  • "removedCmHandles"  array of cmhandles that have been deleted



openAPI Updates

To support this the equivalent openAPI will be similar to the below in bold.

...

...


...

RestCmHandle:

...

     

...

required:

...

       

...

-

...

cmHandle

...

     

...

type:

...

object

...

     

...

properties:

...

       

...

cmHandle:

...

         

...

type:

...

string

...

         

...

example:

...

cmHandle123

...

       

...

cmHandleProperties:

...

           

...

$ref:

...

'#/components/schemas/RestCmHandleAdditionalProperties'

...

   

...

RestCmHandleAdditionalProperties:

...

       

...

type:

...

object

...

       

...

additionalProperties:

...

           

...

type:

...

string

...

           

...

example:

...

system-001

...


 

...

 

...

RestDmiPluginRegistration:

...


 

...

 

...

 

...

type:

...

object

...


 

...

 

...

 

...

properties:

...


 

...

 

...

 

...

 

...

dmiPlugin:

...


 

...

 

...

 

...

 

...

 

...

type:

...

string

...


 

...

 

...

 

...

 

...

 

...

required:

...

false

...


 

...

 

...

 

...

 

...

 

...

example:

...

onap-dmi-plugin

...


 

...

 

...

 

...

 

...

dmiDataPlugin:

...

 

...


 

...

 

...

 

...

 

...

 

...

type:

...

string

...


 

...

 

...

 

...

 

...

 

...

required:

...

false

...


 

...

 

...

 

...

 

...

 

...

example:

...

onap-dmi-data-plugin

...


 

...

 

...

 

...

 

...

dmiModelPlugin:

...

 

...


 

...

 

...

 

...

 

...

 

...

type:

...

string

...


 

...

 

...

 

...

 

...

 

...

required:

...

false

...


 

...

 

...

 

...

 

...

 

...

example:

...

onap-dmi-model-plugin

...


 

...

 

...

 

...

 

...

createdCmHandles:

...


 

...

 

...

 

...

 

...

 

...

type:

...

array

...


 

...

 

...

 

...

 

...

 

...

items:

...


 

...

 

...

 

...

 

...

 

...

 

...

$ref:

...

'#/components/schemas/RestCmHandle'

...


 

...

 

...

 

...

 

...

updatedCmHandles:

...


 

...

 

...

 

...

 

...

 

...

type:

...

array

...


 

...

 

...

 

...

 

...

 

...

items:

...


 

...

 

...

 

...

 

...

 

...

 

...

$ref:

...

'#/components/schemas/RestCmHandle'

...


 

...

 

...

 

...

 

...

removedCmHandles:

...


 

...

 

...

 

...

 

...

 

...

type:

...

array

...


 

...

 

...

 

...

 

...

 

...

items:

...


 

...

 

...

 

...

 

...

 

...

 

...

type:

...

string