JavaScript Object Notation (JSON) Patch

4.1. add

"add" 演算は、目的地点が指しているものに応じて，次のいずれかを遂行する： The "add" operation performs one of the following functions, depending upon what the target location references:

• 目的地点が 配列 index を指定している場合、その配列の中の 指定された index の位置に，新たな値が挿入される。 【 index 0 が先頭を指す： [RFC6901] の 4 節 Evaluation （和訳） 】 If the target location specifies an array index, a new value is inserted into the array at the specified index.
• 目的地点が 存在しないオブジェクトメンバを指定している場合、そのオブジェクトに新たなメンバが追加される。 If the target location specifies an object member that does not already exist, a new member is added to the object.
• 目的地点が 既存のオブジェクトメンバを指定している場合、そのメンバの値が置換される。 If the target location specifies an object member that does exist, that member's value is replaced.

演算オブジェクトは、追加のための値をとる， "value" メンバを持っていなければならない。 The operation object MUST contain a "value" member whose content specifies the value to be added.

例： For example:

{ "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] }

目的地点は、演算が適用される時点で，次のいずれかを参照していなければならない： When the operation is applied, the target location MUST reference one of:

• 目的文書のルート — その結果，目的文書の内容全体が，指定された値に置き換わる†。 The root of the target document - whereupon the specified value becomes the entire content of the target document.

  【† 指定された値がオブジェクトでも配列でもない場合の結果は、 RFC 4627 では，合法でない JSON 文書にされていたが、 RFC 4627 を置き換える RFC 7159 により， 合法にされた。 】

• 既存のオブジェクトに追加するメンバ — その結果、そのオブジェクトの中の指示された地点に，指定された値が追加される。 そのメンバが既存のものであった場合、それは指定された値に置換される。 A member to add to an existing object - whereupon the supplied value is added to that object at the indicated location. If the member already exists, it is replaced by the specified value.
• 既存の配列に追加する要素 — その結果、その配列の中の指示された地点に，指定された値が追加される。 指定された index 以上に位置する要素は，１つずつ後ろへずらされる。 指定された index が配列の要素数を超えてはならない 【 index が要素数に等しければ，末尾に付加 】 。 配列の末尾 index を表す文字 "-" が利用された場合（ [RFC6901] を参照）、値は配列の末尾に付加されることになる。 An element to add to an existing array - whereupon the supplied value is added to the array at the indicated location. Any elements at or above the specified index are shifted one position to the right. The specified index MUST NOT be greater than the number of elements in the array. If the "-" character is used to index the end of the array (see [RFC6901]), this has the effect of appending the value to the array.

この演算は，既存のオブジェクトや配列に値を追加するためにあるので、目的地点に値が存在しないことも度々あり得る。 したがって， 【 RFC6901 の規定により】 ポインタのエラーを取り扱うアルゴリズムが呼び出されることになるが、この仕様は、 "add" の下での，ポインタのエラーの際のふるまいを、そのエラーを無視し, 指定された値を追加するものと定める。 Because this operation is designed to add to existing objects and arrays, its target location will often not exist. Although the pointer's error handling algorithm will thus be invoked, this specification defines the error handling behavior for "add" pointers to ignore that error and add the value as specified.

しかしながら、それを含むオブジェクト自身または配列は，存在する必要があり、不在の場合はエラーになる。 例えば、次の文書から演算が開始されるときの，目的地点 "/a/b" による "add" は： However, the object itself or an array containing it does need to exist, and it remains an error for that not to be the case. For example, an "add" with a target location of "/a/b" starting with this document:

{ "a": { "foo": 1 } }

"a" が存在するのでエラーではなく，その値に "b" に追加されることになる一方、次の文書の場合は： is not an error, because "a" exists, and "b" will be added to its value. It is an error in this document:

{ "q": { "bar": 2 } }

"a" が存在しないのでエラーになる。 because "a" does not exist.

4.2. remove

"remove" 演算は、目的地点から値を除去する。 The "remove" operation removes the value at the target location.

演算が成功とされるためには、目的地点が存在しなければならない。 The target location MUST exist for the operation to be successful.

例： For example:

{ "op": "remove", "path": "/a/b/c" }

配列から要素が除去される際には、指定された index より先の要素は１つずつ先頭へずらされる。 If removing an element from an array, any elements above the specified index are shifted one position to the left.

4.3. replace

"replace" 演算は、目的地点の値を新たな値で置換する。 演算オブジェクトは、置換のための値をとる "value" メンバを持っていなければならない。 The "replace" operation replaces the value at the target location with a new value. The operation object MUST contain a "value" member whose content specifies the replacement value.

演算が成功とされるためには、目的地点が存在しなければならない。 The target location MUST exist for the operation to be successful.

例： For example:

{ "op": "replace", "path": "/a/b/c", "value": 42 }

この演算は、 "remove" 演算の直後に，同じ地点に，置換のための値を "add" 演算により追加するのと、機能的に同じになる。 This operation is functionally identical to a "remove" operation for a value, followed immediately by an "add" operation at the same location with the replacement value.

4.4. move

"move" 演算は、指定された地点から値を除去して，目的地点にその値を追加する。 The "move" operation removes the value at a specified location and adds it to the target location.

演算オブジェクトは、目的文書内の，値の移動元の地点を指す JSON Pointer 文字列値をとる， "from" メンバを含んでいなければならない。 The operation object MUST contain a "from" member, which is a string containing a JSON Pointer value that references the location in the target document to move the value from.

演算が成功とされるためには、 "from" 地点が存在しなければならない。 The "from" location MUST exist for the operation to be successful.

例： For example:

{ "op": "move", "from": "/a/b/c", "path": "/a/b/d" }

この演算は、 "from" 地点に対する "remove" 演算の直後に，その除去された値を， "add" 演算により目的地点に追加するのと、機能的に同じになる。 This operation is functionally identical to a "remove" operation on the "from" location, followed immediately by an "add" operation at the target location with the value that was just removed.

【 従って、移動先の目的地点は，除去された後の状態を基に適用されることになる（特に配列要素を移動させる場合に注意：用例 A.7 を参照）。 】

値をその子孫へ移動させることはできない。 すなわち， "from" が指す地点が "path" が指す地点の適正な真の接頭辞になってはならない。 The "from" location MUST NOT be a proper prefix of the "path" location; i.e., a location cannot be moved into one of its children.

【 “真の接頭辞” （ proper prefix ） — 上の例で述べるなら， "from" が "path" の先頭部分 "/a/b" や "/a" になってはならないが， "path" と同じ "/a/b/d" は許容される。 （文字列として先頭一致する場合でも，例えば "from" が "/a" で "path" が "/ab/c" のような場合は、子孫ではないので “真の接頭辞” とはみなされない。） 】

4.5. copy

"copy" 演算は、指定された地点から目的地点へ値を複製する。 The "copy" operation copies the value at a specified location to the target location.

演算オブジェクトには、目的文書の中の複製元の値の地点を指す JSON Pointer 文字列値をとる， "from" メンバが含まれていなければならない。 The operation object MUST contain a "from" member, which is a string containing a JSON Pointer value that references the location in the target document to copy the value from.

演算が成功とされるためには、 "from" 地点が存在しなければならない。 The "from" location MUST exist for the operation to be successful.

例： For example:

{ "op": "copy", "from": "/a/b/c", "path": "/a/b/e" }

この演算は、 "from" メンバにより指定される値を， "add" 演算により目的地点に追加するのと、機能的に同じになる。 This operation is functionally identical to an "add" operation at the target location using the value specified in the "from" member.

4.6. test

"test" 演算は、目的地点の値が指定された値に等しいかどうかテストする。 The "test" operation tests that a value at the target location is equal to a specified value.

演算オブジェクトには、目的地点の値と比較するための値をとる， "value" メンバが含まれていなければならない。 The operation object MUST contain a "value" member that conveys the value to be compared to the target location's value.

演算が成功と見なされるためには、目的地点の値が "value" の値と等しくなければならない。 The target location MUST be equal to the "value" value for the operation to be considered successful.

ここで “等しい” とは、目的地点の値と "value" の値が同じ JSON 型であって, かつ その型に応じて、次の規則に則って等しいとされることを意味する： Here, "equal" means that the value at the target location and the value conveyed by "value" are of the same JSON type, and that they are considered equal by the following rules for that type:

文字列の場合

互いに同じ個数の Unicode 文字からなり，それぞれの符号位置がバイトごとに等しいとき、等しいとされる。 strings: are considered equal if they contain the same number of Unicode characters and their code points are byte-by-byte equal.

【 バイトごとに（ byte-by-byte ） — Unicode の正準等価などの文字の等価性についての種々の概念は適用せずに，単に符号単位に基づく比較を行うことを指しているものと見られる。 】

数値の場合

互いの値が数値的に等しいとき、等しいとされる。 numbers: are considered equal if their values are numerically equal.

配列の場合

互いの要素数が同じであり、かつ 互いの配列の中の同じ位置の値それぞれが，この型別の比較規則リストの下に 等しいとされるとき、等しいとされる。 arrays: are considered equal if they contain the same number of values, and if each value can be considered equal to the value at the corresponding position in the other array, using this list of type-specific rules.

オブジェクトの場合

(1) 同じ個数のメンバからなり, かつ (2) それらのメンバの（文字列としての）キー名の集合が同じであり, かつ (3) それらのメンバの同じ名前のキーに対応する値が，この型別の比較規則リストの下に 等しいとされるとき、等しいとされる。 objects: are considered equal if they contain the same number of members, and if each member can be considered equal to a member in the other object, by comparing their keys (as strings) and their values (using this list of type-specific rules).

リテラル（ false, true, null ）の場合

２つの値が同じとき，等しいとされる。 literals (false, true, and null): are considered equal if they are the same.

比較は論理的に 【 すなわち， JSON オブジェクトとして解釈された後に 】 行われることに注意。 例えば、配列のメンバ値の合間の空白類は，比較においては有意でない。 Note that the comparison that is done is a logical comparison; e.g., whitespace between the member values of an array is not significant.

オブジェクトメンバの直列化における順序付けも有意でないことに注意。 Also, note that ordering of the serialization of object members is not significant.

例： For example:

{ "op": "test", "path": "/a/b/c", "value": "foo" }

A.1. オブジェクトメンバの追加

目的 JSON 文書の例： An example target JSON document:

{ "foo": "bar"}

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/baz", "value": "qux" }
]

結果の JSON 文書： The resulting JSON document:

{
  "baz": "qux",
  "foo": "bar"
}

A.2. 配列要素の追加

目的 JSON 文書の例： An example target JSON document:

{ "foo": [ "bar", "baz" ] }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/foo/1", "value": "qux" }
]

結果の JSON 文書： The resulting JSON document:

{ "foo": [ "bar", "qux", "baz" ] }

A.3. オブジェクトメンバの除去

目的 JSON 文書の例： An example target JSON document:

{
  "baz": "qux",
  "foo": "bar"
}

JSON Patch 文書： A JSON Patch document:

[
  { "op": "remove", "path": "/baz" }
]

結果の JSON 文書： The resulting JSON document:

{ "foo": "bar" }

A.4. 配列要素の除去

目的 JSON 文書の例： An example target JSON document:

{ "foo": [ "bar", "qux", "baz" ] }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "remove", "path": "/foo/1" }
]

結果の JSON 文書： The resulting JSON document:

{ "foo": [ "bar", "baz" ] }

A.5. 値の置換

目的 JSON 文書の例： An example target JSON document:

{
  "baz": "qux",
  "foo": "bar"
}

JSON Patch 文書： A JSON Patch document:

[
  { "op": "replace", "path": "/baz", "value": "boo" }
]

結果の JSON 文書： The resulting JSON document:

{
  "baz": "boo",
  "foo": "bar"
}

A.6. 値の移動

目的 JSON 文書の例： An example target JSON document:

{
  "foo": {
    "bar": "baz",
    "waldo": "fred"
  },
  "qux": {
    "corge": "grault"
  }
}

JSON Patch 文書： A JSON Patch document:

[
  { "op": "move", "from": "/foo/waldo", "path": "/qux/thud" }
]

結果の JSON 文書： The resulting JSON document:

{
  "foo": {
    "bar": "baz"
  },
  "qux": {
    "corge": "grault",
    "thud": "fred"
  }
}

A.7. 配列要素の移動

目的 JSON 文書の例： An example target JSON document:

{ "foo": [ "all", "grass", "cows", "eat" ] }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "move", "from": "/foo/1", "path": "/foo/3" }
]

結果の JSON 文書： The resulting JSON document:

{ "foo": [ "all", "cows", "eat", "grass" ] }

A.8. 値のテスト（成功）

目的 JSON 文書の例： An example target JSON document:

{
  "baz": "qux",
  "foo": [ "a", 2, "c" ]
}

次の JSON Patch 文書は成功裡に評価される： A JSON Patch document that will result in successful evaluation:

[
  { "op": "test", "path": "/baz", "value": "qux" },
  { "op": "test", "path": "/foo/1", "value": 2 }
]

A.9. 値のテスト（エラー）

目的 JSON 文書の例： An example target JSON document:

{ "baz": "qux" }

次の JSON Patch 文書はエラー状態になる： A JSON Patch document that will result in an error condition:

[
  { "op": "test", "path": "/baz", "value": "bar" }
]

A.10. 入れ子のメンバオブジェクトの追加

目的 JSON 文書の例： An example target JSON document:

{ "foo": "bar" }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/child", "value": { "grandchild": { } } }
]

結果の JSON 文書： The resulting JSON document:

{
  "foo": "bar",
  "child": {
    "grandchild": {
    }
  }
}

A.11. 認識されない要素の無視

目的 JSON 文書の例： An example target JSON document:

{ "foo": "bar" }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/baz", "value": "qux", "xyz": 123 }
]

結果の JSON 文書： The resulting JSON document:

{
  "foo": "bar",
  "baz": "qux"
}

A.12. 存在しない目的地点を伴う追加

目的 JSON 文書の例： An example target JSON document:

{ "foo": "bar" }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/baz/bat", "value": "qux" }
]

この JSON Patch 文書が上の目的 JSON 文書に適用されたときの結果は，エラーになる（したがって，適用されない）。 "add" 演算の目的地点は［ 文書のルート, 既存のオブジェクトのメンバ, 既存の配列のメンバ ］のいずれも指していないので。 This JSON Patch document, applied to the target JSON document above, would result in an error (therefore, it would not be applied), because the "add" operation's target location that references neither the root of the document, nor a member of an existing object, nor a member of an existing array.

A.13. 無効な JSON Patch 文書

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/baz", "value": "qux", "op": "remove" }
]

この JSON Patch 文書は、 "add" 演算を持つものとは見なされない。 後続に "op":"remove" があるので。 JSON のオブジェクトメンバ名は一意的である “べき” とされているので、メンバ名の重複の際の取り扱いは標準的な意味ではエラーにはされないが。 This JSON Patch document cannot be treated as an "add" operation, because it contains a later "op":"remove" element. JSON requires that object member names be unique with a "SHOULD" requirement, and there is no standard error handling for duplicates.

A.14. “~” エスケープの取り扱い

目的 JSON 文書の例： An example target JSON document:

{
  "/": 9,
  "~1": 10
}

JSON Patch 文書： A JSON Patch document:

[
  {"op": "test", "path": "/~01", "value": 10}
]

結果の JSON 文書： The resulting JSON document:

{
  "/": 9,
  "~1": 10
}

【 JSON Pointer "/~01" の “~” エスケープは "~0" のみ展開され，それ以上は展開されない（ "~0" の展開は "~1" の後なので — [RFC6901] の 4 節 Evaluation （和訳）。 】

A.15. 文字列と数値の比較

目的 JSON 文書の例： An example target JSON document:

{
  "/": 9,
  "~1": 10
}

JSON Patch 文書： A JSON Patch document:

[
  {"op": "test", "path": "/~01", "value": "10"}
]

この結果はテストが失敗するのでエラーになる。 文書の方の値は数値である一方，テストされる値は文字列なので。 This results in an error, because the test fails. The document value is numeric, whereas the value being tested for is a string.

A.16. 配列値の追加

目的 JSON 文書の例： An example target JSON document:

{ "foo": ["bar"] }

JSON Patch 文書： A JSON Patch document:

[
  { "op": "add", "path": "/foo/-", "value": ["abc", "def"] }
]

結果の JSON 文書： The resulting JSON document:

{ "foo": ["bar", ["abc", "def"]] }