Versions Compared

Old Version 2

changes.mady.by.user Niamh Core

Saved on

compared with

New Version 3

changes.mady.by.user Toine Siebelink

Saved on

Key

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

Interface Overview

Inc drawio
diagramNameNCMP-DMI Interfaces
includedDiagram1
width301
pageId111121974

Current Interface Description

InterfaceResponsibilitiesTarget AudiencePrefixExamples
xNF Model Sync
CPS-NCMP-I-01
  1.  Register   Register Plug-in CM-Handles
DMI Plugin Instance/ncmp*1
  1. /ncmp/v1/ch
DMI-I-01
  1. Retrieve module-references
  2. Retrieve yang module resources
  3. Add Cm-Handle (temporary)
Internal/dmi**2
  1. dmi/v1/ch/{cmHandle}/modules/
  2. dmi/v1/ch/{cmHandle}/moduleResources
  3. dmi/v1/inventory/cmHandles
xNF Data Access
CPS-E-05
  1. Read xNF Data
  2. Create (add) xNF Data
  3. Update xNF Data
  4. Delete xNF Data

External clients, CM Data consumers

(northbound)

/cps
DMI-I-02
  1. Read xNF Data
  2. Create (add) xNF Data
  3. Update xNF Data
  4. Delete xNF Data
Internal
(NCMP)		/dmi**

'* currently ncmp, proposed new name ncmpDmi

'** currently just /dmi for both prposed to add /data /inventory for separation purposed
dmi3

Proposed Changes (for clear interface separation)

  1. Change prefix for CPS_NCMP-I-01 from ncmp to ncmpDmi 
  2. Change prefix for DMI-I-01 from dmi to dmi/inventory The methods on this interface do NOT need to complete generic request body 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. "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 request body for data access