CPS-2234 Identify and List all Legacy Interfaces

1

Message-driven interfaces (event kafka driven) are already covered and do not require modification

Agreed this is an Out of scope for this epic

Jun 13, 2024 @Kolawole Adebisi-Adeolokun  @Csaba Kocsis 

2

FDN when part of URI's can be % encoded 

Agreed no issues with this 

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

1

NCMP shall be expected to return back alternateID when alternateid is passed in

NCMP shall be expected to return back to the normal cmhandle error scenario if alternateID is NOT passed on 

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis @kieran mccarthy  

2

Performance Impact 

1. This shall be based on par unique identifier. 

2. For most legacy interfaces Performance impact was never agreed.

3. CPS should do performance check before and after for comparable value

4. FYI - Increase of 30 ms shall be allowed

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis  

1

To split or not to split

Exact resource path required or partial match is accepted

Exact match example:

Incoming: "CmHandle='a/b/c/d', Resource=''"

Outgoing: "CmHandleID='Ch-1', Resource='a/b/c/d'"

Partial match example:

Incoming: "CmHandle='a/b', Resource=''"

Outgoing: "CmHandleID='Ch-1', Resource='a/b/c/d'"

Append match example:

Incoming: "CmHandle='a/b', Resource=''e/f"

Outgoing: "CmHandleID='Ch-1', Resource='a/b/c/d/e/f'"

**Should split based on URI**

• The EXACT match resource path required shall only be supported

• Partial match will not be supported, it should be fully match and no splitting in the legacy interface

@Kolawole Adebisi-Adeolokun @Csaba Kocsis  

2

Decision on Interfaces currently under development

see interfaces : CPS-E-09.e, CPS-E-10, CPS-E-11

• All Out of scope for this epic, this shall only focus on 'legacy interfaces'

• CPS-E-09.e - should be scoped in the new subscription epic - [CPS-2233] CM Subscription with DME interface - ONAP JIRA

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis  

3

Performance Impact 

1. FYI - Increase of 40 ms shall be allowed

2. Without alternateId 20ms, with alternateId 20ms total overhead allowable = 40ms as confirmed

Aug 21, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

1

CPS-E-05

NCMP REST Interface

See decision on each individua end point

2

CPS-E-08.e

CM Handle LCM events

Moved the endpoint to CPS-E-05 #15.

3

CPS-E-09.e

CM Data Notification Subscription LCM (incl. merge)

Ongoing - See decision #2 under open issues

4

CPS-E-10

Asynchronous . Data Jobs (bulk request). 3GPP SBMA (Service Based Management Architecture) Compliant Interface (using FDNs)

Ongoing - See decision #2 under open issues

5

CPS-E-11

Synchronous Single FDN request 3GPP SBMA (Service Based Management Architecture) Compliant Interface (using FDNs) - 

Ongoing - See decision #2 under open issues

6

CPS-NCMP-I-01

Sync & Model API

See decision on each individua end point

7

DMI-I-01

DMI Plugin REST Interface

Discuss if interface should be included in implementation

8

Application Management Interfaces

CPS Application Monitoring and Management API

Does not communicate or interact with cmHandles

1

/v1/ch/{cm-handle}/data/ds/{datastore-name}

DELETE

Delete resource data from pass-through running for a given cm handle

Alternate ID in URI

Shall support

Jun 13, 2024  @Kolawole Adebisi-Adeolokun @Csaba Kocsis  

2

/v1/ch/{cm-handle}/data/ds/{datastore-name}

GET

Get resource data for given cm handle

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis  

3

/v1/ch/{cm-handle}/data/ds/{datastore-name}

PATCH

Patch resource data from pass-through running for the given cm handle

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

4

/v1/ch/{cm-handle}/data/ds/{datastore-name}

POST

create resource data from pass-through running for given cm handle

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

5

/v1/ch/{cm-handle}/data/ds/{datastore-name}

PUT

Update resource data from pass-through running for the given cm handle

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

6

/v1/data

POST

Execute a data operation for group of cm handle ids

Alternate ID as part of target IDs

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

7

/v1/ch/{cm-handle}/data/ds/{datastore-name}/query

GET

Query resource data for a given cm handle

Alternate ID in URI

NOT use in // and not supported by //

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

8

/v1/ch/{cm-handle}/modules

GET

fetch all module references (name and revision) for a given cm handle

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

9

/v1/ch/{cm-handle}/modules/definitions

GET

Get module definitions (module name, revision, yang resource) with options to filter on module name and revision

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

10

/v1/ch/searches

POST

Execute cm handle query search and return a list of cm handle details.

Not applicable in post, Alternate ID would be contained in return

No impact (No change needed)

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

11

/v1/ch/{cm-handle}

GET

Retrieve CM handle details and properties by cm handle id

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

12

/v1/ch/{cm-handle}/properties

GET

Get CM handle properties by cm handle id

Alternate ID in URI

Shall support

Jun 13, 2024 @Kolawole Adebisi-Adeolokun @Csaba Kocsis 

13

/v1/ch/id-searches

POST

Execute cm handle query search and return a list of cm handle ids.

Not applicable in post or return

Shall support (TBD) @Csaba Kocsis  to propose.

Aug 28, 2024 @Kolawole Adebisi-Adeolokun CPS to implement option #1 optional query parameter

@Csaba Kocsis Proposal:

option #1: optional query paramater that say which id is to be return, default value cmhandleid.

option #2 new interface called alternateid-searches with the same capabilities

14

/v1/ch/{cm-handle}/data-sync

PUT

Set the data sync enabled flag to true or false for a specified Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and NONE_REQUESTED respectfully.

Alternate ID in URI

NOT use in // and not supported by //

Jun 13, 2024@Kolawole Adebisi-Adeolokun @Csaba Kocsis  

15

v1/ch/{cm-handle}/state 

GET

Get CM handle state by cm handle id. (Not event driven, moved out of CPS-E-08.e)

Alternate ID in URI

Shall support

Jun 13, 2024@Kolawole Adebisi-Adeolokun  @Csaba Kocsis  

1

/ncmpInventory/v1/ch

POST

Register a DMI Plugin with any new, updated or removed CM Handles

Already Supported - Alternate IDs are already being registered here.

Already Supported

Jun 13, 2024  @Kolawole Adebisi-Adeolokun  @Csaba Kocsis