Update Redfish schemas to 2019.2
Note, the DMTF changed the format of the schema file pack yet again, so
the script changes now to compensate for that.
Tested:
Ran schema validator. One unrelated failure in LogEntry, and 4 new
warnings in PCIe devices (we're using a deprecated property). All other
endpoints pass.
Signed-off-by: Ed Tanous <ed.tanous@intel.com>
Change-Id: I81c030a7c5a6a32cc12a5e7e02a9441b7891bc5d
diff --git a/static/redfish/v1/JsonSchemas/AttributeRegistry/AttributeRegistry.json b/static/redfish/v1/JsonSchemas/AttributeRegistry/AttributeRegistry.json
index 09cd4e8..2bb4553 100644
--- a/static/redfish/v1/JsonSchemas/AttributeRegistry/AttributeRegistry.json
+++ b/static/redfish/v1/JsonSchemas/AttributeRegistry/AttributeRegistry.json
@@ -1,15 +1,15 @@
{
- "$id": "http://redfish.dmtf.org/schemas/v1/AttributeRegistry.v1_3_0.json",
+ "$id": "http://redfish.dmtf.org/schemas/v1/AttributeRegistry.v1_3_2.json",
"$ref": "#/definitions/AttributeRegistry",
"$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",
@@ -25,8 +25,8 @@
"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"
}
},
@@ -34,10 +34,10 @@
},
"AttributeRegistry": {
"additionalProperties": false,
- "description": "The AttributeRegistry schema contains a set of key-value pairs that represents the structure of a Registry. It includes mechanisms for building user interfaces (menus), allowing consistent navigation of the contents. The Attribute Registry is specific to a particular implementation or product. The attributes and property names are not standardized.",
- "longDescription": "This resource shall be used to represent an Attribute registry for a Redfish implementation.",
+ "description": "The AttributeRegistry schema contains a set of key-value pairs that represent the structure of an Attribute Registry. It includes mechanisms for building user interfaces, or menus, allowing consistent navigation of the contents. The Attribute Registry is specific to an implementation or product. The attributes and property names are not standardized.",
+ "longDescription": "This Resource shall represent an Attribute 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",
@@ -51,22 +51,13 @@
}
},
"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": {
@@ -85,8 +76,8 @@
"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 Attribute Registry.",
+ "longDescription": "This property shall contain an RFC5646-conformant language code.",
"readonly": true,
"type": "string"
},
@@ -96,32 +87,33 @@
},
"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 Attribute Registry.",
+ "longDescription": "This property shall represent the publisher of this Attribute Registry.",
"readonly": true,
"type": "string"
},
"RegistryEntries": {
"$ref": "#/definitions/RegistryEntries",
- "description": "List of all attributes and their metadata for this component.",
- "longDescription": "The value of this property shall a list of all attributes for this component, along with their possible values, dependencies, and other metadata."
+ "description": "The list of all attributes and their metadata for this component.",
+ "longDescription": "This property shall list attributes for this component, along with their possible values, dependencies, and other metadata."
},
"RegistryVersion": {
- "description": "This is the attribute registry version which is used in the middle portion of a AttributeRegistry.",
- "longDescription": "The value of this property shall be the version of this attribute 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 Attribute Registry version.",
+ "longDescription": "This property shall contain the version of this Attribute Registry.",
+ "pattern": "^\\d+\\.\\d+\\.\\d+$",
"readonly": true,
"type": "string"
},
"SupportedSystems": {
- "description": "Array of systems supported by this attribute registry.",
+ "description": "An array of systems that this Attribute Registry supports.",
"items": {
"$ref": "#/definitions/SupportedSystems"
},
- "longDescription": "The value of this property shall be an array containing a list of systems supported by this attribute registry.",
+ "longDescription": "This property shall contain an array containing a list of systems that this Attribute Registry supports.",
"type": "array"
}
},
@@ -129,7 +121,6 @@
"Language",
"RegistryVersion",
"OwningEntity",
- "@odata.id",
"@odata.type",
"Id",
"Name"
@@ -145,20 +136,20 @@
"Password"
],
"enumDescriptions": {
- "Boolean": "The attributes that are true or false.",
- "Enumeration": "The attributes that include a list of the known possible enumerated values.",
- "Integer": "The attributes that have integer numeric values.",
- "Password": "The attributes that include password values and are not displayed as plain text. The value shall be null for GET requests.",
- "String": "The attributes that include free form text in their values."
+ "Boolean": "A flag with a `true` or `false` value.",
+ "Enumeration": "A list of the known possible enumerated values.",
+ "Integer": "An integer value.",
+ "Password": "Password values that do not appear as plain text. The value shall be null in responses.",
+ "String": "Free-form text in their values."
},
"type": "string"
},
"AttributeValue": {
"additionalProperties": false,
- "description": "A possible value for attributes of type 'Enumeration'.",
- "longDescription": "This type shall describe a possible value of an attribute of type 'Enumeration'.",
+ "description": "A possible value for an enumeration attribute.",
+ "longDescription": "This type shall describe a possible enumeration attribute value.",
"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",
@@ -173,8 +164,8 @@
},
"properties": {
"ValueDisplayName": {
- "description": "A user-readable display string of the value of the attribute in the defined 'Language'.",
- "longDescription": "The value of this property shall be a string representing the user-readable display string of the value of the attribute in the defined 'Language'.",
+ "description": "A user-readable display string of the value for the attribute in the defined language.",
+ "longDescription": "This property shall contain a string representing the user-readable display string of the value for the attribute in the defined language.",
"readonly": true,
"type": [
"string",
@@ -182,8 +173,8 @@
]
},
"ValueName": {
- "description": "The unique value name of the attribute.",
- "longDescription": "The value of this property shall be a string representing the value name of the attribute. ValueName is a unique string within the list of possible values in the 'Value' array of a given attribute.",
+ "description": "The unique value name for the attribute.",
+ "longDescription": "This property shall contain a string representing the value name for the attribute. ValueName is a unique string within the list of possible values in the Value array for an attribute.",
"readonly": true,
"type": "string"
}
@@ -195,10 +186,10 @@
},
"Attributes": {
"additionalProperties": false,
- "description": "An attribute and its possible values.",
+ "description": "An attribute and its possible values and other metadata.",
"longDescription": "This type shall describe an attribute and its possible values and other metadata.",
"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",
@@ -213,15 +204,15 @@
},
"properties": {
"AttributeName": {
- "description": "The unique name of the attribute.",
- "longDescription": "The value of this property shall be the name of this attribute that is unique in this registry.",
+ "description": "The unique name for the attribute.",
+ "longDescription": "This property shall contain the name of this attribute that is unique in this Attribute Registry.",
"pattern": "^[A-Za-z][A-Za-z0-9_]+$",
"readonly": true,
"type": "string"
},
"CurrentValue": {
- "description": "Placeholder of the current value of the attribute.",
- "longDescription": "Placeholder of the current value of the attribute, to aid in evaluating dependencies. The current value of an attribute might be affected by the results of evaluating the 'Dependencies' array.",
+ "description": "The placeholder of the current value for the attribute.",
+ "longDescription": "This property shall contain the placeholder of the current value for the attribute, to aid in evaluating dependencies. The evaluation results of the Dependencies array might affect the current attribute value.",
"readonly": true,
"type": [
"string",
@@ -231,8 +222,8 @@
]
},
"DefaultValue": {
- "description": "The default current value of the attribute.",
- "longDescription": "The value of this property shall be the default value of the attribute.",
+ "description": "The default value for the attribute.",
+ "longDescription": "This property shall contain the default value for the attribute.",
"readonly": true,
"type": [
"string",
@@ -242,8 +233,8 @@
]
},
"DisplayName": {
- "description": "The user-readable display string of the attribute in the defined 'Language'.",
- "longDescription": "The value of this property shall be the user-readable display string of the attribute in the defined 'Language'.",
+ "description": "The user-readable display string for the attribute in the defined language.",
+ "longDescription": "This property shall contain the user-readable display string for the attribute in the defined language.",
"readonly": true,
"type": [
"string",
@@ -251,8 +242,8 @@
]
},
"DisplayOrder": {
- "description": "The numeric value describing the ascending order that the attribute is displayed relative to other attributes.",
- "longDescription": "The value of this property shall be a number the describes the ascending order in which this attribute is displayed, relative to other attributes.",
+ "description": "The ascending order, as a number, in which this attribute appears relative to other attributes.",
+ "longDescription": "This property shall contain the ascending order, as a number, in which this attribute appears relative to other attributes.",
"readonly": true,
"type": [
"integer",
@@ -260,8 +251,8 @@
]
},
"GrayOut": {
- "description": "The gray-out state of this attribute.",
- "longDescription": "The value of this property shall be a boolean describing the gray-out state of this attribute. When set to true, a grayed-out attribute should be grayed out in user interfaces. But, unlike ReadOnly, the value of grayed-out attributes might still be modified. The grayout state of an attribute might be affected by the results of evaluating the 'Dependencies' array.",
+ "description": "An indication of whether this attribute is grayed out. A grayed-out attribute is not active and is grayed out in user interfaces but the attribute value can be modified.",
+ "longDescription": "This property shall indicate whether this attribute is grayed out. A grayed-out attribute is not active and is grayed out in user interfaces but the attribute value can be modified. The evaluation results of the Dependencies array might affect the grayed-out state of an attribute.",
"readonly": true,
"type": [
"boolean",
@@ -270,7 +261,7 @@
},
"HelpText": {
"description": "The help text for the attribute.",
- "longDescription": "The value of this property shall be the help text of the attribute.",
+ "longDescription": "This property shall contain the help text for the attribute.",
"readonly": true,
"type": [
"string",
@@ -278,8 +269,8 @@
]
},
"Hidden": {
- "description": "The hidden state of this attribute.",
- "longDescription": "The value of this property shall be a boolean describing the visibility state of this attribute. When set to true, a hidden attribute should be hidden in user interfaces. The hidden state of an attribute might be affected by the results of evaluating the 'Dependencies' array.",
+ "description": "An indication of whether this attribute is hidden in user interfaces.",
+ "longDescription": "This property shall indicate whether this attribute is hidden in user interfaces. The evaluation results of the Dependencies array might affect the hidden state of an attribute.",
"readonly": true,
"type": [
"boolean",
@@ -287,8 +278,8 @@
]
},
"Immutable": {
- "description": "Defines whether this attribute is immutable or not.",
- "longDescription": "The value of this property shall be a boolean describing the immutable state of this attribute. Immutable attributes should not be modified and are typically used to reflect a hardware state.",
+ "description": "An indication of whether this attribute is immutable. Immutable attributes shall not be modified and typically reflect a hardware state.",
+ "longDescription": "This property shall indicate whether this attribute is immutable. Immutable attributes shall not be modified and typically reflect a hardware state.",
"readonly": true,
"type": [
"boolean",
@@ -296,8 +287,8 @@
]
},
"IsSystemUniqueProperty": {
- "description": "Defines whether this attribute is unique for this system and should not be replicated.",
- "longDescription": "The value of this property shall be a boolean describing this attribute is unique or not. A value of true indicates that the attribute is unique and should not be replicated.",
+ "description": "An indication of whether this attribute is unique for this system and should not be replicated.",
+ "longDescription": "This property shall indicate whether this attribute is unique.",
"readonly": true,
"type": [
"boolean",
@@ -305,8 +296,8 @@
]
},
"LowerBound": {
- "description": "The lower limit of the value of an attribute of type 'Integer'.",
- "longDescription": "The value of this property shall be a number indicating the lower limit of the value of an attribute of type 'Integer'.",
+ "description": "The lower limit for an integer attribute.",
+ "longDescription": "This property shall contain a number indicating the lower limit for an integer attribute.",
"readonly": true,
"type": [
"integer",
@@ -314,8 +305,8 @@
]
},
"MaxLength": {
- "description": "The maximum character length of the value of an attribute of type 'String'.",
- "longDescription": "The value of this property shall be a number indicating the maximum character length of the value of an attribute of type 'String'.",
+ "description": "The maximum character length of a string attribute.",
+ "longDescription": "This numeric property shall contain the maximum character length of an attribute of the String type.",
"readonly": true,
"type": [
"integer",
@@ -323,8 +314,8 @@
]
},
"MenuPath": {
- "description": "A path that describes the menu hierarchy of this attribute.",
- "longDescription": "The value of this property shall be a string indicating the menu hierarchy of this attribute, in the form of a path to the menu names. It shall start with './' to indicate the root menu, followed by the menu names with '/' characters to delineate the menu traversal.",
+ "description": "The path that describes the menu hierarchy of this attribute.",
+ "longDescription": "This property shall contain the menu hierarchy of this attribute, in the form of a path to the menu names. It shall start with `./` to indicate the root menu, followed by the menu names with `/` characters to delineate the menu traversal.",
"pattern": "^\\.\\/([^/]+(\\/[^/]+)*)?$",
"readonly": true,
"type": [
@@ -333,8 +324,8 @@
]
},
"MinLength": {
- "description": "The minimum character length of the value of an attribute of type 'String'.",
- "longDescription": "The value of this property shall be a number indicating the minimum character length of the value of an attribute of type 'String'.",
+ "description": "The minimum character length of the string attribute.",
+ "longDescription": "This property shall contain a number indicating the minimum character length of an attribute of the String type.",
"readonly": true,
"type": [
"integer",
@@ -343,13 +334,13 @@
},
"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.",
"versionAdded": "v1_3_0"
},
"ReadOnly": {
- "description": "The read-only state of this attribute.",
- "longDescription": "The value of this property shall be a boolean describing the read-only state of attribute. A read-only attribute cannot be modified, and should be grayed out in user interfaces. The read-only state of an attribute might be affected by the results of evaluating the 'Dependencies' array.",
+ "description": "An indication of whether this attribute is read-only. A read-only attribute cannot be modified, and should be grayed out in user interfaces.",
+ "longDescription": "This property shall indicate whether this attribute is read-only. A read-only attribute cannot be modified, and should be grayed out in user interfaces. The evaluation results of the Dependencies array might affect the read-only state of an attribute.",
"readonly": true,
"type": [
"boolean",
@@ -357,8 +348,8 @@
]
},
"ResetRequired": {
- "description": "True if changing the value of this attribute requires a system or device reset in order to take effect.",
- "longDescription": "The value of this property shall be a boolean describing the requirement for a system or device reset for this attribute value change to take effect.",
+ "description": "An indication of whether a system or device reset is required for this attribute value change to take effect.",
+ "longDescription": "This property shall indicate whether a system or device reset is required for this attribute value change to take effect.",
"readonly": true,
"type": [
"boolean",
@@ -367,8 +358,8 @@
"versionAdded": "v1_2_0"
},
"ScalarIncrement": {
- "description": "The amount to increment or decrement the value of an attribute of type 'Integer' each time a user requests a value change.",
- "longDescription": "The value of this property shall be a number indicating the amount to increment or decrement the value of an attribute of type 'Integer' each time a user requests a value change. A ScalarIncrement value of 0 indicates a free-form numeric user input.",
+ "description": "The amount to increment or decrement an integer attribute each time a user requests a value change. The `0` value indicates a free-form numeric user-input attribute.",
+ "longDescription": "This property shall contain a number indicating the amount to increment or decrement an integer attribute each time a user requests a value change. The `0` value indicates a free-form numeric user-input attribute.",
"readonly": true,
"type": [
"integer",
@@ -377,13 +368,13 @@
},
"Type": {
"$ref": "#/definitions/AttributeType",
- "description": "The type of the attribute.",
- "longDescription": "The value of this property shall be an enumeration describing type of the attribute.",
+ "description": "The attribute type.",
+ "longDescription": "This property shall contain an enumeration that describes the attribute type.",
"readonly": true
},
"UefiDevicePath": {
"description": "The UEFI device path that qualifies this attribute.",
- "longDescription": "This property shall contain the UEFI device path string used to qualify and locate the specific device for this Attribute, as defined by the UEFI Specification.",
+ "longDescription": "This property shall contain the UEFI Specification-defined UEFI device path that qualifies and locates this device for this attribute.",
"readonly": true,
"type": [
"string",
@@ -392,22 +383,22 @@
"versionAdded": "v1_2_0"
},
"UefiKeywordName": {
- "description": "The UEFI KeywordString of the attribute.",
- "longDescription": "The value of this property shall be the configuration KeywordString of this attribute, as defined in the UEFI Specification.",
+ "description": "The UEFI keyword string for this attribute.",
+ "longDescription": "This property shall contain the UEFI Specification-defined keyword for this attribute.",
"readonly": true,
"type": "string",
"versionAdded": "v1_2_0"
},
"UefiNamespaceId": {
- "description": "The UEFI NamespaceId of the attribute.",
- "longDescription": "The value of this property shall be the configuration NamespaceId of this attribute, as defined in the UEFI Specification.",
+ "description": "The UEFI namespace ID for the attribute.",
+ "longDescription": "This property shall contain the UEFI Specification-defined namespace ID for this attribute.",
"readonly": true,
"type": "string",
"versionAdded": "v1_2_0"
},
"UpperBound": {
- "description": "The upper limit of the value of an attribute of type 'Integer'.",
- "longDescription": "The value of this property shall be a number indicating the upper limit of the value of an attribute of type 'Integer'.",
+ "description": "The upper limit for an integer attribute.",
+ "longDescription": "This property shall contain a number indicating the upper limit for an integer attribute.",
"readonly": true,
"type": [
"integer",
@@ -415,16 +406,16 @@
]
},
"Value": {
- "description": "The array containing possible values for attributes of type 'Enumeration'.",
+ "description": "An array of the possible values for enumerated attribute values.",
"items": {
"$ref": "#/definitions/AttributeValue"
},
- "longDescription": "The value of this property shall be an array containing the possible values of an attribute of type 'Enumeration'.",
+ "longDescription": "This property shall contain an array containing the possible values of an attribute of the Enumeration type.",
"type": "array"
},
"ValueExpression": {
- "description": "A regular expression that is used to validate the value of the attribute. This is only applicable to attributes of type 'String' or 'Integer'.",
- "longDescription": "The value of this property shall be a regular expression that is valid according to the Perl regular expression dialect. This string is used to validate the value of the attribute. This is only applicable to attributes of type 'String' or 'Integer'.",
+ "description": "A valid regular expression, according to the Perl regular expression dialect, that validates the attribute value. Applies to only string and integer attributes.",
+ "longDescription": "This property shall contain a valid regular expression, according to the Perl regular expression dialect, that validates the attribute value. Applies to only string and integer attributes.",
"readonly": true,
"type": [
"string",
@@ -432,8 +423,8 @@
]
},
"WarningText": {
- "description": "The warning text for changing the attribute.",
- "longDescription": "The value of this property shall be the warning text of the attribute.",
+ "description": "The warning text for the attribute.",
+ "longDescription": "This property shall contain the warning text for the attribute.",
"readonly": true,
"type": [
"string",
@@ -441,8 +432,8 @@
]
},
"WriteOnly": {
- "description": "Defines whether this attribute is write-only. Such attributes revert back to their initial value after settings are applied.",
- "longDescription": "The value of this property shall be a boolean describing the write-only state of this attribute. A write-only attribute reverts back to it's initial value after settings are applied.",
+ "description": "An indication of whether this attribute is write-only. A write-only attribute reverts to its initial value after settings are applied.",
+ "longDescription": "This property shall indicate whether this attribute is write-only. A write-only attribute reverts to its initial value after settings are applied.",
"readonly": true,
"type": [
"boolean",
@@ -457,10 +448,10 @@
},
"Dependencies": {
"additionalProperties": false,
- "description": "A dependency of attributes on this component.",
+ "description": "The dependency of attributes on this component.",
"longDescription": "This type shall describe a dependency of attributes on this component.",
"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",
@@ -476,12 +467,12 @@
"properties": {
"Dependency": {
"$ref": "#/definitions/Dependency",
- "description": "The dependency expression for one or more Attributes in this Attribute Registry.",
- "longDescription": "The value of this property shall be the dependency expression for one or more Attributes in this Attribute Registry."
+ "description": "The dependency expression for one or more attributes in this Attribute Registry.",
+ "longDescription": "This property shall contain the dependency expression for one or more attributes in this Attribute Registry."
},
"DependencyFor": {
"description": "The AttributeName of the attribute whose change triggers the evaluation of this dependency expression.",
- "longDescription": "The value of this property shall be the AttributeName of the attribute whose change triggers the evaluation of this dependency expression.",
+ "longDescription": "This property shall contain the AttributeName of the attribute whose change triggers the evaluation of this dependency expression.",
"pattern": "^[A-Za-z][A-Za-z0-9_]+$",
"readonly": true,
"type": "string"
@@ -489,7 +480,7 @@
"Type": {
"$ref": "#/definitions/DependencyType",
"description": "The type of the dependency structure.",
- "longDescription": "The value of this property shall be an enumeration describing type of the attribute dependency.",
+ "longDescription": "This property shall contain an enumeration that describes the type for the attribute dependency.",
"readonly": true
}
},
@@ -497,10 +488,10 @@
},
"Dependency": {
"additionalProperties": false,
- "description": "The dependency expression for one or more Attributes in this Attribute Registry.",
- "longDescription": "This type shall describe the dependency expression for one or more Attributes in this Attribute Registry.",
+ "description": "The dependency expression for one or more attributes in this Attribute Registry.",
+ "longDescription": "This type shall describe the dependency expression for one or more attributes in this Attribute 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",
@@ -515,29 +506,29 @@
},
"properties": {
"MapFrom": {
- "description": "Array of the map-from conditions for mapping dependency.",
+ "description": "An array of the map-from conditions for a mapping dependency.",
"items": {
"$ref": "#/definitions/MapFrom"
},
- "longDescription": "The value of this property shall be an array containing the map-from conditions for a dependency of Type 'Map'.",
+ "longDescription": "This property shall contain an array containing the map-from conditions for a dependency of the Map type.",
"type": "array"
},
"MapToAttribute": {
- "description": "The Name of the attribute that is affected by this dependency expression.",
- "longDescription": "The value of this property shall be the AttributeName of the attribute that is affected by this dependency expression.",
+ "description": "The AttributeName of the attribute that is affected by this dependency expression.",
+ "longDescription": "This property shall contain the AttributeName of the attribute that is affected by this dependency expression.",
"pattern": "^[A-Za-z][A-Za-z0-9_]+$",
"readonly": true,
"type": "string"
},
"MapToProperty": {
"$ref": "#/definitions/MapToProperty",
- "description": "The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.",
- "longDescription": "The value of this property shall be the meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression. For example, this could be the MapFromAttribute CurrentValue, or ReadOnly state.",
+ "description": "The metadata property for the attribute that contains the map-from condition that evaluates this dependency expression.",
+ "longDescription": "This property shall contain the metadata property for the attribute that the MapFromAttribute property specifies that evaluates this dependency expression. For example, this value could be the MapFromAttribute CurrentValue or ReadOnly state.",
"readonly": true
},
"MapToValue": {
- "description": "The value that MapToProperty is changed to if the dependency expression evaluates to true.",
- "longDescription": "The value that the property specified in MapToProperty (in the attribute specified in MapToAttribute) is changed to if the dependency expression evaluates to true.",
+ "description": "The value that the map-to property changes to if the dependency expression evaluates to `true`.",
+ "longDescription": "The value that the property in MapToProperty in the attribute specified in MapToAttribute changes to if the dependency expression evaluates to `true`.",
"readonly": true,
"type": [
"string",
@@ -554,16 +545,16 @@
"Map"
],
"enumDescriptions": {
- "Map": "A simple mapping dependency. The attribute value or state is changed to the mapped value if the condition evaluates to true."
+ "Map": "A simple mapping dependency. If the condition evaluates to `true`, the attribute or state changes to the mapped value."
},
"type": "string"
},
"MapFrom": {
"additionalProperties": false,
"description": "A map-from condition for mapping dependency.",
- "longDescription": "This type shall describe a map-from condition for a dependency of Type 'Map'.",
+ "longDescription": "This type shall describe a map-from condition for a dependency of the Map type.",
"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",
@@ -578,27 +569,27 @@
},
"properties": {
"MapFromAttribute": {
- "description": "The attribute that is used to evaluate this dependency expression.",
- "longDescription": "The value of this property shall be the AttributeName of the attribute that is used in evaluating this dependency expression term.",
+ "description": "The attribute to use to evaluate this dependency expression.",
+ "longDescription": "This property shall contain the AttributeName for the attribute to use to evaluate this dependency expression term.",
"pattern": "^[A-Za-z][A-Za-z0-9_]+$",
"readonly": true,
"type": "string"
},
"MapFromCondition": {
"$ref": "#/definitions/MapFromCondition",
- "description": "The condition that is used to evaluate this dependency expression.",
- "longDescription": "The value of this property shall be the condition that is used to evaluate this dependency expression. For example, 'EQU' or 'NEQ'.",
+ "description": "The condition to use to evaluate this dependency expression.",
+ "longDescription": "This property shall contain the condition to use to evaluate this dependency expression. For example, `EQU` or `NEQ`.",
"readonly": true
},
"MapFromProperty": {
"$ref": "#/definitions/MapFromProperty",
- "description": "The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.",
- "longDescription": "The value of this property shall be the meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression. For example, this could be the MapFromAttribute CurrentValue, or ReadOnly state.",
+ "description": "The metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression.",
+ "longDescription": "This property shall contain the metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression. For example, this value could be the MapFromAttribute CurrentValue, or ReadOnly state.",
"readonly": true
},
"MapFromValue": {
- "description": "The value that the is used property specified in MapFromProperty that is used to evaluate this dependency expression.",
- "longDescription": "The value that the property specified in MapFromProperty (in the attribute specified in MapFromAttribute) that is used to evaluate this dependency expression.",
+ "description": "The value to use to evaluate this dependency expression.",
+ "longDescription": "The value that the property in MapFromProperty in the attribute in MapFromAttribute to use to evaluate this dependency expression.",
"readonly": true,
"type": [
"string",
@@ -609,8 +600,8 @@
},
"MapTerms": {
"$ref": "#/definitions/MapTerms",
- "description": "The logical term used to combine two or more MapFrom conditions in this dependency expression.",
- "longDescription": "The value of this property shall be the logical term used to combine two or more MapFrom conditions in this dependency expression. For example, 'AND' for logical AND, or 'OR' for logical OR of the conditions.",
+ "description": "The logical term that combines two or more map-from conditions in this dependency expression. For example, `AND` for logical AND, or `OR` for logical OR.",
+ "longDescription": "This property shall contain the logical term that combines two or more MapFrom conditions in this dependency expression. For example, `AND` for logical AND, or `OR` for logical OR.",
"readonly": true
}
},
@@ -718,10 +709,10 @@
},
"Menus": {
"additionalProperties": false,
- "description": "A menu and its hierarchy.",
+ "description": "An attribute's menu and its hierarchy.",
"longDescription": "This type shall describe an attribute's menu and its hierarchy.",
"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",
@@ -736,8 +727,8 @@
},
"properties": {
"DisplayName": {
- "description": "The user-readable display string of this menu in the defined 'Language'.",
- "longDescription": "The value of this property shall be the user-readable display string of the menu in the defined 'Language'.",
+ "description": "The user-readable display string of this menu in the defined language.",
+ "longDescription": "This property shall contain the user-readable display string of the menu in the defined language.",
"readonly": true,
"type": [
"string",
@@ -745,8 +736,8 @@
]
},
"DisplayOrder": {
- "description": "The numeric value describing the ascending order in which this menu is displayed relative to other menus.",
- "longDescription": "The value of this property shall be a number the describes the ascending order in which this menu is displayed, relative to other menus.",
+ "description": "The ascending order, as a number, in which this menu appears relative to other menus.",
+ "longDescription": "This property shall contain the ascending order, as a number, in which this menu appears relative to other menus.",
"readonly": true,
"type": [
"integer",
@@ -754,8 +745,8 @@
]
},
"GrayOut": {
- "description": "The gray-out state of this menu. A grayed-only menu is not accessible in user interfaces.",
- "longDescription": "The value of this property shall be a boolean describing the gray-out state of this menu. When set to true, a grayed-only menu is not accessible in user interfaces.",
+ "description": "An indication of whether this menu is grayed out. A grayed-only menu is not accessible in user interfaces.",
+ "longDescription": "This property shall indicate whether this menu is grayed out. A grayed-only menu is not accessible in user interfaces.",
"readonly": true,
"type": [
"boolean",
@@ -763,8 +754,8 @@
]
},
"Hidden": {
- "description": "The hidden state of this menu.",
- "longDescription": "The value of this property shall be a boolean describing the visibility state of this menu. When set to true, a hidden menu should be hidden in user interfaces. The hidden state of a menu might be affected by the results of evaluating the 'Dependencies' array.",
+ "description": "An indication of whether this menu is hidden in user interfaces.",
+ "longDescription": "This property shall indicate whether this menu is hidden in user interfaces. The evaluation results of the Dependencies array might affect the hidden state of a menu.",
"readonly": true,
"type": [
"boolean",
@@ -774,14 +765,14 @@
},
"MenuName": {
"description": "The unique name string of this menu.",
- "longDescription": "The value of this property shall be the name of this menu that is unique in this registry.",
+ "longDescription": "This property shall contain the name of this menu that is unique in this Attribute Registry.",
"pattern": "^[^/]+$",
"readonly": true,
"type": "string"
},
"MenuPath": {
- "description": "A path that describes this menu hierarchy relative to other menus.",
- "longDescription": "The value of this property shall be a string indicating the menu hierarchy of this menu, in the form of a path to the menu names. It shall start with './' to indicate the root menu, followed by the menu names with '/' characters to delineate the menu traversal.",
+ "description": "The path to the menu names that describes this menu hierarchy relative to other menus.",
+ "longDescription": "This property shall contain the menu hierarchy of this menu, in the form of a path to the menu names. It shall start with `./` to indicate the root menu, followed by the menu names with `/` characters to delineate the menu traversal.",
"pattern": "^\\.\\/([^/]+(\\/[^/]+)*)?$",
"readonly": true,
"type": [
@@ -791,13 +782,13 @@
},
"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.",
"versionAdded": "v1_3_0"
},
"ReadOnly": {
- "description": "The read-only state of this menu.",
- "longDescription": "The value of this property shall be a boolean describing the read-only state of this menu. A read-only menu is not accessible in user interfaces, and all properties contained in that menu and its sub-menus become read-only.",
+ "description": "An indication of whether this menu is read-only. A read-only menu, its properties, and sub-menus are not accessible in user interfaces.",
+ "longDescription": "This property shall indicate whether this menu is read-only. A read-only menu is not accessible in user interfaces, and all properties contained in that menu and its sub-menus are read-only.",
"readonly": true,
"type": [
"boolean",
@@ -809,10 +800,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",
@@ -830,10 +821,10 @@
},
"RegistryEntries": {
"additionalProperties": false,
- "description": "List of all attributes and their metadata for this component.",
+ "description": "The list of all attributes and metadata for this component.",
"longDescription": "This type shall describe a list of all attributes for this component, along with their possible values, dependencies, and other metadata.",
"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",
@@ -848,27 +839,27 @@
},
"properties": {
"Attributes": {
- "description": "The array containing the attributes and their possible values.",
+ "description": "An array of attributes and their possible values in the Attribute Registry.",
"items": {
"$ref": "#/definitions/Attributes"
},
- "longDescription": "The value of this property shall be an array containing the attributes and their possible values and other metadata.",
+ "longDescription": "This property shall contain an array containing the attributes and their possible values and other metadata in the Attribute Registry.",
"type": "array"
},
"Dependencies": {
- "description": "The array containing a list of dependencies of attributes on this component.",
+ "description": "An array of dependencies of attributes on this component.",
"items": {
"$ref": "#/definitions/Dependencies"
},
- "longDescription": "The value of this property shall be an array containing a list of dependencies of attributes on this component.",
+ "longDescription": "This property shall contain an array containing a list of dependencies of attributes on this component.",
"type": "array"
},
"Menus": {
- "description": "The array containing the attributes menus and their hierarchy.",
+ "description": "An array for the attributes menus and their hierarchy in the Attribute Registry.",
"items": {
"$ref": "#/definitions/Menus"
},
- "longDescription": "The value of this property shall be an array containing the attributes menus and their hierarchy.",
+ "longDescription": "This property shall contain an array containing the attributes menus and their hierarchy in the Attribute Registry.",
"type": "array"
}
},
@@ -876,10 +867,10 @@
},
"SupportedSystems": {
"additionalProperties": false,
- "description": "A system supported by this attribute registry.",
- "longDescription": "This type shall describe a system supported by this attribute registry.",
+ "description": "A system that this Attribute Registry supports.",
+ "longDescription": "This type shall describe a system that this Attribute Registry supports.",
"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",
@@ -895,7 +886,7 @@
"properties": {
"FirmwareVersion": {
"description": "Firmware version.",
- "longDescription": "The version of the component firmware image that this registry applies to.",
+ "longDescription": "The version of the component firmware image to which this Attribute Registry applies.",
"readonly": true,
"type": [
"string",
@@ -904,8 +895,8 @@
"versionAdded": "v1_1_0"
},
"ProductName": {
- "description": "The product name of the system.",
- "longDescription": "The value of this property shall be the product name of the computer system that this registry applies to.",
+ "description": "The product name of the computer system to which this Attribute Registry applies.",
+ "longDescription": "This property shall contain the product name of the computer system to which this Attribute Registry applies.",
"readonly": true,
"type": [
"string",
@@ -913,8 +904,8 @@
]
},
"SystemId": {
- "description": "The system ID of the system.",
- "longDescription": "The value of this property shall be the system ID that identifies the computer system model that this registry applies to.",
+ "description": "The ID of the systems to which this Attribute Registry applies.",
+ "longDescription": "This property shall contain the system ID that identifies the systems to which this Attribute Registry applies. This may be identified by one or more properties in the ComputerSystem Resource, such as Model, SubModel, or SKU.",
"pattern": "^[A-Za-z0-9]+$",
"readonly": true,
"type": [
@@ -928,5 +919,5 @@
},
"owningEntity": "DMTF",
"release": "2018.3",
- "title": "#AttributeRegistry.v1_3_0.AttributeRegistry"
+ "title": "#AttributeRegistry.v1_3_2.AttributeRegistry"
}
\ No newline at end of file