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