Page Comparison

...

Detailed Analysis

Get a Node

Problem Description

...

:

When a list is fetched using Get a node API then instead of returning a list containing n-number of list nodes, the API returns n-lists containing one data node in each list.

For example: if there is a list named "Items" containing 10 items named Item 1, Item 2, ......, Item 10. Then when fetching this list using get a node API a total of 10 individual lists are returned where each list contains one Item, i.e. List 1→Item 1, List 2→ Item 2, ......., List 10→ Item 10.

xpath: /bookstore/categories[@code=1]/books

Response:

code

Code Block

title	Data Originally Stored
collapse	true

{
  "book-store:bookstore": {
    "bookstore-name": "Easons",
    "categories": [
      {
        "code": "1",
        "name": "Children",
        "books": [
          {
            "title": "Matilda",
            "lang": "English",
            "price": 20
          },
          {
            "title": "The Gruffalo",
            "lang": "English",
            "

Matilda"

price": 15
          }
        ]
      }

},

  ]
  }
}

Response when querying the list directly.

Code Block

title	Current output
collapse	true

[
  {
    "books": {
      "title": "Matilda",
      "lang": "English",
      "price":

15 Code Block

 20
    }
  },
  {
    "books": {
      "title": "The Gruffalo",
      "lang": "English",
      "price": 15
    }
  }
]

xpath: /bookstore/categories[@code=1]/books

Expected Response:

Code Block

title	Expected Result
collapse	true

[
  {
    "books": [
      {
        "

lang

title": "

English

Matilda",
        "

price

lang":

20

"English",
        "

title

price":

"Matilda"

lang

title": "

English

The Gruffalo",
        "

price

lang":

15

"English",
        "

title

price":

"The Gruffalo"

This behavior extends to list items stored under root node as well. So, this case needs to be taken into consideration as well

Update node leaves

Problem Description

...

When updating any data node, it's parent node xpath is provided as part of the update request. And the JSON payload contains the data of child node to be updated.

But if the JSON data of the parent node is provided as part of this payload, then instead of failing, the request is successfully executed with partial update Where only the child data node is updated and the parent data node is not updated.

xpath: /bookstore/categories[@code=1]

Notes

Code Block

title	Original JSON data:
collapse	true

{
  "code": 1,
  "name": "Children",
  "books": [
    {
      "title": "Matilda",
      "lang": "English",
      "authors": ["Roald Dahl"],
      "editions": [1988, 2000],
      "price": 20
    }
  ]
}

Code Block

title	JSON with updates
collapse	true

{
  "code": 1,
  "name": "Kids",
  "books": [
    {
      "title": "Matilda",
      "editions": 
		[1988, 2000, 2024],
      "price":

200

25
    }
  ]
}

Code Block

title	JSON data after update
collapse	true

[

{
    "code": "1",
    "name": "Children",
    "books": [
      {
	 	"title": "Matilda",
        "lang": "English",
        "authors": ["Roald Dahl"],
        "editions": 
			[1988, 2000, 2024],
		"price": 25

200

       }
    ]
  }

]

It can be seen that the

updated

leaf data

of

belonging to parent node i.e. code=1 is sent as part of JSON body. Where name is changed from Children to Kids
And the fields editions and price, of child node, i.e. title=Matilda are modified.
But after the request is executed only the child node is updated.
The expected behavior should be to throw an exception as the Update a node API requires parent node xpath to update any child data. Which in this case should be "/bookstore" because the request is also updating the node with key "code=1"
This situation can mainly occur due to user error, where user provides updated parent data along with parent node xpath as part of the request.

Problem Description 2

Update operation can only be done on one node at a time and when trying to update parent child in one request, then only the parent node is updated.

...

Code Block

title	Original JSON data
collapse	true

{
  "categories": {
    "code": "1",
    "name": "Children",
    "books": [
      {
	 	"title": "Matilda",
        "lang": "English",
        "price": 200,
        "authors":["Roald Dahl"],
        "editions": [1988,2000]
      }
    ]
  }
}

Code Block

title	JSON to be updated
collapse	true

{
  "categories": {
    "code": 1,
    "name": "Kids",
    "books": [
      {
        "title": "Matilda",
	 	"price":

20,
		"editions": 
		[1988, 2000, 2022]

,

"price":

20

}
    ]
  }
}

Code Block

title	Updated JSON data
collapse	true

{
  "categories": {
    "code": "1",
    "name": "Kids",
    "books": [
      {
        "title": "Matilda",

"editions": [1988,2000]


     	"lang": "English",
        "price": 200,
        "authors": ["Roald Dahl"],
		"editions": [1988,2000]

 }
    ]
  }
}

The request is executed successfully but only a partial update takes place in the database.
So, either the API should reject any request containing multiple nodes or support updating multiple nodes at once

.Updating multiple list items is possible in one request is possible. And there is no need to provide the entire list instead particular leaves of multiple list items can be updated in a single request

.

Replace a node with descendants

Problem Description

...

If a replace operation is performed on a list, where a new list item is also added to the list, then it results in a 200-response code, with a partial replace operation.

Notes

Code Block

title	Original JSON data
collapse	true

[
  {
    "book-store:books": {
	  "title": "Matilda",
      "lang": "English",
      "price": 20,
      "authors": ["Roald Dahl"],
      "editions": [1988,2000]
    }
  }
]

Code Block

title	Data to replace
collapse	true

{
  "books": [
    {
      "title": "Matilda",
      "lang": "English",
      "authors": ["Roald Dahl"],
      "editions": [2024]
    },
    {
      "title": "The Gruffalo",
      "lang": "English",
      "authors": ["Julia Donaldson"],
      "editions": [1999],
      "price": 15
    }
  ]
}

Code Block

title	Result after Replace operation
collapse	true

[
  {
    "book-store:books": {
	  "title": "Matilda",
      "lang": "English",
      "authors": ["Roald Dahl"],
      "editions": [2024]
    }
  }
]

The

This is a user error as request here is itself wrong,

as

because it tries to add a new list element.

But

CPS provides a separate endpoint to Add a list element
So, such a scenario should be handled by the API instead of returning a successful response.

Versions Compared

Old Version 1

New Version 2

Key

Detailed Analysis

Get a Node

Update node leaves

Replace a node with descendants