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": { |
| 4 | "EMConfig": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame^] | 5 | "title": "Entity Manager Configuration", |
| 6 | "description": [ |
| 7 | "The schema for an entity manager configuration. An entity ", |
| 8 | "manager configuration describes an association between a ", |
| 9 | "match condition, also known as a probe, and an array of ", |
| 10 | "heterogeneous configuration data. When a probe match ", |
| 11 | "occurs, the configuration data is exported to DBus." |
| 12 | ], |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 13 | "additionalProperties": false, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 14 | "type": "object", |
| 15 | "properties": { |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 16 | "Bus": { |
| 17 | "type": "string" |
| 18 | }, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 19 | "Exposes": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame^] | 20 | "description": [ |
| 21 | "The schema for the exposes property. The exposes ", |
| 22 | "property must be an array where elements are of ", |
| 23 | "type EMExposesElement. The exposes property is the ", |
| 24 | "heterogeneous configuration data exported to DBus ", |
| 25 | "upon a probe match." |
| 26 | ], |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 27 | "type": "array", |
| 28 | "items": { |
Brad Bishop | 6666588 | 2020-05-07 17:05:18 -0400 | [diff] [blame] | 29 | "$ref": "legacy.json#/definitions/Aggregate" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 30 | } |
| 31 | }, |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 32 | "Logging": { |
| 33 | "enum": [ |
| 34 | "Off" |
| 35 | ] |
| 36 | }, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 37 | "Name": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame^] | 38 | "description": [ |
| 39 | "The schema for the name property. The name property ", |
| 40 | "identifies the configuration. When exported, the ", |
| 41 | "configuration will be instantiated at: ", |
| 42 | "/xyz/openbmc_project/configuration/<Type>/<Name>" |
| 43 | ], |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 44 | "type": "string" |
| 45 | }, |
| 46 | "Probe": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame^] | 47 | "description": [ |
| 48 | "The schema for an entity manager probe statement. ", |
| 49 | "Probes can be a single string or an array. Probes ", |
| 50 | "describe a match condition, for example when a DBus ", |
| 51 | "property has a specific value. When the match condition", |
| 52 | " occurs, the information described by the Exposes ", |
| 53 | "property is exported onto the DBus." |
| 54 | ], |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 55 | "anyOf": [ |
| 56 | { |
| 57 | "type": "string" |
| 58 | }, |
| 59 | { |
| 60 | "type": "array", |
| 61 | "items": { |
| 62 | "type": "string" |
| 63 | } |
| 64 | } |
| 65 | ] |
| 66 | }, |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 67 | "Type": { |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame^] | 68 | "title": "Configuration Type", |
| 69 | "description": [ |
| 70 | "The schema for the type property. The type property", |
| 71 | "identifies the type of the configuration. When exported,", |
| 72 | "configurations will be instantiated as children of: ", |
| 73 | "/xyz/openbmc_project/configuration/<Type>" |
| 74 | ], |
Brad Bishop | 45d42a5 | 2020-05-07 19:19:49 -0400 | [diff] [blame] | 75 | "enum": [ |
| 76 | "Board", |
| 77 | "Chassis", |
| 78 | "NVMe", |
| 79 | "PowerSupply" |
| 80 | ] |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 81 | }, |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 82 | "xyz.openbmc_project.Inventory.Decorator.Asset": { |
Brad Bishop | b980991 | 2020-05-07 17:15:31 -0400 | [diff] [blame] | 83 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Decorator/Asset" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 84 | }, |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 85 | "ProductId": { |
| 86 | "type": "number" |
| 87 | }, |
| 88 | "xyz.openbmc_project.Inventory.Decorator.AssetTag": { |
Brad Bishop | b980991 | 2020-05-07 17:15:31 -0400 | [diff] [blame] | 89 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Decorator/AssetTag" |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 90 | }, |
Brad Bishop | 9453a68 | 2020-05-07 19:12:46 -0400 | [diff] [blame] | 91 | "xyz.openbmc_project.Inventory.Item.Board.Motherboard": { |
| 92 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/Board/Motherboard" |
| 93 | }, |
| 94 | "xyz.openbmc_project.Inventory.Item.Chassis": { |
| 95 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/Chassis" |
| 96 | }, |
| 97 | "xyz.openbmc_project.Inventory.Item.Panel": { |
| 98 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/Panel" |
| 99 | }, |
James Feist | 60d93d2 | 2019-07-10 15:08:35 -0700 | [diff] [blame] | 100 | "xyz.openbmc_project.Inventory.Item.System": { |
Brad Bishop | b980991 | 2020-05-07 17:15:31 -0400 | [diff] [blame] | 101 | "$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/System" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 102 | } |
| 103 | }, |
| 104 | "required": [ |
| 105 | "Exposes", |
| 106 | "Name", |
Brad Bishop | 45d42a5 | 2020-05-07 19:19:49 -0400 | [diff] [blame] | 107 | "Probe", |
| 108 | "Type" |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 109 | ] |
| 110 | } |
Brad Bishop | 8e659b5 | 2020-05-07 17:31:04 -0400 | [diff] [blame] | 111 | }, |
Brad Bishop | 2189d61 | 2020-05-07 19:27:44 -0400 | [diff] [blame^] | 112 | "title": "Entity Manager Configuration File", |
| 113 | "description": [ |
| 114 | "The schema for an entity manager configuration file. An entity ", |
| 115 | "mananger configuration file can consist of a single object, or an ", |
| 116 | "array of objects. Objects must be of type EMConfig." |
| 117 | ], |
Brad Bishop | 8e659b5 | 2020-05-07 17:31:04 -0400 | [diff] [blame] | 118 | "anyOf": [ |
| 119 | { |
| 120 | "type": "array", |
| 121 | "items": { |
| 122 | "$ref": "#/definitions/EMConfig" |
| 123 | } |
| 124 | }, |
| 125 | { |
| 126 | "$ref": "#/definitions/EMConfig" |
| 127 | } |
James Feist | 1e3e698 | 2018-08-03 16:09:28 -0700 | [diff] [blame] | 128 | ] |
| 129 | } |