1# config_file
2
3## Description
4
5The root (outer-most) object in a phosphor-regulators configuration file.
6
7## Properties
8
9| Name     | Required | Type                           | Description                                          |
10| :------- | :------: | :----------------------------- | :--------------------------------------------------- |
11| comments |    no    | array of strings               | One or more comment lines describing this file.      |
12| rules    |    no    | array of [rules](rule.md)      | One or more rules shared by regulators in this file. |
13| chassis  |   yes    | array of [chassis](chassis.md) | One or more chassis in the system.                   |
14
15## Example
16
17```
18{
19  "comments": [ "Config file for a FooBar one-chassis system" ],
20  "rules": [
21    {
22      "id": "set_voltage_rule",
23      ... details omitted ...
24    },
25    {
26      "id": "read_sensors_rule",
27      ... details omitted ...
28    }
29  ],
30  "chassis": [
31    {
32      "number": 1,
33      "inventory_path": "system/chassis",
34      "devices": [
35        ... details omitted ...
36      ]
37    }
38  ]
39}
40```
41