| < draft-ietf-appsawg-json-patch-04.txt | draft-ietf-appsawg-json-patch-05.txt > | |||
|---|---|---|---|---|
| Applications Area Working Group P. Bryan, Ed. | Applications Area Working Group P. Bryan, Ed. | |||
| Internet-Draft Salesforce.com | Internet-Draft Salesforce.com | |||
| Intended status: Informational M. Nottingham, Ed. | Intended status: Informational M. Nottingham, Ed. | |||
| Expires: March 21, 2013 September 17, 2012 | Expires: March 30, 2013 September 26, 2012 | |||
| JSON Patch | JSON Patch | |||
| draft-ietf-appsawg-json-patch-04 | draft-ietf-appsawg-json-patch-05 | |||
| Abstract | Abstract | |||
| JSON Patch defines the media type "application/json-patch", a JSON | JSON Patch defines the media type "application/json-patch", a JSON | |||
| document structure for expressing a sequence of operations to apply | document structure for expressing a sequence of operations to apply | |||
| to a JSON document. | to a JSON document. | |||
| Status of this Memo | Status of this Memo | |||
| This Internet-Draft is submitted in full conformance with the | This Internet-Draft is submitted in full conformance with the | |||
| skipping to change at page 1, line 32 ¶ | skipping to change at page 1, line 32 ¶ | |||
| Internet-Drafts are working documents of the Internet Engineering | Internet-Drafts are working documents of the Internet Engineering | |||
| Task Force (IETF). Note that other groups may also distribute | Task Force (IETF). Note that other groups may also distribute | |||
| working documents as Internet-Drafts. The list of current Internet- | working documents as Internet-Drafts. The list of current Internet- | |||
| Drafts is at http://datatracker.ietf.org/drafts/current/. | Drafts is at http://datatracker.ietf.org/drafts/current/. | |||
| Internet-Drafts are draft documents valid for a maximum of six months | Internet-Drafts are draft documents valid for a maximum of six months | |||
| and may be updated, replaced, or obsoleted by other documents at any | and may be updated, replaced, or obsoleted by other documents at any | |||
| time. It is inappropriate to use Internet-Drafts as reference | time. It is inappropriate to use Internet-Drafts as reference | |||
| material or to cite them other than as "work in progress." | material or to cite them other than as "work in progress." | |||
| This Internet-Draft will expire on March 21, 2013. | This Internet-Draft will expire on March 30, 2013. | |||
| Copyright Notice | Copyright Notice | |||
| Copyright (c) 2012 IETF Trust and the persons identified as the | Copyright (c) 2012 IETF Trust and the persons identified as the | |||
| document authors. All rights reserved. | document authors. All rights reserved. | |||
| This document is subject to BCP 78 and the IETF Trust's Legal | This document is subject to BCP 78 and the IETF Trust's Legal | |||
| Provisions Relating to IETF Documents | Provisions Relating to IETF Documents | |||
| (http://trustee.ietf.org/license-info) in effect on the date of | (http://trustee.ietf.org/license-info) in effect on the date of | |||
| publication of this document. Please review these documents | publication of this document. Please review these documents | |||
| skipping to change at page 2, line 10 ¶ | skipping to change at page 2, line 10 ¶ | |||
| to this document. Code Components extracted from this document must | to this document. Code Components extracted from this document must | |||
| include Simplified BSD License text as described in Section 4.e of | include Simplified BSD License text as described in Section 4.e of | |||
| the Trust Legal Provisions and are provided without warranty as | the Trust Legal Provisions and are provided without warranty as | |||
| described in the Simplified BSD License. | described in the Simplified BSD License. | |||
| Table of Contents | Table of Contents | |||
| 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 | 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 | |||
| 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 3 | 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 3 | |||
| 3. Document Structure . . . . . . . . . . . . . . . . . . . . . . 3 | 3. Document Structure . . . . . . . . . . . . . . . . . . . . . . 3 | |||
| 4. Operations . . . . . . . . . . . . . . . . . . . . . . . . . . 3 | 4. Operations . . . . . . . . . . . . . . . . . . . . . . . . . . 4 | |||
| 4.1. add . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 | 4.1. add . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 | |||
| 4.2. remove . . . . . . . . . . . . . . . . . . . . . . . . . . 4 | 4.2. remove . . . . . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 4.3. replace . . . . . . . . . . . . . . . . . . . . . . . . . 5 | 4.3. replace . . . . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 4.4. move . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 | 4.4. move . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 4.5. copy . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 | 4.5. copy . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 | |||
| 4.6. test . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 | 4.6. test . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 | |||
| 5. Error Handling . . . . . . . . . . . . . . . . . . . . . . . . 7 | 5. Error Handling . . . . . . . . . . . . . . . . . . . . . . . . 8 | |||
| 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 | 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 | |||
| 7. Security Considerations . . . . . . . . . . . . . . . . . . . 9 | 7. Security Considerations . . . . . . . . . . . . . . . . . . . 9 | |||
| 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 9 | 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 9 | |||
| 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 9 | 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 9 | |||
| 9.1. Normative References . . . . . . . . . . . . . . . . . . . 9 | 9.1. Normative References . . . . . . . . . . . . . . . . . . . 9 | |||
| 9.2. Informative References . . . . . . . . . . . . . . . . . . 9 | 9.2. Informative References . . . . . . . . . . . . . . . . . . 10 | |||
| Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 10 | Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 10 | |||
| A.1. Adding an Object Member . . . . . . . . . . . . . . . . . 10 | A.1. Adding an Object Member . . . . . . . . . . . . . . . . . 10 | |||
| A.2. Adding an Array Element . . . . . . . . . . . . . . . . . 10 | A.2. Adding an Array Element . . . . . . . . . . . . . . . . . 11 | |||
| A.3. Removing an Object Member . . . . . . . . . . . . . . . . 11 | A.3. Removing an Object Member . . . . . . . . . . . . . . . . 11 | |||
| A.4. Removing an Array Element . . . . . . . . . . . . . . . . 11 | A.4. Removing an Array Element . . . . . . . . . . . . . . . . 11 | |||
| A.5. Replacing a Value . . . . . . . . . . . . . . . . . . . . 12 | A.5. Replacing a Value . . . . . . . . . . . . . . . . . . . . 12 | |||
| A.6. Moving a Value . . . . . . . . . . . . . . . . . . . . . . 12 | A.6. Moving a Value . . . . . . . . . . . . . . . . . . . . . . 12 | |||
| A.7. Moving an Array Element . . . . . . . . . . . . . . . . . 13 | A.7. Moving an Array Element . . . . . . . . . . . . . . . . . 13 | |||
| A.8. Testing a Value: Success . . . . . . . . . . . . . . . . . 13 | A.8. Testing a Value: Success . . . . . . . . . . . . . . . . . 13 | |||
| A.9. Testing a Value: Error . . . . . . . . . . . . . . . . . . 14 | A.9. Testing a Value: Error . . . . . . . . . . . . . . . . . . 14 | |||
| A.10. Adding a nested Member Object . . . . . . . . . . . . . . 14 | A.10. Adding a nested Member Object . . . . . . . . . . . . . . 14 | |||
| Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 14 | Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 14 | |||
| 1. Introduction | 1. Introduction | |||
| JavaScript Object Notation (JSON) [RFC4627] is a common format for | JavaScript Object Notation (JSON) [RFC4627] is a common format for | |||
| the exchange and storage of structured data. HTTP PATCH [RFC5789] | the exchange and storage of structured data. HTTP PATCH [RFC5789] | |||
| extends the Hypertext Transfer Protocol (HTTP) [RFC2616] with a | extends the Hypertext Transfer Protocol (HTTP) [RFC2616] with a | |||
| method to perform partial modifications to resources. | method to perform partial modifications to resources. | |||
| The JSON Patch media type "application/json-patch" is a JSON document | JSON Patch is a format (identified by the media type "application/ | |||
| structure for expressing a sequence of operations to apply to a | json-patch") for expressing a sequence of operations to apply to a | |||
| target JSON document, suitable for use with the HTTP PATCH method. | target JSON document, suitable for use with the HTTP PATCH method. | |||
| 2. Conventions | 2. Conventions | |||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | |||
| "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | |||
| document are to be interpreted as described in RFC 2119 [RFC2119]. | document are to be interpreted as described in RFC 2119 [RFC2119]. | |||
| See Section 5 for information about handling errors. | ||||
| 3. Document Structure | 3. Document Structure | |||
| A JSON Patch document contains a JSON array of objects. Each object | A JSON Patch document is a JSON [RFC4627] document whose root object | |||
| contains a single operation to apply to the target JSON document. | is an array of objects. Each object represents a single operation to | |||
| be applied to the target JSON document. | ||||
| An example JSON Patch document: | An example JSON Patch document: | |||
| [ | [ | |||
| { "test": "/a/b/c", "value": "foo" }, | { "op": "test", "path": "/a/b/c", "value": "foo" }, | |||
| { "remove": "/a/b/c" }, | { "op": "remove", "path": "/a/b/c" }, | |||
| { "add": "/a/b/c", "value": [ "foo", "bar" ] }, | { "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] }, | |||
| { "replace": "/a/b/c", "value": 42 }, | { "op": "replace", "path": "/a/b/c", "value": 42 }, | |||
| { "move": "/a/b/c", "to": "/a/b/d" }, | { "op": "move", "path": "/a/b/c", "to": "/a/b/d" }, | |||
| { "copy": "/a/b/c", "to": "/a/b/e" } | { "op": "copy", "path": "/a/b/c", "to": "/a/b/e" } | |||
| ] | ] | |||
| Evaluation of a JSON Patch document begins with a target JSON | Evaluation of a JSON Patch document begins with a target JSON | |||
| document. Operations are applied sequentially in the order they | document. Operations are applied sequentially in the order they | |||
| appear in the array. Each operation in the sequence is applied to | appear in the array. Each operation in the sequence is applied to | |||
| the target document; the resulting document becomes the target of the | the target document; the resulting document becomes the target of the | |||
| next operation. Evaluation continues until all operations are | next operation. Evaluation continues until all operations are | |||
| successfully applied or an error condition is encountered. | successfully applied, or an error condition is encountered. | |||
| 4. Operations | 4. Operations | |||
| The operation to perform is expressed in a member of the operation | Operation objects MUST have exactly one "op" member, whose value | |||
| object. The name of the operation member is one of: "add", "remove", | indicates the operation to perform. Its value MUST be one of "add", | |||
| "replace", "move", "copy" or "test". | "remove", "replace", "move", "copy" or "test". The semantics of each | |||
| is defined below. | ||||
| The member value is a string containing a [JSON-Pointer] value that | Additionally, operation objects MUST have exactly one "path" member, | |||
| whose value MUST be a string containing a [JSON-Pointer] value that | ||||
| references the location within the target document to perform the | references the location within the target document to perform the | |||
| operation. It is an error condition if an operation object contains | operation (the "target location"). | |||
| no recognized operation member or more than one operation member. | ||||
| Other members of operation objects MUST be ignored, unless they are | ||||
| explicitly allowed by the definition of the operation. | ||||
| Note that the ordering of members in JSON objects is not significant; | ||||
| therefore, the following operations are equivalent: | ||||
| { "op": "add", "path": "/a/b/c", "value": "foo" } | ||||
| { "path": "/a/b/c", "op": "add", "value": "foo" } | ||||
| { "value": "foo", "path": "/a/b/c", "op": "add" } | ||||
| 4.1. add | 4.1. add | |||
| The "add" operation adds a new value at the specified location in the | The "add" operation adds a new value at the target location. The | |||
| target document. The location must reference one of: the root of the | operation object MUST contain a "value" member that specifies the | |||
| target document, a member to add to an existing object, or an element | value to be added. | |||
| to add to an existing array. The operation object contains a "value" | ||||
| member that specifies the value to be added. | ||||
| Example: | When the operation is applied, the target location MUST reference one | |||
| of: | ||||
| { "add": "/a/b/c", "value": [ "foo", "bar" ] } | o the root of the target document, | |||
| If the location references the root of the target document or a | o a member to add to an existing object, or | |||
| member of an existing object, it is an error condition if a value at | ||||
| the specified location already exists. | ||||
| If the location references an element of an existing array, any | o an element to add to an existing array. | |||
| elements at or above the specified index are shifted one position to | ||||
| the right. It is an error condition if the specified index is | ||||
| greater than the number of elements in the array. | ||||
| Note that this operation will, in common use, contain a JSON Pointer | For example: | |||
| that does not resolve to an existing value in the target document. | ||||
| As such, the pointer's error handling algorithm is invoked. This | ||||
| specification defines the error handling algorithm for "add" pointers | ||||
| to explicitly ignore the error and perform the operation as | ||||
| specified. | ||||
| It is an error condition if the "value" member is not present. | { "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] } | |||
| If the target location references the root of the target document or | ||||
| a member of an existing object, the specified location MUST already | ||||
| exist for the operation to be successful. | ||||
| If the target location references an element of an existing array, | ||||
| 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. | ||||
| Note that this operation will, in common use, have a target location | ||||
| that does not resolve to an existing value, resulting in the | ||||
| pointer's error handling algorithm being invoked. This specification | ||||
| defines the error handling algorithm for "add" pointers to explicitly | ||||
| ignore the error and perform the operation as specified. | ||||
| 4.2. remove | 4.2. remove | |||
| The "remove" operation removes the value at the specified location in | The "remove" operation removes the value at the specified location. | |||
| the target document. | ||||
| Example: | The value at the specified location MUST exist for the operation to | |||
| be successful. | ||||
| { "remove": "/a/b/c" } | For example: | |||
| { "op": "remove", "path": "/a/b/c" } | ||||
| If removing an element from an array, any elements above the | If removing an element from an array, any elements above the | |||
| specified index are shifted one position to the left. | specified index are shifted one position to the left. | |||
| It is an error condition if a value at the specified location does | ||||
| not exist. | ||||
| 4.3. replace | 4.3. replace | |||
| The "replace" operation replaces the value at the specified location | The "replace" operation replaces the value at the specified location | |||
| in the target document with a new value. The operation object | with a new value. The operation object MUST contain a "value" member | |||
| contains a "value" member that specifies the replacement value. | that specifies the replacement value. | |||
| Example: | The value at the specified location MUST exist for the operation to | |||
| be successful. | ||||
| { "replace": "/a/b/c", "value": 42 } | For example: | |||
| { "op": "replace", "path": "/a/b/c", "value": 42 } | ||||
| This operation is functionally identical to expressing a "remove" | This operation is functionally identical to expressing a "remove" | |||
| operation for a value, followed immediately by an "add" operation at | operation for a value, followed immediately by an "add" operation at | |||
| the same location with the replacement value. | the same location with the replacement value. | |||
| It is an error condition if a value at the specified location does | 4.4. move | |||
| not exist. | ||||
| It is an error condition if the "value" member is not present. | The "move" operation removes the value at the specified location and | |||
| adds it to another location in the target document. | ||||
| 4.4. move | The operation object MUST contain a "to" member, a string containing | |||
| a JSON Pointer value that references the location in the target | ||||
| document to add the value to. | ||||
| The "move" operation removes the value at one location and adds it to | The "to" location MUST reference one of: | |||
| another location in the target document. | ||||
| The operation object contains a "to" member, a string containing a | o the member to add to an existing object, or | |||
| JSON Pointer value that references the location in the target | ||||
| document to add the value to. This location must reference one of: | ||||
| the member to add to an existing object, or an element to add to an | ||||
| existing array. | ||||
| Example: | o an element to add to an existing array. | |||
| { "move": "/a/b/c", "to": "/a/b/d" } | For example: | |||
| { "op": "move", "path": "/a/b/c", "to": "/a/b/d" } | ||||
| This operation is functionally identical to expressing a "remove" | This operation is functionally identical to expressing a "remove" | |||
| operation, followed immediately by an "add" operation at the new | operation on the specified location, followed immediately by an "add" | |||
| location with the value that was just removed. Moving a value to its | operation at the "to" location with the value that was just removed. | |||
| current location can be safely ignored. | ||||
| If the location in the "to" member references a member of an existing | The location in the "to" member MUST NOT reference a member of an | |||
| object in the target document, it is an error condition if a value at | existing object in the target document, unless "move" and "to" | |||
| the specified location already exists (unless "move" and "to" specify | specify the same object, which has no effect. | |||
| the same object, which has no effect). | ||||
| If the location in the "to" member references an element of an | If the location in the "to" member references an element of an | |||
| existing array, any elements at or above the specified index are | existing array, any elements at or above the specified index are | |||
| shifted one position to the right. It is an error condition if the | shifted one position to the right. The specified index MUST NOT be | |||
| specified index is greater than the number of elements in the array. | greater than the number of elements in the array. | |||
| It is an error condition if the "to" member is not present. | ||||
| 4.5. copy | 4.5. copy | |||
| The "copy" operation copies the value at one location to another | The "copy" operation copies the value at the specified location to | |||
| location in the target document. | another location in the target document. | |||
| The operation object contains a "to" member, a string containing a | The operation object MUST contain a "to" member, a string containing | |||
| JSON Pointer value that references the location in the target | a JSON Pointer value that references the location in the target | |||
| document to add the value to. This location must reference one of: | document to add the value to. | |||
| the member to add to an existing object, or an element to add to an | ||||
| existing array. | ||||
| Example: | This location MUST reference one of: | |||
| { "copy": "/a/b/c", "to": "/a/b/e" } | o the member to add to an existing object, or | |||
| If the location in the "to" member references a member of an existing | o an element to add to an existing array. | |||
| object in the target document, it is an error condition if a value at | ||||
| the specified location already exists. | For example: | |||
| { "op": "copy", "path": "/a/b/c", "to": "/a/b/e" } | ||||
| The location in the "to" member MUST NOT reference a member of an | ||||
| existing object in the target document, unless "move" and "to" | ||||
| specify the same object, which has no effect. | ||||
| If the location in the "to" member references an element of an | If the location in the "to" member references an element of an | |||
| existing array, any elements at or above the specified index are | existing array, any elements at or above the specified index are | |||
| shifted one position to the right. It is an error condition if the | shifted one position to the right. The specified index MUST NOT be | |||
| specified index is greater than the number of elements in the array. | greater than the number of elements in the array. | |||
| It is an error condition if the "to" member is not present. | ||||
| 4.6. test | 4.6. test | |||
| The "test" operation tests that a value at the specified location in | The "test" operation tests that a value at the specified location is | |||
| the target document is equal to a specified value. The operation | equal to a value. | |||
| object contains a "value" member that specifies the value to test | ||||
| for. | ||||
| Here, "equal" means that the target and specified values are of the | The operation object MUST contain a "value" member that conveys the | |||
| same JSON type, and considered equal by the following rules for that | value to be compared to that at the specified location. | |||
| type: | ||||
| The value at the specified location MUST be equal to the specified | ||||
| value for the operation to be considered successful. | ||||
| Here, "equal" means that the value at the specified location and the | ||||
| value conveyed by "value" are of the same JSON type, and considered | ||||
| equal by the following rules for that type: | ||||
| o strings: are considered equal if, after unescaping any sequence(s) | o strings: are considered equal if, after unescaping any sequence(s) | |||
| in both strings starting with a reverse solidus, they contain the | in both strings starting with a reverse solidus, they contain the | |||
| same number of Unicode characters and their code points are | same number of Unicode characters and their code points are | |||
| position-wise equal. | position-wise equal. | |||
| o numbers: are considered equal if subtracting one from the other | o numbers: are considered equal if subtracting one from the other | |||
| results in 0. | results in 0. | |||
| o arrays: are considered equal if they contain the same number of | o arrays: are considered equal if they contain the same number of | |||
| skipping to change at page 7, line 26 ¶ | skipping to change at page 7, line 48 ¶ | |||
| o literals (false, true and null): are considered equal if they are | o literals (false, true and null): are considered equal if they are | |||
| the same. | the same. | |||
| Note that this is a logical comparison; e.g., whitespace between the | Note that this is a logical comparison; e.g., whitespace between the | |||
| member values of an array is not significant. | member values of an array is not significant. | |||
| Also, note that ordering of the serialisation of object members is | Also, note that ordering of the serialisation of object members is | |||
| not significant. | not significant. | |||
| Example: | ||||
| { "test": "/a/b/c", "value": "foo" } | ||||
| It is an error condition if the value at the specified location is | ||||
| not equal to the specified value. | ||||
| If the value is not specified, the test is only for presence, not | ||||
| value. | ||||
| For example: | For example: | |||
| { "test": "/a/b/c" } | { "op": "test", "path": "/a/b/c", "value": "foo" } | |||
| merely tests that the indicated structure is present in the target | ||||
| document. | ||||
| 5. Error Handling | 5. Error Handling | |||
| If an error condition occurs, evaluation of the JSON Patch document | If a RFC2119 [RFC2119] requirement is violated by a JSON Patch | |||
| SHOULD terminate and application of the entire patch document SHALL | document, or if an operation is not successful, evaluation of the | |||
| NOT be deemed successful. Note that as per [RFC5789], when used with | JSON Patch document SHOULD terminate and application of the entire | |||
| the PATCH HTTP method, it is atomic. | patch document SHALL NOT be deemed successful. | |||
| Therefore, the following patch would result in no changes being made | See [RFC5789], Section 2.2 for considerations regarding handling | |||
| to the document at all (because the "test" operation results in an | errors when JSON Patch is used with the HTTP PATCH method, including | |||
| error). | suggested status codes to use to indicate various conditions. | |||
| Note that as per [RFC5789], when used with the PATCH HTTP method, it | ||||
| is atomic. Therefore, the following patch would result in no changes | ||||
| being made to the document at all (because the "test" operation | ||||
| results in an error). | ||||
| [ | [ | |||
| {"replace": "/a/b/c", "value": 42}, | { "op": "replace", "path": "/a/b/c", "value": 42 }, | |||
| {"test": "/a/b/c", "value": "C"} | { "op": "test", "path": "/a/b/c", "value": "C" } | |||
| ] | ] | |||
| 6. IANA Considerations | 6. IANA Considerations | |||
| The Internet media type for a JSON Patch document is application/ | The Internet media type for a JSON Patch document is application/ | |||
| json-patch. | json-patch. | |||
| Type name: application | Type name: application | |||
| Subtype name: json-patch | Subtype name: json-patch | |||
| skipping to change at page 9, line 24 ¶ | skipping to change at page 9, line 38 ¶ | |||
| This specification has the same security considerations as JSON | This specification has the same security considerations as JSON | |||
| [RFC4627] and [JSON-Pointer]. | [RFC4627] and [JSON-Pointer]. | |||
| 8. Acknowledgements | 8. Acknowledgements | |||
| The following individuals contributed ideas, feedback and wording to | The following individuals contributed ideas, feedback and wording to | |||
| this specification: | this specification: | |||
| Mike Acar, Mike Amundsen, Paul Davis, Murray S. Kucherawy, Dean | Mike Acar, Mike Amundsen, Paul Davis, Murray S. Kucherawy, Dean | |||
| Landolt, Randall Leeds, Julian Reschke, James Snell, Eli Stevens. | Landolt, Randall Leeds, James Manger, Julian Reschke, James Snell, | |||
| Eli Stevens. | ||||
| The structure of a JSON Patch document was influenced by the XML | The structure of a JSON Patch document was influenced by the XML | |||
| Patch document [RFC5261] specification. | Patch document [RFC5261] specification. | |||
| 9. References | 9. References | |||
| 9.1. Normative References | 9.1. Normative References | |||
| [JSON-Pointer] | [JSON-Pointer] | |||
| Bryan, P. and K. Zyp, "JSON Pointer", | Bryan, P. and K. Zyp, "JSON Pointer", | |||
| skipping to change at page 10, line 25 ¶ | skipping to change at page 10, line 39 ¶ | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "add": "/baz", "value": "qux" } | { "op": "add", "path": "/baz", "value": "qux" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "baz": "qux", | "baz": "qux", | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A.2. Adding an Array Element | A.2. Adding an Array Element | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "foo": [ "bar", "baz" ] | "foo": [ "bar", "baz" ] | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "add": "/foo/1", "value": "qux" } | { "op": "add", "path": "/foo/1", "value": "qux" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "foo": [ "bar", "qux", "baz" ] | "foo": [ "bar", "qux", "baz" ] | |||
| } | } | |||
| A.3. Removing an Object Member | A.3. Removing an Object Member | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "baz": "qux", | "baz": "qux", | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "remove": "/baz" } | { "op": "remove", "path": "/baz" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A.4. Removing an Array Element | A.4. Removing an Array Element | |||
| skipping to change at page 11, line 37 ¶ | skipping to change at page 12, line 4 ¶ | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A.4. Removing an Array Element | A.4. Removing an Array Element | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "foo": [ "bar", "qux", "baz" ] | "foo": [ "bar", "qux", "baz" ] | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "remove": "/foo/1" } | { "op": "remove", "path": "/foo/1" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "foo": [ "bar", "baz" ] | "foo": [ "bar", "baz" ] | |||
| } | } | |||
| A.5. Replacing a Value | A.5. Replacing a Value | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "baz": "qux", | "baz": "qux", | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "replace": "/baz", "value": "boo" } | { "op": "replace", "path": "/baz", "value": "boo" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "baz": "boo", | "baz": "boo", | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A.6. Moving a Value | A.6. Moving a Value | |||
| skipping to change at page 12, line 40 ¶ | skipping to change at page 13, line 4 ¶ | |||
| { | { | |||
| "foo": { | "foo": { | |||
| "bar": "baz", | "bar": "baz", | |||
| "waldo": "fred" | "waldo": "fred" | |||
| } | } | |||
| "qux": { | "qux": { | |||
| "corge": "grault" | "corge": "grault" | |||
| } | } | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "move": "/foo/waldo", to: "/qux/thud" } | { "op": "move", "path": "/foo/waldo", to: "/qux/thud" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "foo": { | "foo": { | |||
| "bar": "baz" | "bar": "baz" | |||
| } | } | |||
| "qux": { | "qux": { | |||
| "corge": "grault", | "corge": "grault", | |||
| skipping to change at page 13, line 26 ¶ | skipping to change at page 13, line 33 ¶ | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "foo": [ "all", "grass", "cows", "eat" ] | "foo": [ "all", "grass", "cows", "eat" ] | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "move": "/foo/1", "to": "/foo/3" } | { "op": "move", "path": "/foo/1", "to": "/foo/3" } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "foo": [ "all", "cows", "eat", "grass" ] | "foo": [ "all", "cows", "eat", "grass" ] | |||
| } | } | |||
| A.8. Testing a Value: Success | A.8. Testing a Value: Success | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "baz": "qux", | "baz": "qux", | |||
| "foo": [ "a", 2, "c" ] | "foo": [ "a", 2, "c" ] | |||
| } | } | |||
| A JSON Patch document that will result in successful evaluation: | A JSON Patch document that will result in successful evaluation: | |||
| [ | [ | |||
| { "test": "/baz", "value": "qux" }, | { "op": "test", "path": "/baz", "value": "qux" }, | |||
| { "test": "/foo/1", "value": 2 } | { "op": "test", "path": "/foo/1", "value": 2 } | |||
| ] | ] | |||
| A.9. Testing a Value: Error | A.9. Testing a Value: Error | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "baz": "qux" | "baz": "qux" | |||
| } | } | |||
| A JSON Patch document that will result in an error condition: | A JSON Patch document that will result in an error condition: | |||
| [ | [ | |||
| { "test": "/baz", "value": "bar" } | { "op": "test", "path": "/baz", "value": "bar" } | |||
| ] | ] | |||
| A.10. Adding a nested Member Object | A.10. Adding a nested Member Object | |||
| An example target JSON document: | An example target JSON document: | |||
| { | { | |||
| "foo": "bar" | "foo": "bar" | |||
| } | } | |||
| A JSON Patch document: | A JSON Patch document: | |||
| [ | [ | |||
| { "add": "/child", "value": { "grandchild": { } } } | { "op": "add", "path": "/child", "value": { "grandchild": { } } } | |||
| ] | ] | |||
| The resulting JSON document: | The resulting JSON document: | |||
| { | { | |||
| "foo": "bar", | "foo": "bar", | |||
| "child": { | "child": { | |||
| "grandchild": { | "grandchild": { | |||
| } | } | |||
| } | } | |||
| End of changes. 66 change blocks. | ||||
| 142 lines changed or deleted | 154 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ | ||||