blob: 6dd58cd7536e97f71b0dd672c90aeae829af9bfc [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills262d7d42021-01-20 16:28:41 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/MessageRegistry.v1_4_2.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/MessageRegistry",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Gunnar Millsa778c022020-05-12 12:20:36 -05005 "copyright": "Copyright 2014-2020 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,
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -05009 "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",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050028 "description": "The available OEM-specific actions for this resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -070030 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -070031 }
32 },
33 "type": "object"
34 },
Ed Tanous530520e2019-01-02 13:41:37 -080035 "ClearingLogic": {
Ed Tanous118b1c72018-09-13 13:45:51 -070036 "additionalProperties": false,
Ed Tanous530520e2019-01-02 13:41:37 -080037 "description": "The clearing logic associated with this message. The properties within indicate that what messages are cleared by this message as well as under what conditions.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050038 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070039 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070040 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070041 "description": "This property shall specify a valid odata or Redfish property.",
42 "type": [
43 "array",
44 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080045 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070046 "number",
47 "null",
48 "object",
49 "string"
50 ]
51 }
52 },
53 "properties": {
Ed Tanous530520e2019-01-02 13:41:37 -080054 "ClearsAll": {
Ed Tanouscb103132019-10-08 11:34:22 -070055 "description": "An indication of whether all prior conditions and messages are cleared, provided the ClearsIf condition is met.",
56 "longDescription": "This property shall indicate whether all prior conditions and messages are cleared, provided the ClearsIf condition is met.",
Ed Tanous530520e2019-01-02 13:41:37 -080057 "readonly": true,
58 "type": [
59 "boolean",
60 "null"
Ed Tanouscb103132019-10-08 11:34:22 -070061 ],
62 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -080063 },
64 "ClearsIf": {
65 "anyOf": [
66 {
67 "$ref": "#/definitions/ClearingType"
68 },
69 {
70 "type": "null"
71 }
72 ],
Ed Tanouscb103132019-10-08 11:34:22 -070073 "description": "The condition when the event is cleared.",
74 "longDescription": "This property shall contain the condition the event is cleared.",
75 "readonly": true,
76 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -080077 },
78 "ClearsMessage": {
Ed Tanouscb103132019-10-08 11:34:22 -070079 "description": "The array of MessageIds that this message clears when the other conditions are met.",
Ed Tanous530520e2019-01-02 13:41:37 -080080 "items": {
81 "type": [
82 "string",
83 "null"
84 ]
85 },
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050086 "longDescription": "This property shall contain an array of MessageIds that this message clears when the other conditions are met. The MessageIds shall not include the message registry name or version and shall contain only the MessageId portion. MessageIds shall not refer to other message registries.",
Ed Tanous530520e2019-01-02 13:41:37 -080087 "readonly": true,
Ed Tanouscb103132019-10-08 11:34:22 -070088 "type": "array",
89 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -080090 }
91 },
92 "type": "object"
93 },
94 "ClearingType": {
Ed Tanouscb103132019-10-08 11:34:22 -070095 "description": "The conditions when an event is cleared.",
Ed Tanous530520e2019-01-02 13:41:37 -080096 "enum": [
97 "SameOriginOfCondition"
98 ],
99 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700100 "SameOriginOfCondition": "This enumeration shall describe when the message for an event is cleared by the other messages in the ClearingLogic property, provided the OriginOfCondition for both events are the same."
Ed Tanous530520e2019-01-02 13:41:37 -0800101 },
102 "type": "string"
103 },
104 "Message": {
105 "additionalProperties": false,
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500106 "description": "This type represents how a message is defined within the message registry.",
107 "longDescription": "The type shall represent how a message is defined within a message registry.",
Ed Tanous530520e2019-01-02 13:41:37 -0800108 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700109 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -0800110 "description": "This property shall specify a valid odata or Redfish property.",
111 "type": [
112 "array",
113 "boolean",
114 "integer",
115 "number",
116 "null",
117 "object",
118 "string"
119 ]
120 }
121 },
122 "properties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700123 "ArgDescriptions": {
124 "description": "The MessageArg descriptions, in order, used for this message.",
125 "items": {
126 "type": [
127 "string",
128 "null"
129 ]
130 },
131 "longDescription": "This property shall contain an ordered array of text describing each argument used as substitution in the message.",
132 "readonly": true,
133 "type": "array",
134 "versionAdded": "v1_3_0"
135 },
136 "ArgLongDescriptions": {
137 "description": "The MessageArg normative descriptions, in order, used for this message.",
138 "items": {
139 "type": [
140 "string",
141 "null"
142 ]
143 },
144 "longDescription": "This property shall contain an ordered array of normative language for each argument used as substitution in the message.",
145 "readonly": true,
146 "type": "array",
147 "versionAdded": "v1_3_0"
148 },
Ed Tanous530520e2019-01-02 13:41:37 -0800149 "ClearingLogic": {
Ed Tanouscb103132019-10-08 11:34:22 -0700150 "$ref": "#/definitions/ClearingLogic",
Ed Tanous530520e2019-01-02 13:41:37 -0800151 "description": "The clearing logic associated with this message. The properties within indicate that what messages are cleared by this message as well as under what conditions.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500152 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700153 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800154 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700155 "Description": {
Ed Tanouscb103132019-10-08 11:34:22 -0700156 "description": "A short description of how and when to use this message.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500157 "longDescription": "This property shall indicate how and when this message is returned by the Redfish service.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700158 "readonly": true,
159 "type": "string"
160 },
Ed Tanouscb103132019-10-08 11:34:22 -0700161 "LongDescription": {
162 "description": "The normative language that describes this message's usage.",
163 "longDescription": "This property shall contain the normative language that describes this message's usage in a Redfish implementation.",
164 "readonly": true,
165 "type": [
166 "string",
167 "null"
168 ],
169 "versionAdded": "v1_3_0"
170 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700171 "Message": {
172 "description": "The actual message.",
Ed Tanouscb103132019-10-08 11:34:22 -0700173 "longDescription": "This property shall contain the message to display. If a %integer is included in part of the string, it shall represent a string substitution for any MessageArgs that accompany the message, in order.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700174 "readonly": true,
175 "type": "string"
176 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500177 "MessageSeverity": {
178 "anyOf": [
179 {
180 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health"
181 },
182 {
183 "type": "null"
184 }
185 ],
186 "description": "The severity of the message.",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600187 "longDescription": "This property shall contain the severity of the message. Services can replace the severity defined in the message registry with a value more applicable to the implementation in message payloads and event payloads.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500188 "readonly": true,
189 "versionAdded": "v1_4_0"
190 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700191 "NumberOfArgs": {
Ed Tanouscb103132019-10-08 11:34:22 -0700192 "description": "The number of arguments in the message.",
193 "longDescription": "This property shall contain the number of arguments that are substituted for the locations marked with %<integer> in the message.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700194 "minimum": 0,
195 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -0800196 "type": "integer"
Ed Tanous118b1c72018-09-13 13:45:51 -0700197 },
198 "Oem": {
199 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700200 "description": "The OEM extension property.",
201 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700202 },
203 "ParamTypes": {
204 "description": "The MessageArg types, in order, for the message.",
205 "items": {
206 "$ref": "#/definitions/ParamType"
207 },
Ed Tanouscb103132019-10-08 11:34:22 -0700208 "longDescription": "This property shall contain an ordered array of argument data types that match the data types of the MessageArgs.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700209 "readonly": true,
210 "type": "array"
211 },
212 "Resolution": {
213 "description": "Used to provide suggestions on how to resolve the situation that caused the error.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500214 "longDescription": "This property shall contain the resolution of the message. Services can replace the resolution defined in the message registry with a more specific resolution in message payloads.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700215 "readonly": true,
216 "type": "string"
217 },
218 "Severity": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500219 "deprecated": "This property has been deprecated in favor of MessageSeverity, which ties the values to the enumerations defined for the Health property within Status.",
Ed Tanouscb103132019-10-08 11:34:22 -0700220 "description": "The severity of the message.",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600221 "longDescription": "This property shall contain the severity of the condition resulting in the message, as defined in the 'Status' clause of the Redfish Specification. Services can replace the severity defined in the message registry with a value more applicable to the implementation in message payloads and event payloads.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700222 "readonly": true,
Gunnar Millsa778c022020-05-12 12:20:36 -0500223 "type": "string",
224 "versionDeprecated": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700225 }
226 },
227 "required": [
228 "Description",
229 "Message",
230 "Severity",
231 "NumberOfArgs",
Gunnar Millsa778c022020-05-12 12:20:36 -0500232 "Resolution",
233 "MessageSeverity"
Ed Tanous118b1c72018-09-13 13:45:51 -0700234 ],
235 "type": "object"
236 },
237 "MessageProperty": {
238 "additionalProperties": false,
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500239 "description": "The message keys contained in the message registry.",
240 "longDescription": "This type shall contain the message keys contained in the message registry. The message keys are the suffix of the MessageId and shall be unique within this message registry.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700241 "patternProperties": {
242 "[A-Za-z0-9]+": {
243 "$ref": "#/definitions/Message"
244 },
Ed Tanouscb103132019-10-08 11:34:22 -0700245 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700246 "description": "This property shall specify a valid odata or Redfish property.",
247 "type": [
248 "array",
249 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800250 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700251 "number",
252 "null",
253 "object",
254 "string"
255 ]
256 }
257 },
258 "properties": {},
259 "type": "object"
260 },
261 "MessageRegistry": {
262 "additionalProperties": false,
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500263 "description": "The MessageRegistry schema describes all message registries. It represents the properties for the message registries themselves.",
264 "longDescription": "This resource shall represent a message registry for a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700265 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700266 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700267 "description": "This property shall specify a valid odata or Redfish property.",
268 "type": [
269 "array",
270 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800271 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700272 "number",
273 "null",
274 "object",
275 "string"
276 ]
277 }
278 },
279 "properties": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700280 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700281 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700282 },
283 "Actions": {
284 "$ref": "#/definitions/Actions",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500285 "description": "The available actions for this resource.",
286 "longDescription": "This property shall contain the available actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700287 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700288 },
289 "Description": {
290 "anyOf": [
291 {
292 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
293 },
294 {
295 "type": "null"
296 }
297 ],
298 "readonly": true
299 },
300 "Id": {
301 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
302 "readonly": true
303 },
304 "Language": {
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500305 "description": "The RFC5646-conformant language code for the message registry.",
Ed Tanouscb103132019-10-08 11:34:22 -0700306 "longDescription": "This property shall contain an RFC5646-conformant language code.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700307 "readonly": true,
308 "type": "string"
309 },
310 "Messages": {
311 "$ref": "#/definitions/MessageProperty",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500312 "description": "The message keys contained in the message registry.",
313 "longDescription": "This property shall contain the message keys contained in the message registry. The message keys are the suffix of the MessageId and shall be unique within this message registry."
Ed Tanous118b1c72018-09-13 13:45:51 -0700314 },
315 "Name": {
316 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
317 "readonly": true
318 },
319 "Oem": {
320 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700321 "description": "The OEM extension property.",
322 "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 -0700323 },
324 "OwningEntity": {
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500325 "description": "The organization or company that publishes this message registry.",
326 "longDescription": "This property shall represent the publisher of this message registry.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700327 "readonly": true,
328 "type": "string"
329 },
330 "RegistryPrefix": {
Ed Tanouscb103132019-10-08 11:34:22 -0700331 "description": "The single-word prefix that is used in forming and decoding MessageIds.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500332 "longDescription": "This property shall contain the Redfish Specification-defined prefix used in forming and decoding MessageIds that uniquely identifies all messages that belong to this message registry.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700333 "readonly": true,
334 "type": "string"
335 },
336 "RegistryVersion": {
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500337 "description": "The message registry version in the middle portion of a MessageId.",
338 "longDescription": "This property shall contain the version of this message registry.",
Ed Tanouscb103132019-10-08 11:34:22 -0700339 "pattern": "^\\d+\\.\\d+\\.\\d+$",
Ed Tanous118b1c72018-09-13 13:45:51 -0700340 "readonly": true,
341 "type": "string"
342 }
343 },
344 "required": [
345 "Language",
346 "RegistryPrefix",
347 "RegistryVersion",
348 "OwningEntity",
349 "Messages",
Ed Tanous530520e2019-01-02 13:41:37 -0800350 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700351 "Id",
352 "Name"
353 ],
354 "type": "object"
355 },
356 "OemActions": {
357 "additionalProperties": true,
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500358 "description": "The available OEM-specific actions for this resource.",
359 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700360 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700361 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700362 "description": "This property shall specify a valid odata or Redfish property.",
363 "type": [
364 "array",
365 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800366 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700367 "number",
368 "null",
369 "object",
370 "string"
371 ]
372 }
373 },
374 "properties": {},
375 "type": "object"
376 },
377 "ParamType": {
378 "enum": [
379 "string",
380 "number"
381 ],
382 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700383 "number": "The argument is a number.",
384 "string": "The argument is a string."
Ed Tanous118b1c72018-09-13 13:45:51 -0700385 },
386 "type": "string"
387 }
388 },
Ed Tanous530520e2019-01-02 13:41:37 -0800389 "owningEntity": "DMTF",
Gunnar Millsa778c022020-05-12 12:20:36 -0500390 "release": "2020.1",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600391 "title": "#MessageRegistry.v1_4_2.MessageRegistry"
Ed Tanous118b1c72018-09-13 13:45:51 -0700392}