openstack-manuals/doc/contributor-guide/source/json-conventions.rst
Olena Logvinova 808ac7e64f [Contrib Guide] Backport section to RST & final edits
This patch:
- translates the below wiki page to RST:
  https://wiki.openstack.org/wiki/Documentation/HowTo#Git_commit_messages_and_backports
- creates a new folder called Additional Git workflow and moves the file
  cherry-pick.rst to this folder;
- replaces '_' with '-' in some file names for consistency;
- changes the files order in the index.html file;
- updates text for the Abstract section in Introduction.

Change-Id: Icd66e1af93a12f1c3fc827ce228001dced9aa065
Implements: blueprint docs-contributor-guide
2015-10-22 17:15:02 +03:00

1.1 KiB

JSON 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). 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"
}