blob: b26884fa4d9e4e39d97182a0e50f1d10746578b6 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Ed Tanous530520e2019-01-02 13:41:37 -08002 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
3 "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07004 "definitions": {
5 "Message": {
Ed Tanous530520e2019-01-02 13:41:37 -08006 "additionalProperties": false,
7 "description": "This type describes a Message returned by the Redfish service.",
8 "longDescription": "This type shall define a Message as described in the Redfish specification.",
Ed Tanous118b1c72018-09-13 13:45:51 -07009 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -080010 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
11 "description": "This property shall specify a valid odata or Redfish property.",
Ed Tanous118b1c72018-09-13 13:45:51 -070012 "type": [
13 "array",
14 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080015 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070016 "number",
17 "null",
18 "object",
19 "string"
Ed Tanous530520e2019-01-02 13:41:37 -080020 ]
Ed Tanous118b1c72018-09-13 13:45:51 -070021 }
22 },
Ed Tanous118b1c72018-09-13 13:45:51 -070023 "properties": {
Ed Tanous118b1c72018-09-13 13:45:51 -070024 "Message": {
Ed Tanous530520e2019-01-02 13:41:37 -080025 "description": "This is the human readable message, if provided.",
26 "longDescription": "This property shall contain an optional human readable message.",
27 "readonly": true,
Ed Tanous118b1c72018-09-13 13:45:51 -070028 "type": [
29 "string",
30 "null"
Ed Tanous530520e2019-01-02 13:41:37 -080031 ]
Ed Tanous118b1c72018-09-13 13:45:51 -070032 },
33 "MessageArgs": {
Ed Tanous530520e2019-01-02 13:41:37 -080034 "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.",
Ed Tanous118b1c72018-09-13 13:45:51 -070035 "items": {
36 "type": "string"
37 },
Ed Tanous530520e2019-01-02 13:41:37 -080038 "longDescription": "This property shall contain the message substitution arguments for the specific message referenced by the MessageId and shall only be included if the MessageId is present.",
Ed Tanous118b1c72018-09-13 13:45:51 -070039 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -080040 "type": "array"
Ed Tanous118b1c72018-09-13 13:45:51 -070041 },
Ed Tanous530520e2019-01-02 13:41:37 -080042 "MessageId": {
43 "description": "This is the key for this message which can be used to look up the message in a message registry.",
44 "longDescription": "This property shall be a key into message registry as described in the Redfish specification.",
Ed Tanous118b1c72018-09-13 13:45:51 -070045 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -080046 "type": "string"
Ed Tanous118b1c72018-09-13 13:45:51 -070047 },
48 "Oem": {
49 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
50 "description": "Oem extension object.",
51 "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
Ed Tanous530520e2019-01-02 13:41:37 -080052 },
53 "RelatedProperties": {
54 "description": "This is an array of properties described by the message.",
55 "items": {
56 "type": "string"
57 },
58 "longDescription": "This property shall contain an array of JSON Pointers indicating the properties described by the message, if appropriate for the message.",
59 "readonly": true,
60 "type": "array"
61 },
62 "Resolution": {
63 "description": "Used to provide suggestions on how to resolve the situation that caused the error.",
64 "longDescription": "This property shall contain an override of the Resolution of the message in message registry, if present.",
65 "readonly": true,
66 "type": [
67 "string",
68 "null"
69 ]
70 },
71 "Severity": {
72 "description": "This is the severity of the errors.",
73 "longDescription": "The value of this property shall be the severity of the error, as defined in the Status section of the Redfish specificaiton.",
74 "readonly": true,
75 "type": [
76 "string",
77 "null"
78 ]
Ed Tanous118b1c72018-09-13 13:45:51 -070079 }
80 },
81 "required": [
82 "MessageId"
83 ],
Ed Tanous530520e2019-01-02 13:41:37 -080084 "type": "object"
Ed Tanous118b1c72018-09-13 13:45:51 -070085 }
86 },
Ed Tanous530520e2019-01-02 13:41:37 -080087 "owningEntity": "DMTF",
88 "title": "#Message.v1_0_6"
89}