Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / entity-manager / 17962f456961b16e89ac9f7aac14a5548e3fdbdb / . / schemas / openbmc-dbus.json
blob: 12c974b0e98608a7d9e450547ae6a58b05175c02 [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": {
63 "additionalProperties": false,
64 "properties": {
65 "HostIndex": {
66 "type": ["string", "number"]
67 }
68 },
69 "required": ["HostIndex"],
70 "type": "object"
71 },
Jagpal Singh Gill19ecfb32024-11-02 21:25:36 -0700[diff] [blame]72 "Cable": {
73 "additionalProperties": false,
74 "properties": {
75 "Length": {
76 "type": "number"
77 },
78 "Type": {
79 "enum": ["Optical", "Copper", "Unknown"]
80 }
81 },
82 "required": ["Length", "Type"],
83 "type": "object"
84 },
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]85 "Replaceable": {
86 "additionalProperties": false,
87 "properties": {
88 "FieldReplaceable": {
89 "type": "boolean"
Logananth Sundararaj73963322023-01-24 18:23:44 +0530[diff] [blame]90 },
91 "HotPluggable": {
92 "type": "boolean"
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]93 }
94 },
Logananth Sundararaj73963322023-01-24 18:23:44 +0530[diff] [blame]95 "required": ["FieldReplaceable", "HotPluggable"],
Kumar Thangavele5c473f2023-01-27 15:09:45 +0530[diff] [blame]96 "type": "object"
Delphine CC Chiuec42f452024-02-16 09:54:52 +0800[diff] [blame]97 },
98 "Slot": {
99 "additionalProperties": false,
100 "properties": {
101 "SlotNumber": {
102 "type": ["string", "number"]
103 }
104 },
105 "required": ["SlotNumber"],
106 "type": "object"
Delphine CC Chiub9dbb8c2024-03-28 17:06:07 +0800[diff] [blame]107 },
108 "Revision": {
109 "additionalProperties": false,
110 "properties": {
111 "Version": {
112 "type": "string"
113 }
114 },
115 "required": ["Version"],
116 "type": "object"
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]117 }
118 },
119 "Item": {
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]120 "Board": {
121 "Motherboard": {
122 "additionalProperties": false,
123 "properties": {
124 "ProductId": {
125 "type": "number"
126 }
127 },
Patrick Williamsfa8ee872022-12-07 07:00:42 -0600[diff] [blame]128 "required": ["ProductId"],
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]129 "type": "object"
130 }
131 },
132 "Chassis": {
133 "additionalProperties": false,
Sean Hee153a9d2024-10-25 18:12:17 +0800[diff] [blame]134 "properties": {
Sean He18a81fb2024-12-05 17:51:57 +0800[diff] [blame]135 "Type": {
Sean Hee153a9d2024-10-25 18:12:17 +0800[diff] [blame]136 "type": "string"
137 }
138 },
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]139 "type": "object"
140 },
Chau Lyca144ab2024-04-15 03:54:44 +0000[diff] [blame]141 "NetworkInterface": {
142 "additionalProperties": false,
143 "properties": {
144 "MACAddress": {
145 "type": "string"
146 }
147 },
148 "required": ["MACAddress"],
149 "type": "object"
150 },
Brad Bishop9453a682020-05-07 19:12:46 -0400[diff] [blame]151 "Panel": {
152 "additionalProperties": false,
153 "type": "object"
154 },
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]155 "System": {
156 "additionalProperties": false,
157 "type": "object"
Ingrid Chenc74b06a2024-09-02 14:57:15 +0800[diff] [blame]158 },
159 "BMC": {
160 "additionalProperties": false,
161 "type": "object"
Ingrid Chena037dd62024-09-11 16:33:30 +0800[diff] [blame]162 },
163 "Storage": {
164 "additionalProperties": false,
165 "type": "object"
Sean He8a8f01e2024-11-12 10:19:10 +0800[diff] [blame]166 },
167 "Accelerator": {
168 "additionalProperties": false,
169 "properties": {
170 "Type": {
171 "type": "string"
172 }
173 },
174 "required": ["Type"],
175 "type": "object"
176 },
177 "Dimm": {
178 "additionalProperties": false,
179 "type": "object"
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]180 }
181 }
Hieu Huynhab725312024-02-20 09:03:38 +0000[diff] [blame]182 },
183 "Common": {
184 "UUID": {
185 "additionalProperties": false,
186 "properties": {
187 "UUID": {
188 "type": "string"
189 }
190 },
191 "required": ["UUID"],
192 "type": "object"
193 }
Brad Bishopb9809912020-05-07 17:15:31 -0400[diff] [blame]194 }
195 }
196 }
197 }
198}