fcrozat/distribution
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update JSON spec to point out escaping of <, >, &

Browse Source 
...and add blurb about not relying on canonicalization to ensure
identical output.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
This commit is contained in:
Aaron Lehmann 2015-08-24 16:27:40 -07:00
parent e4b93d1e6d
commit 4cb5626d9e
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/spec/json.md
View File

@ -17,6 +17,10 @@ To provide consistent content hashing of JSON objects throughout Docker
Distribution APIs, the specification defines a canonical JSON format. Adopting Distribution APIs, the specification defines a canonical JSON format. Adopting
such a canonicalization also aids in caching JSON responses. such a canonicalization also aids in caching JSON responses.
Note that protocols should not be designed to depend on identical JSON being
generated across different versions or clients. The canonicalization rules are
merely useful for caching and consistency.
## Rules ## Rules
Compliant JSON should conform to the following rules: Compliant JSON should conform to the following rules:
@ -28,6 +32,8 @@ Compliant JSON should conform to the following rules:
keys shall always appear in lexically sorted order. keys shall always appear in lexically sorted order.
4. All whitespace between tokens should be removed. 4. All whitespace between tokens should be removed.
5. No "trailing commas" are allowed in object or array definitions. 5. No "trailing commas" are allowed in object or array definitions.
6. The angle brackets "<" and ">" are escaped to "\u003c" and "\u003e".
Ampersand "&" is escaped to "\u0026".
## Examples ## Examples