Versions Compared

Old Version 9

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version Current

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

Table of Contents

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

InterfaceResponsibilitiesTarget AudienceCurrent
PrefixProposed
Prefix
Current
Examples URI'sProposed Change
xNF Model Sync
CPS-NCMP-I-01
  1.  Register Plug-in CM-Handles
DMI Plugin Instance/ncmp
1

/ncmpInventory

OR

/ncmpDmi

/ncmp/v1/ch

Change prefix to /ncmpInventory

/ncmpInventory/v1/ch

OR

/ncmpDmi/v1/ch

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-645

DMI-I-01
  1. Retrieve module-references
  2. Retrieve yang module resources
  3. Add Cm-Handle (temporary)
Internal
/dmi2
/dmi
/modulesdmi/v1/inventory/cmHandles

dmi/v1/ch/{cmHandle}/modules/

dmi/v1/ch/{cmHandle}/moduleResources

dmi/v1/inventory/cmHandles

dmi/modules/v1/ch/{cmHandle}/references/

dmi/modules/v1/ch/{cmHandle}/resources

No Uri Changes but 'Generic Data Request Body' is not needed for these 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

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-706

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)

/ncmp

/ncmp

ncmp/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational

ncmp/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running

No Changes
DMI-I-
02
01
  1. Read xNF Data
  2. Create (add) xNF Data
  3. Update xNF Data
  4. Delete xNF Data
Internal
(NCMP)		/dmi
3
/dmi/data

dmi/v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational

dmi/v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running

dmi/data/v1/ch/{cmHandle}/ds/ncmp-datastore:passthrough-operational

dmi/data/v1/ch/{cmHandle}/ds/ncmp-datastore:passthrough-running

Proposed Changes (for clear interface separation)

  • Change prefix for CPS-NCMP-I-01 from ncmp to ncmpInventory  or ncmpDmi
  • Change prefix for DMI-I-01 from dmi to dmi/modules 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. Temporary hosted on this interface no changes required at all. "Add Cm-Handle" method does not require a request body at all
    • Change prefix for DMI-I-02 from dmi to dmi/dataAll

    No changes required, all methods on this interface will use the 'generic data request body' for data access

    Jira Legacy
    serverSystem Jira
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyCPS-645
    Will cover item #1 above

    Jira LegacyserverSystem JiraserverId4733707d-2057-3a0f-ae5e-4fd8aff50176keyCPS-706


    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

    Insert excerpt
    DW:CPS-390 Spike: Define and Agree DMI Plugin REST InterfaceDW:
    CPS-390 Spike: Define and Agree DMI Plugin REST Interface
    nopaneltrue