Versions Compared

Key

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

...

This user story relates to CPS-1001 Add CPS-E-05 endpoint for 'Read data, NCMP-Operational Datastore'

Redirect request to CPS-Core (Using java interface) with dataspace 'NCMP-CmHandle-Operational-Data' 

Issues/Decisions

#Questions/Open IssuesNotesDecision/Answer
1Proposed Rest endpoint to read data "http://{cnmpHostName}:{ncmpPost}/ncmp/v1/ch/{cm-handle}/data/ds/ncmp-datastores:
 
operational (Hardcoded)"

/ds is datastore

/../ncmp-datastores:operational (Hardcoded)

2Will be using GET http
methos
methods to expose rest endpoint ?
Agreed

Yes, as per current passtrough equivalent endpoints
3What if restendpoint contains  ../options ?

 

Ignore If

Team preference: Ignore if it is there in endpoint.

Need confirmation from kieran mccarthy 

4 Do we need to append "?xpath=/" with proposed rest endpoint to fetch root elements or should it be added while redirecting to cps core(using java interface)? As per original Implementation Proposal/StudyUse "?resourceIdentifier=/" that would be mapped to xpath.
5 Do we need to append "&include-descendants=true/false" with rest endpoint or should be added while redirecting to cps core(using java interface)?
CPS_Core does support a &include-descendants query parameter

Need to discuss with kieran mccarthy 

6Do we need to support only RootXpath or can accept xpath from endpoint to filter result ?
Support
only
any xpath in this scope.
xpat (resourceIdentifier)  is compulsory
7To query/redirect to cps core we need 3
attributes from enduser
or 4 attributes  how it would be mapped?
dataspaceName :


CPS CoreNCMPValue-Mapping
dataspaceName datastoreName 

"ncmp-datastores:

 

operational"

will be mapped to

 "NFP-Operational"

anchorName :
anchorName cm-handle-id
xpath: ?resourceIdentifier=/ will be mapped to "/ " 
N/A
xpathresourceIdentifierN/A
cpsPathresourceIdentifierN/A


8If we pass topic query param with this endpoint should we use async Probably, but implement as separate user story with  different (lower) priority ?!

Need confirmation from kieran mccarthy 


Note : CPS Core java interface :

 public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String dataspaceName, final String anchorName, final String xpath, final Boolean includeDescendants)