What is the JSON Patch format to remove an element from an array?

json-patch
Niranjan picture Niranjan · Dec 12, 2014 · Viewed 13.4k times · Source

I have the following JSON document, from which I want to remove the "roleId2" element from the "roles" field's array value:

{
  "id" : 12345,
  "firstName": "SomeFirstName",
  "lastName": "SomeLastName",
  "roles":["roleId1", "roleId2", "roleId3"]
}

How can I write a JSON Patch document to remove that element? Is the following expression valid?

{"op": "remove", "path":"/roles", "value": "roleId2"}

Or, should it look like this (because the "roles" value in the document is an array)?

{"op": "remove", "path":"/roles", "value": ["roleId2"]}

From reading RFC 6902, it is not clear to me which—if either—is correct. The RFC mentions the following behavior, but I'm not sure if it's relevant here.

If removing an element from an array, any elements above the specified index are shifted one position to the left.

Answer

warpech picture warpech · Dec 13, 2014

The correct patch to remove item at index 1 from the array is: 

{"op": "remove", "path": "/roles/1"}

See working example at JSFiddle (using Fast-JSON-Patch)

Related questions

Using .Net Core Web API with JsonPatchDocument

I am using JsonPatchDocument to update my entities, this works well if the JSON looks like the following [ { "op": "replace", "path": "/leadStatus", "value": "2" }, ] When i create the object it converts it with the Operations node var patchDoc = new JsonPatchDocument<…

Read More
jsonpatch adding element to array and creating it if not exist

I'm trying to append an element to an array. But i cannot ensure that the array alread exists. So it should be created if not. This example works: Source json: { "data": [] } Patch doc: [{ "op":"add", "path":"/data/-", "value": "foo" }] …

Read More
How can I create a JsonPatchDocument from comparing two c# objects?

Given I have two c# objects of the same type, I want to compare them to create a JsonPatchDocument. I have a StyleDetail class defined like this: public class StyleDetail { public string Id { get; set; } public string Code { get; set; } …

Read More