Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / entity-manager / 31a109c49c5e67a67fd0d8f696be6c5ccf4c7682 / . / schemas / openbmc-dbus.json
blob: 05d46697efb5beaca6783e0bd823dc5589e06f3c [file] [log] [blame]
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "Schemas for JSON representations of OpenBMC DBus interfaces",
Patrick Williams7d6080d2024-09-04 12:54:45 -0400[diff] [blame]4 "$defs": {
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]5 "xyz": {
6 "openbmc_project": {
7 "Inventory": {
8 "Decorator": {
9 "Asset": {
10 "additionalProperties": false,
11 "properties": {
Yi-Shum32a4c122024-04-09 11:17:05 +0800[diff] [blame]12 "BuildDate": {
13 "type": "string"
14 },
Delphine CC Chiua4aebdc2024-05-15 16:23:54 +0800[diff] [blame]15 "SparePartNumber": {
16 "type": "string"
17 },
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]18 "Manufacturer": {
19 "type": "string"
20 },
21 "Model": {
22 "type": "string"
23 },
24 "PartNumber": {
25 "type": "string"
26 },
27 "SerialNumber": {
28 "type": "string"
29 }
30 },
31 "required": [
32 "Manufacturer",
33 "Model",
34 "PartNumber",
35 "SerialNumber"
36 ],
37 "type": "object"
38 },
39 "AssetTag": {
40 "additionalProperties": false,
41 "properties": {
42 "AssetTag": {
43 "type": "string"
44 }
45 },
Patrick Williamsfa8ee872022-12-07 07:00:42 -0600[diff] [blame]46 "required": ["AssetTag"],
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]47 "type": "object"
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]48 },
Chau Ly61854782023-11-29 10:16:33 +0000[diff] [blame]49 "Compatible": {
50 "additionalProperties": false,
51 "properties": {
52 "Names": {
53 "type": "array",
54 "items": {
55 "type": "string"
56 }
57 }
58 },
59 "required": ["Names"],
60 "type": "object"
61 },
Oliver Brewkabdad3d52024-08-21 18:49:37 +0200[diff] [blame]62 "ManagedHost": {
Alexander Hansen31a109c2025-07-21 12:20:48 +0200[diff] [blame^]63 "description": "Used to enumerate hosts from 1 to N on multi-host platforms. Set to 0 for a single-host system. Can be used to map a host to e.g. a systemd service instance.",
Oliver Brewkabdad3d52024-08-21 18:49:37 +0200[diff] [blame]64 "additionalProperties": false,
65 "properties": {
66 "HostIndex": {
67 "type": ["string", "number"]
68 }
69 },
70 "required": ["HostIndex"],
71 "type": "object"
72 },
Jagpal Singh Gill19ecfb32024-11-02 21:25:36 -0700[diff] [blame]73 "Cable": {
74 "additionalProperties": false,
75 "properties": {
76 "Length": {
77 "type": "number"
78 },
79 "Type": {
80 "enum": ["Optical", "Copper", "Unknown"]
81 }
82 },
83 "required": ["Length", "Type"],
84 "type": "object"
85 },
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]86 "Replaceable": {
87 "additionalProperties": false,
88 "properties": {
89 "FieldReplaceable": {
90 "type": "boolean"
Logananth Sundararaj73963322023-01-24 18:23:44 +0530[diff] [blame]91 },
92 "HotPluggable": {
93 "type": "boolean"
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]94 }
95 },
Logananth Sundararaj73963322023-01-24 18:23:44 +0530[diff] [blame]96 "required": ["FieldReplaceable", "HotPluggable"],
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]97 "type": "object"
Delphine CC Chiuec42f452024-02-16 09:54:52 +0800[diff] [blame]98 },
99 "Slot": {
100 "additionalProperties": false,
101 "properties": {
102 "SlotNumber": {
103 "type": ["string", "number"]
104 }
105 },
106 "required": ["SlotNumber"],
107 "type": "object"
Delphine CC Chiub9dbb8c2024-03-28 17:06:07 +0800[diff] [blame]108 },
109 "Revision": {
110 "additionalProperties": false,
111 "properties": {
112 "Version": {
113 "type": "string"
114 }
115 },
116 "required": ["Version"],
117 "type": "object"
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]118 }
119 },
120 "Item": {
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]121 "Board": {
122 "Motherboard": {
123 "additionalProperties": false,
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]124 "type": "object"
125 }
126 },
127 "Chassis": {
128 "additionalProperties": false,
Sean Hee153a9d2024-10-25 18:12:17 +0800[diff] [blame]129 "properties": {
Sean He18a81fb2024-12-05 17:51:57 +0800[diff] [blame]130 "Type": {
Sean Hee153a9d2024-10-25 18:12:17 +0800[diff] [blame]131 "type": "string"
132 }
133 },
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]134 "type": "object"
135 },
Chau Lyca144ab2024-04-15 03:54:44 +0000[diff] [blame]136 "NetworkInterface": {
137 "additionalProperties": false,
138 "properties": {
139 "MACAddress": {
140 "type": "string"
141 }
142 },
143 "required": ["MACAddress"],
144 "type": "object"
145 },
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]146 "Panel": {
147 "additionalProperties": false,
148 "type": "object"
149 },
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]150 "System": {
151 "additionalProperties": false,
152 "type": "object"
Ingrid Chenc74b06a2024-09-02 14:57:15 +0800[diff] [blame]153 },
Thang Trancc403b42024-12-13 14:53:30 +0700[diff] [blame]154 "Bmc": {
Ingrid Chenc74b06a2024-09-02 14:57:15 +0800[diff] [blame]155 "additionalProperties": false,
156 "type": "object"
Ingrid Chena037dd62024-09-11 16:33:30 +0800[diff] [blame]157 },
158 "Storage": {
159 "additionalProperties": false,
160 "type": "object"
Sean He8a8f01e2024-11-12 10:19:10 +0800[diff] [blame]161 },
162 "Accelerator": {
163 "additionalProperties": false,
164 "properties": {
165 "Type": {
166 "type": "string"
167 }
168 },
169 "required": ["Type"],
170 "type": "object"
171 },
172 "Dimm": {
173 "additionalProperties": false,
174 "type": "object"
Jagpal Singh Gilldf8f5582025-01-22 15:50:36 -0800[diff] [blame]175 },
176 "Valve": {
177 "additionalProperties": false,
178 "properties": {
179 "Direction": {
180 "enum": ["Supply", "Return", "Unknown"]
181 },
182 "PairName": {
183 "description": "This property specifies the pair name for valves when they form a supply and return valve pair; otherwise, it is set to NA.",
184 "type": "string"
185 }
186 },
187 "required": ["Direction", "PairName"],
188 "type": "object"
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]189 }
190 }
Hieu Huynhab725312024-02-20 09:03:38 +0000[diff] [blame]191 },
192 "Common": {
193 "UUID": {
194 "additionalProperties": false,
195 "properties": {
196 "UUID": {
197 "type": "string"
198 }
199 },
200 "required": ["UUID"],
201 "type": "object"
202 }
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]203 }
204 }
205 }
206 }
207}