static/redfish/v1/JsonSchemas/Message/Message.json

{
    "$id": "http://redfish.dmtf.org/schemas/v1/Message.v1_1_1.json",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Message": {
            "additionalProperties": false,
            "description": "The message that the Redfish service returns.",
            "longDescription": "This type shall contain a message that the Redfish service returns, as described in the Redfish Specification.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Message": {
                    "description": "The human-readable message, if provided.",
                    "longDescription": "This property shall contain an optional human-readable message.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "MessageArgs": {
                    "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain the message substitution arguments for the specific message to which this MessageId refers and shall be included only if the MessageId is present.  Any number and integer type arguments shall be converted to strings.",
                    "readonly": true,
                    "type": "array"
                },
                "MessageId": {
                    "description": "The key for this message used to find the message in a message registry.",
                    "longDescription": "This property shall contain a key into message registry, as described in the Redfish Specification.",
                    "readonly": true,
                    "type": "string"
                },
                "MessageSeverity": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The severity of the message.",
                    "longDescription": "This property shall contain the severity of the message.  Services can replace the value defined in the message registry with a value more applicable to the implementation.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                },
                "RelatedProperties": {
                    "description": "A set of properties described by the message.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain an array of RFC6901-defined JSON pointers indicating the properties described by the message, if appropriate for the message.",
                    "readonly": true,
                    "type": "array"
                },
                "Resolution": {
                    "description": "Used to provide suggestions on how to resolve the situation that caused the error.",
                    "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.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Severity": {
                    "deprecated": "This property has been deprecated in favor of MessageSeverity, which ties the values to the enumerations defined for the Health property within Status.",
                    "description": "The severity of the errors.",
                    "longDescription": "This property shall contain the severity of the error, as defined in the Status section of the Redfish Specification.  Services can replace the value defined in the message registry with a value more applicable to the implementation.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionDeprecated": "v1_1_0"
                }
            },
            "required": [
                "MessageId"
            ],
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "release": "2020.1",
    "title": "#Message.v1_1_1"
}