Versions Compared

Old Version 24

changes.mady.by.user Arpit Singh

Saved on

compared with

New Version 25

changes.mady.by.user Arpit Singh

Saved on

Key

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

...

#APIIssue/DescriptionNotesDecision
1

Get a Node

Get operation should return all the data trees under the root when xpath is set to "/"

after discussion with Toine Siebelink it was decided to give priority to the GET operation first, before heading for other API's. A discussion with the architects is to be scheduled to discuss upon the following points:

  • should a separate end point be created which returns all the data trees under the root node
  • impact of ongoing versioning issue with CPS on the above point and backwards compatibility

after discussion with the architects it was decided to have a v2 of the GET API and the v2 will return all the data nodes in an array

  • To implement V2 of Get Data Node API
  • New API to return all data nodes when xPath is set to root.
  • Existing functionality to be used when existing xPath is queried
  • New API to return JSON array as response
2Response body of GET APIshould GET Data Node return a JSON array or JSON object in response for multiple data trees

as discussed in weekly meeting, it was decided that v2 of the GET API will return JSON Array and v1 will remain as is (that is returns single data node as JSON Object)


3Impact on NCMP DMI pluginimpact analysis of Get Data Node returning multiple data trees on NCMP DMI pluginThe task is not of high priority as of now. As per CPS-sub team discussion this task was put on hold.
  • Not a priority task
  • Put on hold
4Update Data Node API

Update data node had inconsistencies where, updating leaf nodes for multiple container nodes would throw unexpected error.

And updating multiple list items in a list data node would cause partial update operation

After presenting the findings for patch operation and as per discussion in CPS sub team daily call, it was concluded that support for Patch operation for multiple data nodes would solve the inconsistencies found in the existing Patch operation.Support for Patch for multiple data nodes to be implemented4CPS Core API's under this linkThe remaining CPS core API's might require modification with respect to decisions made for the GET operation. Based upon the decisions for the above Issue this table will be updated from time to time. in the meeting it was decided to focus on GET operation first as the work on remaining API's seemed different from the one for the GET API. Also it was decided to first have a discussion with the architects regarding the GET API and then have a separate discussion for the remaining API;s.

List of impacted API's

OperationAPIIssuesPossible Solution

GET

Anchor
getNode
getNode

Get a Node

  • should return all the data trees when xpath is set to root(/)
  • currently returns only the first data tree
  • modify the existing code for Get a Node API so it returns a List of fragment entities
  • this impacts other API's as well which make use of the Get operation
  • a separate API can be developed to return all the data trees, similar to Get all anchors and Get one anchor API in CPS

PUT

Anchor
remainingAPI
remainingAPI

  • Replace a node with descendants

  • Replace list content


  • No issues were found in Delete DataNode API
  • Following tests were performed
    • replacing multiple Data Nodes under one container node
    • replacing multiple Data Nodes under multiple container nodes (under root node xpath)


DELETEDelete a datanode
  • No issues were found in Delete DataNode API
  • Following tests were performed:
    • Individual data trees nodes were deleted and the ones not deleted were retrieved successfully
    • When all data trees are deleted individually, the entire data node gets deleted from the DB eventually, i.e. an empty collection is not left behind when all data trees are deleted individually
    • When deleting using root node xpath, entire data node is all container nodes are deleted.


PATCHUpdate node leaves

Update node API should support Patch operation for multiple data nodes.

  • Patch operation should allow user to update multiple leaf nodes for multiple container/list data nodes.
  • when performing Patch operation on multiple data trees with xPath set to root node xPath, then all the modified data trees should be updated.
  • when modifying specific data tree using its xPath (ex: /last-container), then the specific data tree must be updated, irrespective of its position in stack.
  • in the current scenario none of the data trees get updated
POSTAdd list element to existing list
  • when the API is called and xpath is set to "/", first the get operation is executed internally to retrieve all the data trees
  • once all the data trees are returned in a List the API proceeds to perform the Post operation
    • retrieving all the data trees does not seems feasible with xpath set to root, given the scenario where new list element is getting added to few of the data trees
  • No issues were detected in Add list element API. The following tests were performed
    • Adding a single list item to existing list in DB
    • Adding multiple list items to existing list in DB
  • The list items are successfully added to the existing list
  • with xpath set to root, the API should return an error message
  • the POST operation can be performed on particular data trees by specifying their respective xpaths.