[要約] RFC 7396は、JSON Merge Patchというデータ形式を定義しています。この形式は、既存のJSONデータを変更するための効率的な方法を提供します。目的は、JSONデータの部分的な更新やマージを容易にすることです。
Internet Engineering Task Force (IETF) P. Hoffman
Request for Comments: 7396 VPN Consortium
Obsoletes: 7386 J. Snell
Category: Standards Track October 2014
ISSN: 2070-1721
JSON Merge Patch
JSONマージパッチ
Abstract
概要
This specification defines the JSON merge patch format and processing rules. The merge patch format is primarily intended for use with the HTTP PATCH method as a means of describing a set of modifications to a target resource's content.
この仕様は、JSONマージパッチ形式と処理ルールを定義します。マージパッチ形式は主に、ターゲットリソースのコンテンツに対する一連の変更を記述する手段としてHTTP PATCHメソッドで使用することを目的としています。
Status of This Memo
本文書の状態
This is an Internet Standards Track document.
これはInternet Standards Trackドキュメントです。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 5741.
このドキュメントは、IETF（Internet Engineering Task Force）の製品です。これは、IETFコミュニティのコンセンサスを表しています。公開レビューを受け、インターネットエンジニアリングステアリンググループ（IESG）による公開が承認されました。インターネット標準の詳細については、RFC 5741のセクション2をご覧ください。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7396.
このドキュメントの現在のステータス、エラータ、およびフィードバックの提供方法に関する情報は、http：//www.rfc-editor.org/info/rfc7396で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2014 IETF Trustおよびドキュメントの作成者として識別された人物。全著作権所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
この文書は、BCP 78およびこの文書の発行日に有効なIETF文書に関するIETFトラストの法的規定（http://trustee.ietf.org/license-info）の対象となります。これらのドキュメントは、このドキュメントに関するあなたの権利と制限を説明しているため、注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、Trust Legal Provisionsのセクション4.eに記載されているSimplified BSD Licenseのテキストが含まれている必要があり、Simplified BSD Licenseに記載されているように保証なしで提供されます。
Table of Contents
目次
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Processing Merge Patch Documents . . . . . . . . . . . . . . 3
3. Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5
5. Security Considerations . . . . . . . . . . . . . . . . . . . 6
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 7
6.1. Normative References . . . . . . . . . . . . . . . . . . 7
6.2. Informative References . . . . . . . . . . . . . . . . . 7
Appendix A. Example Test Cases . . . . . . . . . . . . . . . . . 8
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9
This specification defines the JSON merge patch document format, processing rules, and associated MIME media type identifier. The merge patch format is primarily intended for use with the HTTP PATCH method [RFC5789] as a means of describing a set of modifications to a target resource's content.
この仕様は、JSONマージパッチドキュメント形式、処理ルール、および関連するMIMEメディアタイプ識別子を定義します。マージパッチ形式は、ターゲットリソースのコンテンツに対する一連の変更を記述する手段として、主にHTTP PATCHメソッド[RFC5789]で使用することを目的としています。
A JSON merge patch document describes changes to be made to a target JSON document using a syntax that closely mimics the document being modified. Recipients of a merge patch document determine the exact set of changes being requested by comparing the content of the provided patch against the current content of the target document. If the provided merge patch contains members that do not appear within the target, those members are added. If the target does contain the member, the value is replaced. Null values in the merge patch are given special meaning to indicate the removal of existing values in the target.
JSONマージパッチドキュメントは、変更中のドキュメントによく似た構文を使用して、ターゲットJSONドキュメントに加えられる変更を記述します。マージパッチドキュメントの受信者は、提供されたパッチのコンテンツをターゲットドキュメントの現在のコンテンツと比較することにより、要求されている変更の正確なセットを決定します。提供されたマージパッチにターゲット内に表示されないメンバーが含まれている場合、それらのメンバーが追加されます。ターゲットにメンバーが含まれている場合、値は置き換えられます。マージパッチのnull値には、ターゲットの既存の値の削除を示す特別な意味が与えられます。
For example, given the following original JSON document:
たとえば、次の元のJSONドキュメントがあるとします。
{
"a": "b",
"c": {
"d": "e",
"f": "g"
}
}
Changing the value of "a" and removing "f" can be achieved by
sending:
PATCH /target HTTP/1.1
Host: example.org
Content-Type: application/merge-patch+json
{
"a":"z",
"c": {
"f": null
}
}
When applied to the target resource, the value of the "a" member is replaced with "z" and "f" is removed, leaving the remaining content untouched.
ターゲットリソースに適用されると、「a」メンバーの値は「z」に置き換えられ、「f」は削除され、残りのコンテンツはそのままになります。
This design means that merge patch documents are suitable for describing modifications to JSON documents that primarily use objects for their structure and do not make use of explicit null values. The merge patch format is not appropriate for all JSON syntaxes.
この設計は、マージパッチドキュメントが、主にオブジェクトを構造に使用し、明示的なnull値を使用しないJSONドキュメントへの変更を記述するのに適していることを意味します。マージパッチ形式は、すべてのJSON構文に適しているわけではありません。
JSON merge patch documents describe, by example, a set of changes that are to be made to a target resource. Recipients of merge patch documents are responsible for comparing the merge patch with the current content of the target resource to determine the specific set of change operations to be applied to the target.
JSONマージパッチドキュメントは、例として、ターゲットリソースに対して行われる一連の変更を記述します。マージパッチドキュメントの受信者は、マージパッチとターゲットリソースの現在のコンテンツを比較して、ターゲットに適用される変更操作の特定のセットを決定します。
To apply the merge patch document to a target resource, the system realizes the effect of the following function, described in pseudocode. For this description, the function is called MergePatch, and it takes two arguments: the target resource document and the merge patch document. The Target argument can be any JSON value or undefined. The Patch argument can be any JSON value.
マージパッチドキュメントをターゲットリソースに適用するために、システムは、疑似コードで説明されている次の関数の効果を実現します。この説明では、関数はMergePatchと呼ばれ、ターゲットリソースドキュメントとマージパッチドキュメントの2つの引数を取ります。 Target引数は、任意のJSON値または未定義にすることができます。 Patch引数には、任意のJSON値を指定できます。
define MergePatch(Target, Patch):
if Patch is an Object:
if Target is not an Object:
Target = {} # Ignore the contents and set it to an empty Object
for each Name/Value pair in Patch:
if Value is null:
if Name exists in Target:
remove the Name/Value pair from Target
else:
Target[Name] = MergePatch(Target[Name], Value)
return Target
else:
return Patch
There are a few things to note about the function. If the patch is anything other than an object, the result will always be to replace the entire target with the entire patch. Also, it is not possible to patch part of a target that is not an object, such as to replace just some of the values in an array.
関数について注意すべき点がいくつかあります。パッチがオブジェクト以外の場合、結果として常にターゲット全体がパッチ全体で置き換えられます。また、配列内の一部の値だけを置き換えるなど、オブジェクトではないターゲットの一部にパッチを適用することはできません。
The MergePatch operation is defined to operate at the level of data items, not at the level of textual representation. There is no expectation that the MergePatch operation will preserve features at the textual-representation level such as white space, member ordering, number precision beyond what is available in the target's implementation, and so forth. In addition, even if the target implementation allows multiple name/value pairs with the same name, the result of the MergePatch operation on such objects is not defined.
MergePatch操作は、テキスト表現のレベルではなく、データ項目のレベルで動作するように定義されています。 MergePatch操作が、空白、メンバーの順序、ターゲットの実装で利用可能な数を超える数の精度などのテキスト表現レベルで機能を保持することは期待されていません。さらに、ターゲット実装で同じ名前の複数の名前/値ペアが許可されている場合でも、そのようなオブジェクトに対するMergePatch操作の結果は定義されていません。
Given the following example JSON document:
次のJSONドキュメントの例を考えます。
{
"title": "Goodbye!",
"author" : {
"givenName" : "John",
"familyName" : "Doe"
},
"tags":[ "example", "sample" ],
"content": "This will be unchanged"
}
A user agent wishing to change the value of the "title" member from
"Goodbye!" to the value "Hello!", add a new "phoneNumber" member,
remove the "familyName" member from the "author" object, and replace
the "tags" array so that it doesn't include the word "sample" would
send the following request:
PATCH /my/resource HTTP/1.1
Host: example.org
Content-Type: application/merge-patch+json
{
"title": "Hello!",
"phoneNumber": "+01-123-456-7890",
"author": {
"familyName": null
},
"tags": [ "example" ]
}
The resulting JSON document would be:
結果のJSONドキュメントは次のようになります。
{
"title": "Hello!",
"author" : {
"givenName" : "John"
},
"tags": [ "example" ],
"content": "This will be unchanged",
"phoneNumber": "+01-123-456-7890"
}
This specification registers the following additional MIME media types:
この仕様は、次の追加のMIMEメディアタイプを登録します。
Type name: application
タイプ名：アプリケーション
Subtype name: merge-patch+json
サブタイプ名：merge-patch + json
Required parameters: None
必須パラメーター：なし
Optional parameters: None
オプションのパラメーター：なし
Encoding considerations: Resources that use the "application/ merge-patch+json" media type are required to conform to the "application/json" media type and are therefore subject to the same encoding considerations specified in Section 8 of [RFC7159].
エンコーディングの考慮事項：「application / merge-patch + json」メディアタイプを使用するリソースは、「application / json」メディアタイプに準拠する必要があるため、[RFC7159]のセクション8で指定されているものと同じエンコーディングの考慮事項に従います。
Security considerations: As defined in this specification
セキュリティに関する考慮事項：この仕様で定義されているとおり
Published specification: This specification.
公開された仕様：この仕様。
Applications that use this media type: None currently known.
このメディアタイプを使用するアプリケーション：現在のところ不明です。
Additional information:
追加情報：
Magic number(s): N/A
File extension(s): N/A
Macintosh file type code(s): TEXT
Macintoshファイルタイプコード：TEXT
Person & email address to contact for further information: IESG
詳細について連絡する人とメールアドレス：IESG
Intended usage: COMMON
使用目的：COMMON
Restrictions on usage: None
使用上の制限：なし
Author: James M. Snell <jasnell@gmail.com>
Change controller: IESG
コントローラーの変更：IESG
The "application/merge-patch+json" media type allows user agents to indicate their intention for the server to determine the specific set of change operations to be applied to a target resource. As such, it is the server's responsibility to determine the appropriateness of any given change as well as the user agent's authorization to request such changes. How such determinations are made is considered out of the scope of this specification.
「application / merge-patch + json」メディアタイプを使用すると、ユーザーエージェントは、サーバーがターゲットリソースに適用される変更操作の特定のセットを決定する意図を示すことができます。したがって、特定の変更の適切性、およびそのような変更を要求するユーザーエージェントの承認を決定するのはサーバーの責任です。そのような決定がどのように行われるかは、この仕様の範囲外と見なされます。
All of the security considerations discussed in Section 5 of [RFC5789] apply to all uses of the HTTP PATCH method with the "application/merge-patch+json" media type.
[RFC5789]のセクション5で説明されているセキュリティに関する考慮事項はすべて、「application / merge-patch + json」メディアタイプを使用するHTTP PATCHメソッドのすべての使用に適用されます。
[RFC7159] Bray, T., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 7159, March 2014, <http://www.rfc-editor.org/info/rfc7159>.
[RFC7159]ブレイ、T。、「JavaScriptオブジェクト記法（JSON）データ交換形式」、RFC 7159、2014年3月、<http://www.rfc-editor.org/info/rfc7159>。
[RFC5789] Dusseault, L. and J. Snell, "PATCH Method for HTTP", RFC 5789, March 2010, <http://www.rfc-editor.org/info/rfc5789>.
[RFC5789] Dusseault、L.およびJ. Snell、「PATCH Method for HTTP」、RFC 5789、2010年3月、<http://www.rfc-editor.org/info/rfc5789>。
ORIGINAL PATCH RESULT
------------------------------------------
{"a":"b"} {"a":"c"} {"a":"c"}
{"a":"b"} {"b":"c"} {"a":"b",
"b":"c"}
{"a":"b"} {"a":null} {}
{"a":"b", {"a":null} {"b":"c"}
"b":"c"}
{"a":["b"]} {"a":"c"} {"a":"c"}
{"a":"c"} {"a":["b"]} {"a":["b"]}
{"a": { {"a": { {"a": {
"b": "c"} "b": "d", "b": "d"
} "c": null} }
} }
{"a": [ {"a": [1]} {"a": [1]}
{"b":"c"}
]
}
["a","b"] ["c","d"] ["c","d"]
["a"、 "b"] ["c"、 "d"] ["c"、 "d"]
{"a":"b"} ["c"] ["c"]
{"a":"foo"} null null
{"a":"foo"} "bar" "bar"
{"e":null} {"a":1} {"e":null,
"a":1}
[1,2] {"a":"b", {"a":"b"}
"c":null}
{} {"a": {"a":
{"bb": {"bb":
{"ccc": {}}}
null}}}
Acknowledgments
謝辞
Many people contributed significant ideas to this document. These people include, but are not limited to, James Manger, Matt Miller, Carsten Bormann, Bjoern Hoehrmann, Pete Resnick, and Richard Barnes.
多くの人々がこの文書に重要なアイデアを提供しました。これらの人々には、James Manger、Matt Miller、Carsten Bormann、Bjoern Hoehrmann、Pete Resnick、およびRichard Barnesが含まれますが、これらに限定されません。
Authors' Addresses
著者のアドレス
Paul Hoffman VPN Consortium
ポールホフマンVPNコンソーシアム
EMail: paul.hoffman@vpnc.org
James M. Snell
ジェームズ・M・スネル
EMail: jasnell@gmail.com