Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Interface Overview
| Embed draw.io 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
| Interface | Responsibilities | Target Audience | Current Prefix | Proposed Prefix | Examples URI's | URI's after proposed changes |
|---|---|---|---|---|---|---|
| xNF Model Sync | ||||||
| CPS-NCMP-I-01 |
| DMI Plugin Instance | /ncmp | /ncmpInventory1 OR | /ncmpDmi/ncmp/v1/ch | /ncmpInventory/v1/ch OR /ncmpDmi/v1/ch |
| DMI-I-01 |
| Internal | /dmi | N/dmi/modules2A | 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 | dmi/v1/inventory/cmHandlesNo Changes |
| xNF Data Access | ||||||
| CPS-E-05 |
| 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-0201 |
| Internal (NCMP) | /dmi | N/dmi/data3A | 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-runningNo Changes |
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 data request body' (see below) developed for the data access methods.
- "Retrieve module-references" method only requires 'cmHandleProperties' in request body (payload)
- "Retrieve yang module resources" method requires both 'cmHandleProperties' and 'data' payload. 'Data' will contain a well defined json (object) of module references
- 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/data
- All methods on this interface will use the 'generic data request body' for data access
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Jira | ||||||
|---|---|---|---|---|---|---|
|
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|