blob: 440e67065c2178ade19d8486b748553580171f6a [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills09b9d452020-02-11 13:27:39 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/Assembly.v1_2_3.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/Assembly",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Ed Tanouscb103132019-10-08 11:34:22 -07005 "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07009 "description": "The available actions for this Resource.",
10 "longDescription": "This type shall contain the available actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
26 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -080027 "$ref": "#/definitions/OemActions",
Ed Tanouscb103132019-10-08 11:34:22 -070028 "description": "The available OEM-specific actions for this Resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070030 }
31 },
32 "type": "object"
33 },
34 "Assembly": {
35 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -070036 "description": "The Assembly schema defines an assembly. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.",
37 "longDescription": "This Resource shall represent an assembly for a Redfish implementation. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -070038 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070039 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070040 "description": "This property shall specify a valid odata or Redfish property.",
41 "type": [
42 "array",
43 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080044 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070045 "number",
46 "null",
47 "object",
48 "string"
49 ]
50 }
51 },
52 "properties": {
53 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -070054 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous118b1c72018-09-13 13:45:51 -070055 },
56 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -070057 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -070058 },
59 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -070060 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -070061 },
62 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -070063 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -070064 },
65 "Actions": {
66 "$ref": "#/definitions/Actions",
Ed Tanouscb103132019-10-08 11:34:22 -070067 "description": "The available actions for this Resource.",
68 "longDescription": "This property shall contain the available actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070069 },
70 "Assemblies": {
Ed Tanous530520e2019-01-02 13:41:37 -080071 "autoExpand": true,
Ed Tanouscb103132019-10-08 11:34:22 -070072 "description": "The assembly records.",
Ed Tanous118b1c72018-09-13 13:45:51 -070073 "items": {
74 "$ref": "#/definitions/AssemblyData"
75 },
Ed Tanouscb103132019-10-08 11:34:22 -070076 "longDescription": "These properties shall define assembly records for a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -070077 "readonly": false,
78 "type": "array"
79 },
80 "Assemblies@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -070081 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -070082 },
83 "Description": {
84 "anyOf": [
85 {
86 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
87 },
88 {
89 "type": "null"
90 }
91 ],
92 "readonly": true
93 },
94 "Id": {
95 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
96 "readonly": true
97 },
98 "Name": {
99 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
100 "readonly": true
101 },
102 "Oem": {
103 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700104 "description": "The OEM extension property.",
105 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700106 }
107 },
108 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800109 "@odata.id",
110 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700111 "Id",
112 "Name"
113 ],
114 "type": "object"
115 },
116 "AssemblyData": {
117 "additionalProperties": false,
118 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700119 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700120 "description": "This property shall specify a valid odata or Redfish property.",
121 "type": [
122 "array",
123 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800124 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700125 "number",
126 "null",
127 "object",
128 "string"
129 ]
130 }
131 },
132 "properties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800133 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700134 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous530520e2019-01-02 13:41:37 -0800135 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700136 "Actions": {
137 "$ref": "#/definitions/AssemblyDataActions",
Ed Tanouscb103132019-10-08 11:34:22 -0700138 "description": "The available actions for this Resource.",
139 "longDescription": "This property shall contain the available actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700140 },
141 "BinaryDataURI": {
Ed Tanouscb103132019-10-08 11:34:22 -0700142 "description": "The URI at which to access an image of the assembly information.",
143 "format": "uri-reference",
144 "longDescription": "This property shall contain the URI at which to access an image of the assembly information, using the Redfish protocol and authentication methods. The Service provides this URI for the download of the OEM-specific binary image of the assembly data. An HTTP GET from this URI shall return a response payload of MIME time `application/octet-stream`. If the service supports it, an HTTP PUT to this URI shall replace the binary image of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700145 "readonly": true,
146 "type": [
147 "string",
148 "null"
149 ]
150 },
151 "Description": {
Ed Tanouscb103132019-10-08 11:34:22 -0700152 "description": "The description of the assembly.",
153 "longDescription": "This property shall contain the description of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700154 "readonly": true,
155 "type": [
156 "string",
157 "null"
158 ]
159 },
160 "EngineeringChangeLevel": {
Ed Tanouscb103132019-10-08 11:34:22 -0700161 "description": "The engineering change level of the assembly.",
162 "longDescription": "This property shall contain the engineering change level or revision of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700163 "readonly": true,
164 "type": [
165 "string",
166 "null"
167 ]
168 },
169 "MemberId": {
Ed Tanouscb103132019-10-08 11:34:22 -0700170 "description": "The identifier for the member within the collection.",
171 "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700172 "readonly": true,
173 "type": "string"
174 },
175 "Model": {
Ed Tanouscb103132019-10-08 11:34:22 -0700176 "description": "The model number of the assembly.",
177 "longDescription": "This property shall contain the name by which the manufacturer generally refers to the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700178 "readonly": true,
179 "type": [
180 "string",
181 "null"
182 ]
183 },
184 "Name": {
Ed Tanouscb103132019-10-08 11:34:22 -0700185 "description": "The name of the assembly.",
186 "longDescription": "This property shall contain the name of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700187 "readonly": true,
188 "type": [
189 "string",
190 "null"
191 ]
192 },
193 "Oem": {
194 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700195 "description": "The OEM extension property.",
196 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700197 },
198 "PartNumber": {
Ed Tanouscb103132019-10-08 11:34:22 -0700199 "description": "The part number of the assembly.",
200 "longDescription": "This property shall contain the part number of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700201 "readonly": true,
202 "type": [
203 "string",
204 "null"
205 ]
206 },
Ed Tanous530520e2019-01-02 13:41:37 -0800207 "PhysicalContext": {
208 "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext",
Ed Tanouscb103132019-10-08 11:34:22 -0700209 "description": "The area or device to which the assembly data applies.",
210 "longDescription": "This property shall contain a description of the physical context for the assembly data.",
211 "readonly": true,
212 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800213 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700214 "Producer": {
Ed Tanouscb103132019-10-08 11:34:22 -0700215 "description": "The producer or manufacturer of the assembly.",
216 "longDescription": "This property shall contain the name of the company that produced or manufactured the assembly. This value shall be equal to the 'Manufacturer' field value in a PLDM FRU structure, if applicable, for the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700217 "readonly": true,
218 "type": [
219 "string",
220 "null"
221 ]
222 },
223 "ProductionDate": {
Ed Tanouscb103132019-10-08 11:34:22 -0700224 "description": "The production date of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700225 "format": "date-time",
Ed Tanouscb103132019-10-08 11:34:22 -0700226 "longDescription": "This property shall contain the date of production or manufacture for the assembly. The time of day portion of the property shall be `00:00:00Z`, if the time of day is unknown.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700227 "readonly": true,
228 "type": [
229 "string",
230 "null"
231 ]
232 },
233 "SKU": {
Ed Tanouscb103132019-10-08 11:34:22 -0700234 "description": "The SKU of the assembly.",
235 "longDescription": "This property shall contain the SKU of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700236 "readonly": true,
237 "type": [
238 "string",
239 "null"
240 ]
241 },
Ed Tanous530520e2019-01-02 13:41:37 -0800242 "SerialNumber": {
Ed Tanouscb103132019-10-08 11:34:22 -0700243 "description": "The serial number of the assembly.",
244 "longDescription": "This property shall contain a manufacturer-allocated number that identifies the assembly.",
Ed Tanous530520e2019-01-02 13:41:37 -0800245 "readonly": true,
246 "type": [
247 "string",
248 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700249 ],
250 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800251 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700252 "SparePartNumber": {
Ed Tanouscb103132019-10-08 11:34:22 -0700253 "description": "The spare part number of the assembly.",
254 "longDescription": "This property shall contain the spare part number of the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700255 "readonly": true,
256 "type": [
257 "string",
258 "null"
259 ]
260 },
261 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800262 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -0700263 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
264 "longDescription": "This property shall contain any status or health properties of the Resource.",
265 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700266 },
267 "Vendor": {
Ed Tanouscb103132019-10-08 11:34:22 -0700268 "description": "The vendor of the assembly.",
269 "longDescription": "This property shall contain the name of the company that provides the final product that includes this assembly. This value shall be equal to the 'Vendor' field value in a PLDM FRU structure, if applicable, for the assembly.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700270 "readonly": true,
271 "type": [
272 "string",
273 "null"
274 ]
275 },
276 "Version": {
Gunnar Mills09b9d452020-02-11 13:27:39 -0600277 "description": "The hardware version of the assembly.",
278 "longDescription": "This property shall contain the hardware version of the assembly as determined by the vendor or supplier.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700279 "readonly": true,
280 "type": [
281 "string",
282 "null"
283 ]
284 }
285 },
Ed Tanous530520e2019-01-02 13:41:37 -0800286 "required": [
287 "@odata.id",
288 "MemberId"
289 ],
Ed Tanous118b1c72018-09-13 13:45:51 -0700290 "type": "object"
291 },
292 "AssemblyDataActions": {
293 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700294 "description": "The available actions for this Resource.",
295 "longDescription": "This type shall contain the available actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700296 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700297 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700298 "description": "This property shall specify a valid odata or Redfish property.",
299 "type": [
300 "array",
301 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800302 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700303 "number",
304 "null",
305 "object",
306 "string"
307 ]
308 }
309 },
310 "properties": {
311 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800312 "$ref": "#/definitions/AssemblyDataOemActions",
Ed Tanouscb103132019-10-08 11:34:22 -0700313 "description": "The available OEM-specific actions for this Resource.",
314 "longDescription": "This property shall contain the available OEM-specific actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700315 }
316 },
317 "type": "object"
318 },
319 "AssemblyDataOemActions": {
320 "additionalProperties": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700321 "description": "The available OEM-specific actions for this Resource.",
322 "longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700323 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700324 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700325 "description": "This property shall specify a valid odata or Redfish property.",
326 "type": [
327 "array",
328 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800329 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700330 "number",
331 "null",
332 "object",
333 "string"
334 ]
335 }
336 },
337 "properties": {},
338 "type": "object"
339 },
340 "OemActions": {
341 "additionalProperties": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700342 "description": "The available OEM-specific actions for this Resource.",
343 "longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700344 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700345 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700346 "description": "This property shall specify a valid odata or Redfish property.",
347 "type": [
348 "array",
349 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800350 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700351 "number",
352 "null",
353 "object",
354 "string"
355 ]
356 }
357 },
358 "properties": {},
359 "type": "object"
360 }
361 },
362 "owningEntity": "DMTF",
Ed Tanouscb103132019-10-08 11:34:22 -0700363 "release": "2018.2",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600364 "title": "#Assembly.v1_2_3.Assembly"
Ed Tanous118b1c72018-09-13 13:45:51 -0700365}