CPS-707 Create Detailed NCMP-DMI interfaces diagram

Current Interface Description

There are 3 distinct parts to the DMI

i) Inventory: The Server side is NCMP, the client the DMI-Plugin

ii) model: The Server side is the DMI-Plugin, the client side is NCMP

iii) data: The server side is DMI-Plugin, the client side is NCMP

Proposed Changes (for clear interface separation)

1. Change prefix for CPS-NCMP-I-01 from ncmp to ncmpInventory  or ncmpDmi
2. Change prefix for DMI-I-01 from dmi to dmi/modules The methods on this interface do NOT need to complete 'generic data request body' (see below) developed for the data access methods.
   1. "Retrieve module-references" method only requires 'cmHandleProperties' in request body (payload)
   2. "Retrieve yang module resources" method requires both  'cmHandleProperties' and 'data' payload. 'Data' will contain a well defined  json (object) of module references
   3. Temporary hosted on this interface no changes required at all. "Add Cm-Handle" method does not require a request body at all
3. Change prefix for DMI-I-02 from dmi to dmi/data
   1. All methods on this interface will use the 'generic data request body' for data access

CPS-645 - Getting issue details... STATUS Will cover item #1 above

CPS-706 - Getting issue details... STATUS The fact that DMI-I-01 and DMI-I-02 were not clearly separated lead to this bug. Items #2 and #3 are now being suggested to fix this bug and introduce clear separation off the DMI Interfaces

Request Format for Data Access

{
  “operation”: “<operation>”,         // Valid operations are: “create”, “read”, “update”, “patch” and “delete”.
                                      
  "dataType": "<dataType>",           // e.g. "application/yang.data"

    “data”: {                           // Embedded data as a String.
    <data>                            // required for create and update operations. Optional filter-data for read-operations
  },

  “cmHandleProperties”: {           // Additional properties for CM handle previously added by DMI plugin and stored in NCMP.
    <properties>
  }
}