Versions Compared

Key

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

Table of Contents

Assumptions

#AssumptionNotesSign-off
1Message-driven interfaces (event kafka driven) are already covered and do not require modificationAgreed  Out of scope
2FDN when part of URI's can be % encoded 
3Error handling remains as-is for cm handle
Agreed no issues with this 

Requirement


InterfaceRequirement Notesignoff
1

if the request is in alternateID, return should be in alternateid as well



2
Performance Impact 

This shall be based on per unique identifier. 

There was never agreed performance, CPS should do performance check before and after for comparable value

FYI - Increase of 30 ms shall be allowed

Issues & Decisions


IssueNotes DecisionSignoff
1To 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

kieran mccarthy  tbd


2
Cover interfaces
Decision on Interfaces currently under developmentsee interfaces : CPS-E-09.e, CPS-E-10, CPS-E-11

Interfaces


InterfaceInterface DescriptionNotesDesisionDecisionSign-off
1CPS-E-05NCMP REST Interface


2CPS-E-08.e

CM Handle LCM events




3CPS-E-09.e

CM Data Notification Subscription LCM (incl. merge)

Ongoing - See issue #2

4CPS-E-10

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

Ongoing - See issue #2

5CPS-E-11

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

Ongoing - See issue #2

6CPS-NCMP-I-01Sync & Model API


7DMI-I-01DMI Plugin REST InterfaceDiscuss if interface should be included in implementation

8Application Management Interfaces

CPS Application Monitoring and Management API

Does not communicate or interact with cmHandlesN/AN/A

Endpoints

CPS-E-05 

URIRest MethodDescriptionNotes Decision1/ncmp/

URIRest MethodDescriptionNotes Decisionsignoff
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 URIShall support
2

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

GET

Get resource data for given cm handle

Alternate ID in URIShall support
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 URIShall support
4

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

POST

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

Alternate ID in URIShall support
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 URIShall support
6

/v1/data

POST

Execute a data operation for group of cm handle ids

Alternate ID as part of target IDsShall support
7

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

GET

Query resource data for a given cm handle

Alternate ID in URINOT use in // and not supported by //
8

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

GET

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

Alternate ID in URIShall support
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 URIShall support
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 returnNo impact
11

/v1/ch/{cm-handle}

GET

Retrieve CM handle details and properties by cm handle id

Alternate ID in URIShall support
12

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

GET

Get CM handle properties by cm handle id

Alternate ID in URIShall support
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 


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

CPS-E-08.e

NOT use in // and not supported by //
15

v1/ch/{cm-handle}/

state

state 

GET

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

Alternate ID in URIShall support

CPS-NCMP-I-01 


URIRest MethodDescriptionNotes DecisionSignoff
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
2

/ncmpInventory/v1/ch/cmHandles

GET

Get all cm handle IDs for a registered DMI plugin

Output will be affected

Shall support (TBD) Csaba Kocsis   to propose

3

/ncmpInventory/v1/ch/searches

POST

Query and get CM Handle Ids for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).


Shall support (TBD). (Might be the same as #13 in e-05)

DMI-I-01 


URIRest MethodDescription
Notes Decision

Signoff
1

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

POST

Get all modules for given cm handle

Shall support - development from // needed. CPS shall update documentation 
2

/dmi/v1/ch/{cmHandle}/moduleResources

POST

Retrieve module resources for one or more modules

Shall support - development from // needed. CPS shall update documentation 
3

/dmi/v1/inventory/cmHandles

POST

register given list of cm handles (internal use only)

internal use only - CPS to review
4

/dmi/v1/ch/{cmHandle}/data/ds/{datastore-name}

POST

Get resource data from passthrough operational or running for a cm handle

Shall support - development from // needed. CPS shall update documentation 
5

/dmi/v1/data


POST

Execute a data operation for group of cm handle ids by supplied operation details

Shall support - development from // needed. CPS shall update documentation 


Error Sci

It shall be exact match, no error sci. expected ? But performance shall be closely monitored as part of the second requirements.


Out of scope

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