133 lines
6.8 KiB
JSON
133 lines
6.8 KiB
JSON
{
|
|
"$schema": "http://schemas.dmtf.org/redfish/v1/redfish-schema.0.96.0",
|
|
"title": "MessageRegistry.0.96.0",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"@odata.context": {
|
|
"$ref": "odata.4.0.0.json#context"
|
|
},
|
|
"@odata.id": {
|
|
"$ref": "odata.4.0.0.json#id"
|
|
},
|
|
"@odata.type": {
|
|
"$ref": "odata.4.0.0.json#type"
|
|
},
|
|
"Oem": {
|
|
"$ref": "Resource.0.96.0.json#Oem",
|
|
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
|
|
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
|
|
},
|
|
"Id": {
|
|
"$ref": "Resource.0.96.0.json#Id"
|
|
},
|
|
"Description": {
|
|
"$ref": "Resource.0.96.0.json#Description"
|
|
},
|
|
"Name": {
|
|
"$ref": "Resource.0.96.0.json#Name"
|
|
},
|
|
"Language": {
|
|
"type": "string",
|
|
"readonly": true,
|
|
"description": "This is the RFC 5646 compliant language code for the registry.",
|
|
"longDescription": "The value of this property shall be a string consisting of an RFC 5646 language code"
|
|
},
|
|
"RegistryPrefix": {
|
|
"type": "string",
|
|
"readonly": true,
|
|
"description": "This is the single word prefix used to form a messageID structure.",
|
|
"longDescription": "The value of this property shall be the prefix used in messageIDs which uniquely identifies all of the messages in this registry as belonging to this registry."
|
|
},
|
|
"RegistryVersion": {
|
|
"type": "string",
|
|
"readonly": true,
|
|
"description": "This is the message registry version which is used in the middle portion of a messageID.",
|
|
"longDescription": "The value of this property shall be the version of this message registry. The format of this string shall be of the format majorversion.minorversion.errata in compliance with Protocol Version section of the Redfish specification"
|
|
},
|
|
"OwningEntity": {
|
|
"type": "string",
|
|
"readonly": true,
|
|
"description": "This is the organization or company that publishes this registry.",
|
|
"longDescription": "The value of this property shall be a string that represents the publisher of this registry."
|
|
},
|
|
"Messages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
|
|
},
|
|
"dynamicPropertyPattern":{
|
|
"pattern":"[A-Za-z0-9]+",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"Description": {
|
|
"$ref": "Resource.0.96.0.json#Description"
|
|
},
|
|
"Message": {
|
|
"type": "string",
|
|
"readonly": true,
|
|
"description": "The actual message.",
|
|
"longDescription": "The value of this property shall be the message to be displayed. If a %integer is included in part of the string, it shall be used to represent a string substitution for any MessageArgs accompanying the message, in order."
|
|
},
|
|
"Severity": {
|
|
"type": "string",
|
|
"readonly": true,
|
|
"description": "This is the severity of the message.",
|
|
"longDescription": "The value of this property shall be the severity of the condition resulting in the message, as defined in the Status section of the Redfish specification."
|
|
},
|
|
"NumberOfArgs": {
|
|
"type": "integer",
|
|
"readonly": true,
|
|
"description": "The number of arguments to be expected to be passed in as MessageArgs for this message.",
|
|
"longDescription": "The value of this property shall be the number of MessageArgs that are expected to be substituted in the Message in the locations within the Message marked by %<integer>."
|
|
},
|
|
"ParamTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"string",
|
|
"number"
|
|
]
|
|
},
|
|
"readonly": true,
|
|
"description": "The MessageArg types, in order, for the message.",
|
|
"longDescription": "The value of this property shall be an ordered array of parameter types which match the types of the MessageArgs, in order."
|
|
},
|
|
"Resolution": {
|
|
"type": "string",
|
|
"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."
|
|
}
|
|
},
|
|
"required": [
|
|
"Message",
|
|
"Severity",
|
|
"NumberOfArgs",
|
|
"Resolution"
|
|
] }
|
|
},
|
|
"readonly": true,
|
|
"description": "The pattern property indicates that a free-form string is the unique identifier for the message within the registry.",
|
|
"longDescription": "The pattern property shall represent the suffix to be used in the MessageID and shall be unique within this message registry."
|
|
}
|
|
},
|
|
"required": [
|
|
"Language",
|
|
"RegistryPrefix",
|
|
"RegistryVersion",
|
|
"OwningEntity",
|
|
"Messages"
|
|
],
|
|
"description": "This is the schema definition for all Message Registries. It represents the properties for the registries themselves. The MessageID is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry.",
|
|
"longDescription": "This resource shall be used to represent a message registry for a Redfish implementation."
|
|
}
|