Skip to content

Commit a44b5b2

Browse files
committed
update README
1 parent 625cab2 commit a44b5b2

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
json-patch-tests
1+
JSON Patch Tests
22
================
33

4-
Test cases for implementations of json-patch:
4+
These are test cases for implementations of the [IETF JSON Patch
5+
draft](http://tools.ietf.org/html/draft-ietf-appsawg-json-patch).
56

6-
http://tools.ietf.org/html/draft-ietf-appsawg-json-patch-02
77

8-
Test format
8+
Test Format
99
-----------
1010

11-
The test file contains a list of test records, each with a few
12-
fields that defines a test.
11+
Each test file is a JSON document that contains an array of test records. A
12+
test record is an object with the following members:
1313

1414
- doc: The JSON document to test against
15-
- patch: The patch(es) to apply.
15+
- patch: The patch(es) to apply
1616
- expected: The expected resulting document, OR
1717
- error: A string describing an expected error
1818
- comment: A string describing the test
19-
- disabled: True if the test should be skipped.
19+
- disabled: True if the test should be skipped
2020

21-
All fields except 'doc' and 'patch' are optional. Test records consisting only of a comment are also OK.
21+
All fields except 'doc' and 'patch' are optional. Test records consisting only
22+
of a comment are also OK.
2223

23-
This test set is not complete, or even correct - help welcome!
24+
These tests are not complete, or even correct - help welcome!
2425

2526
Credits
2627
-------
2728

28-
The seed test set was adapted from https://github.com/bruth/jsonpatch-js/blob/master/test.js .
29-
29+
The seed test set was adapted from Byron Ruth's
30+
[jsonpatch-js](https://github.com/bruth/jsonpatch-js/blob/master/test.js) and
31+
extended by [Mike McCabe](https://github.com/mikemccabe).

0 commit comments

Comments
 (0)