diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/MessageRegistry/MessageRegistry.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/MessageRegistry/MessageRegistry.json | 186 |
1 files changed, 107 insertions, 79 deletions
diff --git a/static/redfish/v1/JsonSchemas/MessageRegistry/MessageRegistry.json b/static/redfish/v1/JsonSchemas/MessageRegistry/MessageRegistry.json index a971cb931d..b1244f4598 100644 --- a/static/redfish/v1/JsonSchemas/MessageRegistry/MessageRegistry.json +++ b/static/redfish/v1/JsonSchemas/MessageRegistry/MessageRegistry.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/MessageRegistry.v1_3_1.json", "$ref": "#/definitions/MessageRegistry", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, - "description": "The available actions for this resource.", - "longDescription": "This type shall contain the available actions for this resource.", + "description": "The available actions for this Resource.", + "longDescription": "This type shall contain the available actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -24,8 +25,9 @@ "properties": { "Oem": { "$ref": "#/definitions/OemActions", - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource." + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This property shall contain the available OEM-specific actions for this Resource.", + "versionAdded": "v1_1_0" } }, "type": "object" @@ -33,9 +35,9 @@ "ClearingLogic": { "additionalProperties": false, "description": "The clearing logic associated with this message. The properties within indicate that what messages are cleared by this message as well as under what conditions.", - "longDescription": "This type shall contain the available actions for this resource.", + "longDescription": "This type shall contain the available actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -50,13 +52,14 @@ }, "properties": { "ClearsAll": { - "description": "This property indicates that all prior conditions and messages are cleared provided the ClearsIf condition is met.", - "longDescription": "This property shall indicate that all prior conditions and messages are cleared provided the ClearsIf condition is met.", + "description": "An indication of whether all prior conditions and messages are cleared, provided the ClearsIf condition is met.", + "longDescription": "This property shall indicate whether all prior conditions and messages are cleared, provided the ClearsIf condition is met.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_2_0" }, "ClearsIf": { "anyOf": [ @@ -67,41 +70,43 @@ "type": "null" } ], - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource.", - "readonly": true + "description": "The condition when the event is cleared.", + "longDescription": "This property shall contain the condition the event is cleared.", + "readonly": true, + "versionAdded": "v1_2_0" }, "ClearsMessage": { - "description": "This property contains the array of Message Ids that are cleared by this message, provided the other conditions are met.", + "description": "The array of MessageIds that this message clears when the other conditions are met.", "items": { "type": [ "string", "null" ] }, - "longDescription": "This property shall contain an array of Message Ids that are cleared by this message, provided the other conditions are met. The Message Ids shall not include the Registry name or version and shall just be the Message Id portion. Message Ids shall not reference other Message Registries.", + "longDescription": "This property shall contain an array of MessageIds that this message clears when the other conditions are met. The MessageIds shall not include the Message Registry name or version and shall contain only the MessageId portion. MessageIds shall not refer to other Message Registries.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" } }, "type": "object" }, "ClearingType": { - "description": "The enumerations of ClearingType specify the choice of conditions on when an event is cleared.", + "description": "The conditions when an event is cleared.", "enum": [ "SameOriginOfCondition" ], "enumDescriptions": { - "SameOriginOfCondition": "Indicates the message is cleared by the other message(s) listed in the ClearingLogic object, provided the OriginOfCondition for both Events are the same." + "SameOriginOfCondition": "This enumeration shall describe when the message for an event is cleared by the other messages in the ClearingLogic property, provided the OriginOfCondition for both events are the same." }, "type": "string" }, "Message": { "additionalProperties": false, - "description": "This type shall reprensent how a message is defined within the registry.", - "longDescription": "The type shall represent how a message is defined within within a message registry.", + "description": "This type represents how a message is defined within the Message Registry.", + "longDescription": "The type shall represent how a message is defined within a Message Registry.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -115,60 +120,90 @@ } }, "properties": { + "ArgDescriptions": { + "description": "The MessageArg descriptions, in order, used for this message.", + "items": { + "type": [ + "string", + "null" + ] + }, + "longDescription": "This property shall contain an ordered array of text describing each argument used as substitution in the message.", + "readonly": true, + "type": "array", + "versionAdded": "v1_3_0" + }, + "ArgLongDescriptions": { + "description": "The MessageArg normative descriptions, in order, used for this message.", + "items": { + "type": [ + "string", + "null" + ] + }, + "longDescription": "This property shall contain an ordered array of normative language for each argument used as substitution in the message.", + "readonly": true, + "type": "array", + "versionAdded": "v1_3_0" + }, "ClearingLogic": { - "anyOf": [ - { - "$ref": "#/definitions/ClearingLogic" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/ClearingLogic", "description": "The clearing logic associated with this message. The properties within indicate that what messages are cleared by this message as well as under what conditions.", - "longDescription": "This type shall contain the available actions for this resource." + "longDescription": "This type shall contain the available actions for this Resource.", + "versionAdded": "v1_2_0" }, "Description": { - "description": "This is a short description of how and when this message is to be used.", - "longDescription": "The value of this property shall indicate how and when this message is returned by the Redfish service.", + "description": "A short description of how and when to use this message.", + "longDescription": "This property shall indicate how and when this message is returned by the Redfish Service.", "readonly": true, "type": "string" }, + "LongDescription": { + "description": "The normative language that describes this message's usage.", + "longDescription": "This property shall contain the normative language that describes this message's usage in a Redfish implementation.", + "readonly": true, + "type": [ + "string", + "null" + ], + "versionAdded": "v1_3_0" + }, "Message": { "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.", + "longDescription": "This property shall contain the message to display. If a %integer is included in part of the string, it shall represent a string substitution for any MessageArgs that accompany the message, in order.", "readonly": true, "type": "string" }, "NumberOfArgs": { - "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>.", + "description": "The number of arguments in the message.", + "longDescription": "This property shall contain the number of arguments that are substituted for the locations marked with %<integer> in the message.", "minimum": 0, "readonly": true, "type": "integer" }, "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." + "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." }, "ParamTypes": { "description": "The MessageArg types, in order, for the message.", "items": { "$ref": "#/definitions/ParamType" }, - "longDescription": "The value of this property shall be an ordered array of parameter types which match the types of the MessageArgs, in order.", + "longDescription": "This property shall contain an ordered array of argument data types that match the data types of the MessageArgs.", "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 an override of the Resolution of the message in message registry, if present.", + "longDescription": "This property shall contain an override of the resolution of the message in the Message Registry, if present.", "readonly": true, "type": "string" }, "Severity": { - "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.", + "description": "The severity of the message.", + "longDescription": "This property shall contain the severity of the condition resulting in the message, as defined in the Status clause of the Redfish Specification.", "readonly": true, "type": "string" } @@ -184,13 +219,13 @@ }, "MessageProperty": { "additionalProperties": false, - "description": "The pattern type indicates that a free-form string is the unique identifier for the message within the registry.", - "longDescription": "The pattern type shall represent the suffix to be used in the MessageId and shall be unique within this message registry.", + "description": "The message keys contained in the Message Registry.", + "longDescription": "This type shall contain the message keys contained in the Message Registy. The message keys are the suffix of the MessageId and shall be unique within this Message Registry.", "patternProperties": { "[A-Za-z0-9]+": { "$ref": "#/definitions/Message" }, - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -208,10 +243,10 @@ }, "MessageRegistry": { "additionalProperties": false, - "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.", + "description": "The MessageRegistry schema describes all Message Registries. It represents the properties for the Message Registries themselves.", + "longDescription": "This Resource shall represent a Message Registry for a Redfish implementation.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -225,22 +260,14 @@ } }, "properties": { - "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" - }, - "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" - }, - "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" - }, "@odata.type": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", - "description": "The available actions for this resource.", - "longDescription": "The Actions property shall contain the available actions for this resource." + "description": "The available actions for this Resource.", + "longDescription": "This property shall contain the available actions for this Resource.", + "versionAdded": "v1_1_0" }, "Description": { "anyOf": [ @@ -258,15 +285,15 @@ "readonly": true }, "Language": { - "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.", + "description": "The RFC5646-conformant language code for the Message Registry.", + "longDescription": "This property shall contain an RFC5646-conformant language code.", "readonly": true, "type": "string" }, "Messages": { "$ref": "#/definitions/MessageProperty", - "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." + "description": "The message keys contained in the Message Registry.", + "longDescription": "This property shall contain the message keys contained in the Message Registy. The message keys are the suffix of the MessageId and shall be unique within this Message Registry." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -274,24 +301,25 @@ }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/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*." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "OwningEntity": { - "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.", + "description": "The organization or company that publishes this Message Registry.", + "longDescription": "This property shall represent the publisher of this Message Registry.", "readonly": true, "type": "string" }, "RegistryPrefix": { - "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.", + "description": "The single-word prefix that is used in forming and decoding MessageIds.", + "longDescription": "This property shall contain the Redfish Specification-defined prefix used in forming and decoding MessageIds that uniquely identifies all messages that belong to this Message Registry.", "readonly": true, "type": "string" }, "RegistryVersion": { - "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.", + "description": "The Message Registry version in the middle portion of a MessageId.", + "longDescription": "This property shall contain the version of this Message Registry.", + "pattern": "^\\d+\\.\\d+\\.\\d+$", "readonly": true, "type": "string" } @@ -302,7 +330,6 @@ "RegistryVersion", "OwningEntity", "Messages", - "@odata.id", "@odata.type", "Id", "Name" @@ -311,10 +338,10 @@ }, "OemActions": { "additionalProperties": true, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This type shall contain the available OEM-specific actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -336,12 +363,13 @@ "number" ], "enumDescriptions": { - "number": "The parameter is a number.", - "string": "The parameter is a string." + "number": "The argument is a number.", + "string": "The argument is a string." }, "type": "string" } }, "owningEntity": "DMTF", - "title": "#MessageRegistry.v1_2_0.MessageRegistry" + "release": "2019.1", + "title": "#MessageRegistry.v1_3_1.MessageRegistry" }
\ No newline at end of file |