openstack/openstack-manuals
Code Issues Proposed changes
9381741e63
openstack-manuals/doc/doc-contrib-guide/source/json-conv.rst
Alexandra Settle 85107272be [contrib-guide] Updating url to doc-contrib-guide 
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +00:00

1.1 KiB
Raw Blame History

JSON conventions

OpenStack uses JSON format. Use the following JSON formatting conventions:

  • Format JSON files to be human readable.
  • Use four spaces for indentation (matching OpenStack conventions used in Python and shell scripts). Do not use tab characters in the code, always use spaces.
  • Use one space after the name-separator (colon).
  • Obey the formal JSON format; in particular, wrap strings in double (not single) quotes.
  • Sample files may have their keys ordered if that makes the file easier to understand. Automatic reformatting tools 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"
}