blob: deeba60d8cd7b88d675074ea4a8531bf9bd0b4f5 [file] [log] [blame]
{
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_2_0.json",
"title": "#Message.v1_0_5",
"definitions": {
"Message": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": false,
"properties": {
"MessageId": {
"type": "string",
"readonly": true,
"description": "This is the key for this message which can be used to look up the message in a message registry.",
"longDescription": "This property shall be a key into message registry as described in the Redfish specification."
},
"Message": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "This is the human readable message, if provided.",
"longDescription": "This property shall contain an optional human readable message."
},
"RelatedProperties": {
"type": "array",
"items": {
"type": "string"
},
"readonly": true,
"description": "This is an array of properties described by the message.",
"longDescription": "This property shall contain an array of JSON Pointers indicating the properties described by the message, if appropriate for the message."
},
"MessageArgs": {
"type": "array",
"items": {
"type": "string"
},
"readonly": true,
"description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.",
"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."
},
"Severity": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "This is the severity of the errors.",
"longDescription": "The value of this property shall be the severity of the error, as defined in the Status section of the Redfish specificaiton."
},
"Resolution": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "Used to provide suggestions on how to resolve the situation that caused the error.",
"longDescription": "This property shall contain an override of the Resolution of the message in message registry, if present."
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "Oem extension object.",
"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."
}
},
"required": [
"MessageId"
],
"description": "This type describes a Message returned by the Redfish service.",
"longDescription": "This type shall define a Message as described in the Redfish specification."
}
},
"copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright"
}