Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 118b1c7102e942ace53dac9f92a954864462eebe / . / static / redfish / v1 / JsonSchemas / Assembly / Assembly.json
blob: c2c8e4f975be95fc9dc31e73bf5034c6df120f4f [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame^]1{
2 "$ref": "#/definitions/Assembly",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_4_0.json",
4 "copyright": "Copyright 2014-2018 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "Oem": {
25 "$ref": "#/definitions/OemActions"
26 }
27 },
28 "type": "object"
29 },
30 "Assembly": {
31 "additionalProperties": false,
32 "description": "This is the schema definition for the Assembly properties.",
33 "longDescription": "This resource shall be used to represent an assembly information resource for a Redfish implementation.",
34 "patternProperties": {
35 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
36 "description": "This property shall specify a valid odata or Redfish property.",
37 "type": [
38 "array",
39 "boolean",
40 "number",
41 "null",
42 "object",
43 "string"
44 ]
45 }
46 },
47 "properties": {
48 "@odata.context": {
49 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/context"
50 },
51 "@odata.etag": {
52 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/etag"
53 },
54 "@odata.id": {
55 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/id"
56 },
57 "@odata.type": {
58 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/type"
59 },
60 "Actions": {
61 "$ref": "#/definitions/Actions",
62 "description": "The available actions for this resource.",
63 "longDescription": "The Actions property shall contain the available actions for this resource."
64 },
65 "Assemblies": {
66 "description": "This is the definition for an assembly information record.",
67 "items": {
68 "$ref": "#/definitions/AssemblyData"
69 },
70 "longDescription": "These properties shall be the definition for assembly records for a Redfish implementation.",
71 "readonly": false,
72 "type": "array"
73 },
74 "Assemblies@odata.count": {
75 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/count"
76 },
77 "Description": {
78 "anyOf": [
79 {
80 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
81 },
82 {
83 "type": "null"
84 }
85 ],
86 "readonly": true
87 },
88 "Id": {
89 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
90 "readonly": true
91 },
92 "Name": {
93 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
94 "readonly": true
95 },
96 "Oem": {
97 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
98 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
99 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
100 }
101 },
102 "required": [
103 "Id",
104 "Name"
105 ],
106 "type": "object"
107 },
108 "AssemblyData": {
109 "additionalProperties": false,
110 "patternProperties": {
111 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
112 "description": "This property shall specify a valid odata or Redfish property.",
113 "type": [
114 "array",
115 "boolean",
116 "number",
117 "null",
118 "object",
119 "string"
120 ]
121 }
122 },
123 "properties": {
124 "Actions": {
125 "$ref": "#/definitions/AssemblyDataActions",
126 "description": "The available actions for this resource.",
127 "longDescription": "The Actions property shall contain the available actions for this resource."
128 },
129 "BinaryDataURI": {
130 "description": "URI that provides the ability to access an image of the assembly information.",
131 "format": "uri",
132 "longDescription": "The value of this property shall be a URI at which the Service provides 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. An HTTP PUT to this URI, if supported by the Service, shall replace the binary image of the assembly.",
133 "readonly": true,
134 "type": [
135 "string",
136 "null"
137 ]
138 },
139 "Description": {
140 "description": "Description of the Assembly.",
141 "longDescription": "The value of this property shall be a description of this assembly.",
142 "readonly": true,
143 "type": [
144 "string",
145 "null"
146 ]
147 },
148 "EngineeringChangeLevel": {
149 "description": "Engineering change level of the Assembly.",
150 "longDescription": "The value of this property shall be the Engineering Change Level (ECL) or revision of the assembly.",
151 "readonly": true,
152 "type": [
153 "string",
154 "null"
155 ]
156 },
157 "MemberId": {
158 "description": "This is the identifier for the member within the collection.",
159 "longDescription": "The value of this string shall uniquely identify the member within the collection.",
160 "readonly": true,
161 "type": "string"
162 },
163 "Model": {
164 "description": "Model number of the Assembly.",
165 "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the assembly.",
166 "readonly": true,
167 "type": [
168 "string",
169 "null"
170 ]
171 },
172 "Name": {
173 "description": "Name of the Assembly.",
174 "longDescription": "The value of this property shall be the name of the assembly.",
175 "readonly": true,
176 "type": [
177 "string",
178 "null"
179 ]
180 },
181 "Oem": {
182 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
183 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
184 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
185 },
186 "PartNumber": {
187 "description": "Part number of the Assembly.",
188 "longDescription": "The value of this property shall be the name of the assembly.",
189 "readonly": true,
190 "type": [
191 "string",
192 "null"
193 ]
194 },
195 "Producer": {
196 "description": "Producer or manufacturer of the Assembly.",
197 "longDescription": "The value of this property shall be the name of the company which supplied or manufactured this assembly. This value shall be equal to the 'Manufacturer' field in a PLDM FRU structure, if applicable, for this assembly.",
198 "readonly": true,
199 "type": [
200 "string",
201 "null"
202 ]
203 },
204 "ProductionDate": {
205 "description": "Production date of the Assembly.",
206 "format": "date-time",
207 "longDescription": "The value of this property shall be the date of production or manufacture for this assembly.",
208 "readonly": true,
209 "type": [
210 "string",
211 "null"
212 ]
213 },
214 "SKU": {
215 "description": "SKU of the Assembly.",
216 "longDescription": "The value of this property shall be the name of the assembly.",
217 "readonly": true,
218 "type": [
219 "string",
220 "null"
221 ]
222 },
223 "SparePartNumber": {
224 "description": "Spare part number of the Assembly.",
225 "longDescription": "The value of this property shall be the name of the assembly.",
226 "readonly": true,
227 "type": [
228 "string",
229 "null"
230 ]
231 },
232 "Status": {
233 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
234 },
235 "Vendor": {
236 "description": "Vendor of the Assembly.",
237 "longDescription": "The value of this property shall be the name of the company which provides the final product that includes this assembly. This value shall be equal to the 'Vendor' field in a PLDM FRU structure, if applicable, for this assembly.",
238 "readonly": true,
239 "type": [
240 "string",
241 "null"
242 ]
243 },
244 "Version": {
245 "description": "Version of the Assembly.",
246 "longDescription": "The value of this property shall be the version of the assembly as determined by the vendor or supplier.",
247 "readonly": true,
248 "type": [
249 "string",
250 "null"
251 ]
252 }
253 },
254 "type": "object"
255 },
256 "AssemblyDataActions": {
257 "additionalProperties": false,
258 "description": "The available actions for this resource.",
259 "longDescription": "This type shall contain the available actions for this resource.",
260 "patternProperties": {
261 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
262 "description": "This property shall specify a valid odata or Redfish property.",
263 "type": [
264 "array",
265 "boolean",
266 "number",
267 "null",
268 "object",
269 "string"
270 ]
271 }
272 },
273 "properties": {
274 "Oem": {
275 "$ref": "#/definitions/AssemblyDataOemActions"
276 }
277 },
278 "type": "object"
279 },
280 "AssemblyDataOemActions": {
281 "additionalProperties": true,
282 "description": "The available OEM specific actions for this resource.",
283 "longDescription": "This type shall contain any additional OEM actions for this resource.",
284 "patternProperties": {
285 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
286 "description": "This property shall specify a valid odata or Redfish property.",
287 "type": [
288 "array",
289 "boolean",
290 "number",
291 "null",
292 "object",
293 "string"
294 ]
295 }
296 },
297 "properties": {},
298 "type": "object"
299 },
300 "OemActions": {
301 "additionalProperties": true,
302 "description": "The available OEM specific actions for this resource.",
303 "longDescription": "This type shall contain any additional OEM actions for this resource.",
304 "patternProperties": {
305 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
306 "description": "This property shall specify a valid odata or Redfish property.",
307 "type": [
308 "array",
309 "boolean",
310 "number",
311 "null",
312 "object",
313 "string"
314 ]
315 }
316 },
317 "properties": {},
318 "type": "object"
319 }
320 },
321 "owningEntity": "DMTF",
322 "title": "#Assembly.v1_1_0.Assembly"
323}