Jump to: navigation, search

Difference between revisions of "Documentation/JSON conventions"

(Created page with "{{OpenStack_Documentation_Navbar}} {{OpenStack_Conventions_Navbar}} = JSON formatting conventions = Format JSON files to be human readable. Use four spaces for indentation (m...")
 
Line 2: Line 2:
 
{{OpenStack_Conventions_Navbar}}
 
{{OpenStack_Conventions_Navbar}}
  
= JSON formatting conventions =
+
 
 +
== JSON formatting conventions ==
 +
 
 
Format JSON files to be human readable. Use four spaces for indentation (matching OpenStack conventions used in Python and shell scripts), and one space after the name-separator (colon). Obey the formal JSON format; in particular, strings are in double (not single) quotes.
 
Format JSON files to be human readable. Use four spaces for indentation (matching OpenStack conventions used in Python and shell scripts), and one space after the name-separator (colon). Obey the formal JSON format; in particular, strings are in double (not single) quotes.
  

Revision as of 08:22, 27 July 2014


JSON formatting conventions

Format JSON files to be human readable. Use four spaces for indentation (matching OpenStack conventions used in Python and shell scripts), and one space after the name-separator (colon). Obey the formal JSON format; in particular, strings are in double (not single) quotes.

Sample files may have their keys ordered if that makes the file easier to understand. Automatic reformatting tools are to preserve the order of keys.

Example:

{
    "uuid": "d8e02d56-2648-49a3-bf97-6be8f1204f38",
    "availability_zone": "nova",
    "hostname": "test.novalocal",
    "launch_index": 0,
    "array0": [],
    "array1": [
        "low"
    ],
    "array3": [
        "low",
        "high",
        "mid"
    ],
    "object0": {},
    "object1": {
        "value": "low",
        "role": "some"
    },
    "name": "test"
}