Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1 | { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 2 | "$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 Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 4 | "definitions": { |
| 5 | "Message": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 6 | "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 Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 9 | "patternProperties": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 10 | "^([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 Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 12 | "type": [ |
| 13 | "array", |
| 14 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 15 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 16 | "number", |
| 17 | "null", |
| 18 | "object", |
| 19 | "string" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 20 | ] |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 21 | } |
| 22 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 23 | "properties": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 24 | "Message": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 25 | "description": "This is the human readable message, if provided.", |
| 26 | "longDescription": "This property shall contain an optional human readable message.", |
| 27 | "readonly": true, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 28 | "type": [ |
| 29 | "string", |
| 30 | "null" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 31 | ] |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 32 | }, |
| 33 | "MessageArgs": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 34 | "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 35 | "items": { |
| 36 | "type": "string" |
| 37 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 38 | "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 Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 39 | "readonly": true, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 40 | "type": "array" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 41 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 42 | "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 Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 45 | "readonly": true, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 46 | "type": "string" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 47 | }, |
| 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 Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 52 | }, |
| 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 Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 79 | } |
| 80 | }, |
| 81 | "required": [ |
| 82 | "MessageId" |
| 83 | ], |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 84 | "type": "object" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 85 | } |
| 86 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 87 | "owningEntity": "DMTF", |
| 88 | "title": "#Message.v1_0_6" |
| 89 | } |