Skip to content

Ignore "From" when serializing a JsonPatchDocument for "add", "remove", "replace" and "test" operations #64031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
+30 −12
Open

Ignore "From" when serializing a JsonPatchDocument for "add", "remove", "replace" and "test" operations #64031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a060e19
mark from as nullable
akumar806421 Oct 3, 2025
1216ce5
Add ignore null
akumar806421 Oct 3, 2025
5b2cba7
Add test case
akumar806421 Oct 3, 2025
dd1eebe
mark from as nullable
akumar806421 Oct 3, 2025
fa9b642
Add ignore null
akumar806421 Oct 3, 2025
b019595
Add test case
akumar806421 Oct 3, 2025
46fa0e9
Merge branch 'fix/jsonpatch-from-null' of https://github.com/akshay-z…
akumar806421 Oct 14, 2025
a14fb43
Code cleanup
akumar806421 Oct 14, 2025
5af37c0
Code cleanup
akumar806421 Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions src/Features/JsonPatch.SystemTextJson/src/Operations/OperationBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ public string op
}
}

[JsonPropertyName(nameof(from))]
public string from { get; set; }
#nullable enable
[JsonPropertyName(nameof(from)), JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? from { get; set; }
#nullable restore

public OperationBase()
{
Expand All @@ -59,10 +61,4 @@ public OperationBase(string op, string path, string from)
this.path = path;
this.from = from;
}

public bool ShouldSerializeFrom()
{
return (OperationType == OperationType.Move
|| OperationType == OperationType.Copy);
}
}
5 changes: 2 additions & 3 deletions src/Features/JsonPatch.SystemTextJson/src/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.Operation<TModel>.Opera
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.OperationBase() -> void
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.OperationType.get -> Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.ShouldSerializeFrom() -> bool
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType.Add = 0 -> Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType.Copy = 4 -> Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType
Expand Down Expand Up @@ -97,8 +96,8 @@ Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationType.Test = 5
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.Operation<TModel>.Apply(TModel objectToApplyTo, Microsoft.AspNetCore.JsonPatch.SystemTextJson.Adapters.IObjectAdapter adapter) -> void
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.Operation<TModel>.Operation(string op, string path, string from) -> void
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.Operation<TModel>.Operation(string op, string path, string from, object value) -> void
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.from.get -> string
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.from.set -> void
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.from.get -> string?
Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.from.set -> void
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.op.get -> string
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.op.set -> void
~Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations.OperationBase.OperationBase(string op, string path, string from) -> void
Expand Down
25 changes: 24 additions & 1 deletion src/Features/JsonPatch.SystemTextJson/test/JsonPatchDocumentTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Nodes;
using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Converters;
using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Exceptions;
using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Operations;
Expand Down Expand Up @@ -255,4 +256,26 @@ private string GeneratePatchDocumentJson(SimpleObject toAdd, JsonSerializerOptio

return JsonSerializer.Serialize<JsonPatchDocument<SimpleObject>>(document, jsonSerializerOptions);
}
}

[Fact]
public void Serialization_ShouldExcludeFrom_WhenNullAndNotMoveOrCopy()
{
// Arrange
JsonPatchDocument patchDocument = new();
patchDocument.Add("/a/b/c", "foo");
patchDocument.Remove("/x/y/z");
patchDocument.Replace("/d/e", "bar");
patchDocument.Test("/f/e", "t1");

var json = JsonSerializer.Serialize(patchDocument);

// Assert
var expectedJson = """
[{"value":"foo","path":"/a/b/c","op":"add"},{"value":null,"path":"/x/y/z","op":"remove"},
{ "value":"bar","path":"/d/e","op":"replace"},{ "value":"t1","path":"/f/e","op":"test"}]
""";

// Act
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedJson), JsonNode.Parse(json)));
}
}
Loading