Skip to content

Patch structure

JSON Patch is a format for describing changes to a JSON document. It can be used to avoid sending a whole document when only a part has changed. When used in combination with the HTTP PATCH method, it allows partial updates for HTTP APIs in a standards compliant way.

public struct Patch : IEquatable<Patch>

Public Members

name description
static Add(…)
static Copy(…)
static Move(…)
static Remove(…)
static Replace(…)
static Test(…)
from { get; } The new value of the element at the path. Only for operations "copy", "move".
op { get; } The operation to perform.
path { get; } The absolute path of the change.
value { get; } The new value of the element at the path. Only for operations "add", "replace", "test".
enum Mode A JSON Patch document is just a JSON file containing an array of patch operations. The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move”, “copy” and “test”. The operations are applied in order: if any of them fail then the whole patch operation should abort.

See Also