James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 1 | { |
Brad Bishop | 64d7cec | 2020-05-01 10:00:23 -0400 | [diff] [blame] | 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
Brad Bishop | 8e659b5 | 2020-05-07 17:31:04 -0400 | [diff] [blame] | 3 | "definitions": { |
Brad Bishop | ada40c5 | 2020-05-07 19:32:05 -0400 | [diff] [blame] | 4 | "EMExposesElement": { |
| 5 | "description": [ |
| 6 | "The exposes property element schema. An element of the exposes ", |
| 7 | "property is always an array where elements are of type exposes ", |
| 8 | "entry." |
| 9 | ], |
| 10 | "oneOf": [ |
| 11 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 12 | "$ref": "ibm.json#/definitions/IBMCompatibleSystem" |
Brad Bishop | 648ae63 | 2020-10-09 08:20:12 -0400 | [diff] [blame] | 13 | }, |
| 14 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 15 | "$ref": "ibm.json#/definitions/IBMCFFPSConnector" |
Brad Bishop | 4afe708 | 2020-10-01 09:59:26 -0400 | [diff] [blame] | 16 | }, |
| 17 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 18 | "$ref": "intel.json#/definitions/IntelFanConnector" |
Brad Bishop | dc10828 | 2020-09-24 19:01:28 -0400 | [diff] [blame] | 19 | }, |
| 20 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 21 | "$ref": "pid.json#/definitions/Pid" |
Brad Bishop | 4fa1d39 | 2020-05-07 20:27:15 -0400 | [diff] [blame] | 22 | }, |
| 23 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 24 | "$ref": "pid_zone.json#/definitions/PidZone" |
Brad Bishop | 4fa1d39 | 2020-05-07 20:27:15 -0400 | [diff] [blame] | 25 | }, |
| 26 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 27 | "$ref": "stepwise.json#/definitions/Stepwise" |
Brad Bishop | 4fa1d39 | 2020-05-07 20:27:15 -0400 | [diff] [blame] | 28 | }, |
| 29 | { |
Brad Bishop | ada40c5 | 2020-05-07 19:32:05 -0400 | [diff] [blame] | 30 | "$ref": "legacy.json#/definitions/Aggregate" |
| 31 | }, |
| 32 | { |
Brad Bishop | 7d05ee5 | 2022-05-26 16:27:48 -0400 | [diff] [blame] | 33 | "$ref": "virtual_sensor.json#/definitions/VirtualSensor" |
Rashmica Gupta | e23af56 | 2021-07-29 15:12:16 +1000 | [diff] [blame] | 34 | }, |
| 35 | { |
Brad Bishop | ada40c5 | 2020-05-07 19:32:05 -0400 | [diff] [blame] | 36 | "description": [ |
| 37 | "Ensure the parent oneOf schema does not validate ", |
| 38 | "when an element does not define a type property." |
| 39 | ], |
| 40 | "not": { |
Patrick Williams | fa8ee87 | 2022-12-07 07:00:42 -0600 | [diff] [blame] | 41 | "required": ["Type"] |
Brad Bishop | ada40c5 | 2020-05-07 19:32:05 -0400 | [diff] [blame] | 42 | }, |
| 43 | "title": "Missing Type" |
| 44 | }, |
| 45 | { |
| 46 | "description": [ |
| 47 | "Ensure the parent oneOf schema does not validate ", |
| 48 | "when an element does not define a name property." |
| 49 | ], |
| 50 | "not": { |
Patrick Williams | fa8ee87 | 2022-12-07 07:00:42 -0600 | [diff] [blame] | 51 | "required": ["Name"] |
Brad Bishop | ada40c5 | 2020-05-07 19:32:05 -0400 | [diff] [blame] | 52 | }, |
| 53 | "title": "Missing Name" |
| 54 | } |
| 55 | ], |
| 56 | "title": "Exposes Property Element" |
| 57 | }, |
Brad Bishop | 8e659b5 | 2020-05-07 17:31:04 -0400 | [diff] [blame] | 58 | "EMConfig": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame] | 59 | "title": "Entity Manager Configuration", |
| 60 | "description": [ |
| 61 | "The schema for an entity manager configuration. An entity ", |
| 62 | "manager configuration describes an association between a ", |
| 63 | "match condition, also known as a probe, and an array of ", |
| 64 | "heterogeneous configuration data. When a probe match ", |
| 65 | "occurs, the configuration data is exported to DBus." |
| 66 | ], |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 67 | "additionalProperties": false, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 68 | "type": "object", |
| 69 | "properties": { |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 70 | "Bus": { |
| 71 | "type": "string" |
| 72 | }, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 73 | "Exposes": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame] | 74 | "description": [ |
| 75 | "The schema for the exposes property. The exposes ", |
| 76 | "property must be an array where elements are of ", |
| 77 | "type EMExposesElement. The exposes property is the ", |
| 78 | "heterogeneous configuration data exported to DBus ", |
| 79 | "upon a probe match." |
| 80 | ], |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 81 | "type": "array", |
| 82 | "items": { |
Brad Bishop | ada40c5 | 2020-05-07 19:32:05 -0400 | [diff] [blame] | 83 | "$ref": "#/definitions/EMExposesElement" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 84 | } |
| 85 | }, |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 86 | "Logging": { |
Patrick Williams | fa8ee87 | 2022-12-07 07:00:42 -0600 | [diff] [blame] | 87 | "enum": ["Off"] |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 88 | }, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 89 | "Name": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame] | 90 | "description": [ |
| 91 | "The schema for the name property. The name property ", |
| 92 | "identifies the configuration. When exported, the ", |
| 93 | "configuration will be instantiated at: ", |
| 94 | "/xyz/openbmc_project/configuration/<Type>/<Name>" |
| 95 | ], |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 96 | "type": "string" |
| 97 | }, |
| 98 | "Probe": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame] | 99 | "description": [ |
| 100 | "The schema for an entity manager probe statement. ", |
| 101 | "Probes can be a single string or an array. Probes ", |
| 102 | "describe a match condition, for example when a DBus ", |
| 103 | "property has a specific value. When the match condition", |
| 104 | " occurs, the information described by the Exposes ", |
| 105 | "property is exported onto the DBus." |
| 106 | ], |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 107 | "anyOf": [ |
| 108 | { |
| 109 | "type": "string" |
| 110 | }, |
| 111 | { |
| 112 | "type": "array", |
| 113 | "items": { |
| 114 | "type": "string" |
| 115 | } |
| 116 | } |
| 117 | ] |
| 118 | }, |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 119 | "Type": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame] | 120 | "title": "Configuration Type", |
| 121 | "description": [ |
| 122 | "The schema for the type property. The type property", |
| 123 | "identifies the type of the configuration. When exported,", |
| 124 | "configurations will be instantiated as children of: ", |
| 125 | "/xyz/openbmc_project/configuration/<Type>" |
| 126 | ], |
Patrick Williams | fa8ee87 | 2022-12-07 07:00:42 -0600 | [diff] [blame] | 127 | "enum": ["Board", "Chassis", "NVMe", "PowerSupply"] |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 128 | }, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 129 | "xyz.openbmc_project.Inventory.Decorator.Asset": { |
Brad Bishop | b980991 | 2020-05-07 17:15:31 -0400 | [diff] [blame] | 130 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Decorator/Asset" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 131 | }, |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 132 | "ProductId": { |
| 133 | "type": "number" |
| 134 | }, |
| 135 | "xyz.openbmc_project.Inventory.Decorator.AssetTag": { |
Brad Bishop | b980991 | 2020-05-07 17:15:31 -0400 | [diff] [blame] | 136 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Decorator/AssetTag" |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 137 | }, |
Kumar Thangavel | e5c473f | 2023-01-27 15:09:45 +0530 | [diff] [blame^] | 138 | "xyz.openbmc_project.Inventory.Decorator.Replaceable": { |
| 139 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Decorator/Replaceable" |
| 140 | }, |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 141 | "xyz.openbmc_project.Inventory.Item.Board.Motherboard": { |
| 142 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/Board/Motherboard" |
| 143 | }, |
| 144 | "xyz.openbmc_project.Inventory.Item.Chassis": { |
| 145 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/Chassis" |
| 146 | }, |
| 147 | "xyz.openbmc_project.Inventory.Item.Panel": { |
| 148 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/Panel" |
| 149 | }, |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 150 | "xyz.openbmc_project.Inventory.Item.System": { |
Brad Bishop | b980991 | 2020-05-07 17:15:31 -0400 | [diff] [blame] | 151 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/System" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 152 | } |
| 153 | }, |
Patrick Williams | fa8ee87 | 2022-12-07 07:00:42 -0600 | [diff] [blame] | 154 | "required": ["Exposes", "Name", "Probe", "Type"] |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 155 | } |
Brad Bishop | 8e659b5 | 2020-05-07 17:31:04 -0400 | [diff] [blame] | 156 | }, |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame] | 157 | "title": "Entity Manager Configuration File", |
| 158 | "description": [ |
| 159 | "The schema for an entity manager configuration file. An entity ", |
| 160 | "mananger configuration file can consist of a single object, or an ", |
| 161 | "array of objects. Objects must be of type EMConfig." |
| 162 | ], |
Brad Bishop | 8e659b5 | 2020-05-07 17:31:04 -0400 | [diff] [blame] | 163 | "anyOf": [ |
| 164 | { |
| 165 | "type": "array", |
| 166 | "items": { |
| 167 | "$ref": "#/definitions/EMConfig" |
| 168 | } |
| 169 | }, |
| 170 | { |
| 171 | "$ref": "#/definitions/EMConfig" |
| 172 | } |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 173 | ] |
| 174 | } |