diff options
| author | Ed Tanous <ed.tanous@intel.com> | 2019-10-08 21:34:22 +0300 |
|---|---|---|
| committer | Ed Tanous <ed.tanous@intel.com> | 2019-10-12 00:13:05 +0300 |
| commit | cb103130e18689b9a8e15284f930606d512328cd (patch) | |
| tree | 04c37c1099ca63a2d23ea71766805ab56babe853 /static/redfish/v1/JsonSchemas | |
| parent | 66664f25734f59618f53f7f8416e3894ecb4db37 (diff) | |
| download | bmcweb-cb103130e18689b9a8e15284f930606d512328cd.tar.xz | |
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
Diffstat (limited to 'static/redfish/v1/JsonSchemas')
85 files changed, 7978 insertions, 6975 deletions
diff --git a/static/redfish/v1/JsonSchemas/AccelerationFunction/AccelerationFunction.json b/static/redfish/v1/JsonSchemas/AccelerationFunction/AccelerationFunction.json index fb3b57a38e..dc1b17e6f9 100644 --- a/static/redfish/v1/JsonSchemas/AccelerationFunction/AccelerationFunction.json +++ b/static/redfish/v1/JsonSchemas/AccelerationFunction/AccelerationFunction.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/AccelerationFunction.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/AccelerationFunction.v1_0_2.json", "$ref": "#/definitions/AccelerationFunction", "$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": { "AccelerationFunction": { "additionalProperties": false, - "description": "The AccelerationFunction schema defines the accelerator implemented in a Processor device.", - "longDescription": "This resource shall be used to represent the acceleration function, implemented in a Processor, in a Redfish implementation.", + "description": "The AccelerationFunction schema describes an acceleration function that a processor implements. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.", + "longDescription": "This Resource shall represent the acceleration function that a processor implements in a Redfish implementation. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.", "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,16 +24,16 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AccelerationFunctionType": { "anyOf": [ @@ -44,14 +44,14 @@ "type": "null" } ], - "description": "The type of acceleration function.", - "longDescription": "This property shall contain the string which identifies the type of acceleration function.", + "description": "The acceleration function type.", + "longDescription": "This property shall contain the string that identifies the acceleration function type.", "readonly": true }, "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." }, "Description": { "anyOf": [ @@ -65,11 +65,11 @@ "readonly": true }, "FpgaReconfigurationSlots": { - "description": "An array of the reconfiguration slot identifiers for an FPGA.", + "description": "An array of the reconfiguration slot identifiers of the FPGA that this acceleration function occupies.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be an array of the FPGA reconfiguration slots identifiers that this acceleration function occupies.", + "longDescription": "This property shall contain an array of the FPGA reconfiguration slot identifiers that this acceleration function occupies.", "readonly": true, "type": "array" }, @@ -79,12 +79,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by, or subordinate to, this Resource." }, "Manufacturer": { "description": "The acceleration function code manufacturer.", - "longDescription": "This property shall contain a string which identifies the manufacturer of the acceleration function.", + "longDescription": "This property shall contain a string that identifies the manufacturer of the acceleration function.", "readonly": true, "type": "string" }, @@ -94,20 +94,20 @@ }, "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." }, "PowerWatts": { - "description": "The acceleration function power consumption.", - "longDescription": "The total acceleration function power consumtion in watts.", + "description": "The acceleration function power consumption, in watts.", + "longDescription": "This property shall contain the total acceleration function power consumption, in watts.", "readonly": true, "type": "integer", "units": "W" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UUID": { "anyOf": [ @@ -118,13 +118,13 @@ "type": "null" } ], - "description": "The universal unique identifier (UUID) for this acceleration function.", - "longDescription": "The value of this property shall be used to contain a universal unique identifier number for the acceleration function. RFC4122 describes methods that can be used to create the value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", + "description": "The UUID for this acceleration function.", + "longDescription": "This property shall contain a UUID for the acceleration function. RFC4122 describes methods that can create the value. The value should be considered to be opaque. Client software should only treat the overall value as a UUID and should not interpret any sub-fields within the UUID.", "readonly": true }, "Version": { "description": "The acceleration function version.", - "longDescription": "The value of this property shall contain a string decsribing the acceleration function version.", + "longDescription": "This property shall describe the acceleration function version.", "readonly": true, "type": "string" } @@ -162,10 +162,10 @@ }, "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", @@ -181,18 +181,18 @@ "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." } }, "type": "object" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by, or subordinate to, 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", @@ -207,43 +207,43 @@ }, "properties": { "Endpoints": { - "description": "An array of references to the endpoints that connect to this acceleartion function.", + "description": "An array of links to the endpoints that connect to this acceleration function.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be an array of references to resources of type Endpoint that are associated with this acceleration function.", + "longDescription": "This property shall contain an array of links to Resources of the Endpoint type that are associated with this acceleration function.", "readonly": true, "type": "array" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PCIeFunctions": { - "description": "An array of references to the PCIeFunctions associated with this acceleration function.", + "description": "An array of links to the PCIeFunctions associated with this acceleration function.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction" }, - "longDescription": "The value of this property shall be an array of references of type PCIeFunction that represent the PCI-e Functions associated with this acceleration function.", + "longDescription": "This property shall contain an array of links of the PCIeFunction type that represent the PCIe functions associated with this acceleration function.", "readonly": true, "type": "array" }, "PCIeFunctions@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -262,5 +262,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#AccelerationFunction.v1_0_0.AccelerationFunction" + "title": "#AccelerationFunction.v1_0_2.AccelerationFunction" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/AccountService/AccountService.json b/static/redfish/v1/JsonSchemas/AccountService/AccountService.json index d34bbf418e..487b3f4012 100644 --- a/static/redfish/v1/JsonSchemas/AccountService/AccountService.json +++ b/static/redfish/v1/JsonSchemas/AccountService/AccountService.json @@ -1,8 +1,8 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/AccountService.v1_4_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/AccountService.v1_6_0.json", "$ref": "#/definitions/AccountService", "$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": { "AccountProviderTypes": { "enum": [ @@ -12,24 +12,24 @@ "OEM" ], "enumDescriptions": { - "ActiveDirectoryService": "An external Active Directory Service.", - "LDAPService": "A generic external LDAP Service.", - "OEM": "An OEM specific external authentication or directory service.", + "ActiveDirectoryService": "An external Active Directory service.", + "LDAPService": "A generic external LDAP service.", + "OEM": "An OEM-specific external authentication or directory service.", "RedfishService": "An external Redfish Service." }, "enumLongDescriptions": { - "ActiveDirectoryService": "The external account provider shall be a service conforming to the Microsoft Active Directory Technical specification. The format of ServiceAddresses shall be a collection of FQDNs or Netbios names that references the set of domain servers for the Active Directory service.", - "LDAPService": "The external account provider shall be a service conforming to RFC4511. The format of ServiceAddresses shall be a collection of FQDNs that references the set of LDAP servers for the service.", - "RedfishService": "The external account provider shall be a service conforming to the DMTF Redfish specification. The format of ServiceAddresses shall be a collection of URIs which corresponds to a Redfish AccountService entity." + "ActiveDirectoryService": "The external account provider shall be a Microsoft Active Directory Technical Specification-comformant service. The ServiceAddresses format shall contain a set of fully qualified domain names (FQDN) or NetBIOS names that links to the set of domain servers for the Active Directory Service.", + "LDAPService": "The external account provider shall be an RFC4511-conformant service. The ServiceAddresses format shall contain a set of fully qualified domain names (FQDN) that links to the set of LDAP servers for the Service.", + "RedfishService": "The external account provider shall be a DMTF Redfish Specification-comformant service. The ServiceAddresses format shall contain a set of URIs that correspond to a Redfish Account Service." }, "type": "string" }, "AccountService": { "additionalProperties": false, - "description": "The AccountService schema contains properties for managing user accounts. The properties are common to all user accounts, such as password requirements, and control features such as account lockout. The schema also contains links to the collections of Manager Accounts and Roles.", - "longDescription": "This resource shall be used to represent a management account service for a Redfish implementation.", + "description": "The AccountService schema defines an Account Service. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. The schema also contains links to the manager accounts and roles.", + "longDescription": "This Resource shall represent an Account Service for a Redfish implementation. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout.", "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", @@ -44,28 +44,35 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AccountLockoutCounterResetAfter": { - "description": "The interval of time in seconds between the last failed login attempt and reset of the lockout threshold counter. This value must be less than or equal to AccountLockoutDuration. Reset sets the counter to zero.", - "longDescription": "This property shall reference the threshold of time in seconds from the last failed login attempt at which point the AccountLockoutThreshold counter (that counts number of failed login attempts) is reset back to zero (at which point AccountLockoutThreshold failures would be required before the account is locked). This value shall be less than or equal to AccountLockoutDuration. The threshold counter also resets to zero after each successful login.", + "description": "The period of time, in seconds, between the last failed login attempt and the reset of the lockout threshold counter. This value must be less than or equal to the AccountLockoutDuration value. A reset sets the counter to `0`.", + "longDescription": "This property shall contain the period of time, in seconds, from the last failed login attempt when the AccountLockoutThreshold counter, which counts the number of failed login attempts, is reset to `0`. Then, AccountLockoutThreshold failures are required before the account is locked. This value shall be less than or equal to the AccountLockoutDuration value. The threshold counter also resets to `0` after each successful login. If the AccountLockoutCounterResetEnabled value is `false`, this property shall be ignored.", "minimum": 0, "readonly": false, "type": "integer", "units": "s" }, + "AccountLockoutCounterResetEnabled": { + "description": "An indication of whether the threshold counter is reset after AccountLockoutCounterResetAfter expires. If `true`, it is reset. If `false`, only a successful login resets the threshold counter and if the user reaches the AccountLockoutThreshold limit, the account will be locked out indefinitely and only an administrator-issued reset clears the threshold counter. If this property is absent, the default is `true`.", + "longDescription": "This property shall indicate whether the threshold counter is reset after the AccountLockoutCounterResetAfter expires. If `true`, it is reset. If `false`, only a successful login resets the threshold counter and if the user reaches the AccountLockoutThreshold limit, the account shall be locked out indefinitely and only an administrator-issued reset clears the threshold counter. If this property is absent, the default is `true`.", + "readonly": false, + "type": "boolean", + "versionAdded": "v1_5_0" + }, "AccountLockoutDuration": { - "description": "The time in seconds an account is locked out. The value must be greater than or equal to the value of the AccountLockoutCounterResetAfter property. If set to 0, no lockout occurs.", - "longDescription": "This property shall reference the period of time in seconds that an account is locked after the number of failed login attempts reaches the threshold referenced by AccountLockoutThreshold, within the window of time referenced by AccountLockoutCounterResetAfter. The value shall be greater than or equal to the value of AccountLockoutResetAfter. If set to 0, no lockout shall occur.", + "description": "The period of time, in seconds, that an account is locked after the number of failed login attempts reaches the account lockout threshold, within the period between the last failed login attempt and the reset of the lockout threshold counter. If this value is `0`, no lockout will occur. If the AccountLockoutCounterResetEnabled value is `false`, this property is ignored.", + "longDescription": "This property shall contain the period of time, in seconds, that an account is locked after the number of failed login attempts reaches the AccountLockoutThreshold value, within the AccountLockoutCounterResetAfter window of time. The value shall be greater than or equal to the AccountLockoutResetAfter value. If this value is `0`, no lockout shall occur. If AccountLockoutCounterResetEnabled value is `false`, this property shall be ignored.", "minimum": 0, "readonly": false, "type": [ @@ -75,8 +82,8 @@ "units": "s" }, "AccountLockoutThreshold": { - "description": "The number of failed login attempts allowed before a user account is locked for a specified duration. A value of 0 means it is never locked.", - "longDescription": "This property shall reference the threshold of failed login attempts at which point the user's account is locked. If set to 0, no lockout shall ever occur.", + "description": "The number of allowed failed login attempts before a user account is locked for a specified duration. If `0`, the account is never locked.", + "longDescription": "This property shall contain the threshold of failed login attempts before a user account is locked. If `0`, the account shall never be locked.", "minimum": 0, "readonly": false, "type": [ @@ -86,32 +93,32 @@ }, "Accounts": { "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerAccountCollection.json#/definitions/ManagerAccountCollection", - "description": "A link to a collection of Manager Accounts.", - "longDescription": "This property shall contain the link to a collection of type ManagerAccountCollection.", + "description": "The collection of manager accounts.", + "longDescription": "This property shall contain a link to a Resource Collection of type ManagerAccountCollection.", "readonly": true }, "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_2_0" }, "ActiveDirectory": { "$ref": "#/definitions/ExternalAccountProvider", - "description": "The first ActiveDirectory external account provider this AccountService supports.", - "longDescription": "This property shall contain the first ActiveDirectory external account provider this AccountService supports. If the AccountService supports 1 or more ActiveDirectory services as an external account provider this entity must be populated by default. This entity shall not be present in the AdditionalExternalAccountProviders collection.", + "description": "The first Active Directory external account provider that this Account Service supports.", + "longDescription": "This property shall contain the first Active Directory external account provider that this Account Service supports. If the Account Service supports one or more Active Directory services as an external account provider, this entity shall be populated by default. This entity shall not be present in the AdditionalExternalAccountProviders Resource Collection.", "versionAdded": "v1_3_0" }, "AdditionalExternalAccountProviders": { "$ref": "http://redfish.dmtf.org/schemas/v1/ExternalAccountProviderCollection.json#/definitions/ExternalAccountProviderCollection", - "description": "The additional external account providers this AccountService is using.", - "longDescription": "This property shall contain an additional external account providers this AccountService is using.", + "description": "The additional external account providers that this Account Service uses.", + "longDescription": "This property shall contain the additional external account providers that this Account Service uses.", "readonly": true, "versionAdded": "v1_3_0" }, "AuthFailureLoggingThreshold": { - "description": "The number of authorization failures allowed before the failure attempt is logged to the manager log.", - "longDescription": "This property shall reference the threshold for when an authorization failure is logged. This represents a modulo function value, thus the failure shall be logged every nth occurrence where n represents the value of this property.", + "description": "The number of authorization failures that are allowed before the failed attempt is logged to the manager log.", + "longDescription": "This property shall contain the threshold for when an authorization failure is logged. This value represents a modulo function. The failure shall be logged every `n`th occurrence, where `n` represents this property.", "minimum": 0, "readonly": false, "type": "integer" @@ -133,27 +140,27 @@ }, "LDAP": { "$ref": "#/definitions/ExternalAccountProvider", - "description": "The first LDAP external account provider this AccountService supports.", - "longDescription": "This property shall contain the first LDAP external account provider this AccountService supports. If the AccountService supports 1 or more LDAP services as an external account provider this entity must be populated by default. This entity shall not be present in the AdditionalExternalAccountProviders collection.", + "description": "The first LDAP external account provider that this Account Service supports.", + "longDescription": "This property shall contain the first LDAP external account provider that this Account Service supports. If the Account Service supports one or more LDAP services as an external account provider, this entity shall be populated by default. This entity shall not be present in the AdditionalExternalAccountProviders Resource Collection.", "versionAdded": "v1_3_0" }, "LocalAccountAuth": { "$ref": "#/definitions/LocalAccountAuth", - "description": "Controls when this service will use the accounts defined withing this AccountService as part of authentication.", - "longDescription": "This property shall govern how the service uses the Accounts collection within this AccountService as part of authentication. Details about each of the modes are found in the description of the enum values.", + "description": "An indication of how the Service uses the accounts collection within this Account Service as part of authentication. The enumerated values describe the details for each mode.", + "longDescription": "This property shall govern how the Service uses the Accounts Resource Collection within this Account Service as part of authentication. The enumerated values describe the details for each mode.", "readonly": false, "versionAdded": "v1_3_0" }, "MaxPasswordLength": { - "description": "The maximum password length for this service.", - "longDescription": "This property shall reference the maximum password length that the implementation will allow a password to be set to.", + "description": "The maximum password length for this Account Service.", + "longDescription": "This property shall contain the maximum password length that the implementation allows for this Account Service.", "minimum": 0, "readonly": true, "type": "integer" }, "MinPasswordLength": { - "description": "The minimum password length for this service.", - "longDescription": "This property shall reference the minimum password length that the implementation will allow a password to be set to.", + "description": "The minimum password length for this Account Service.", + "longDescription": "This property shall contain the minimum password length that the implementation allows for this Account Service.", "minimum": 0, "readonly": true, "type": "integer" @@ -164,25 +171,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." }, "PrivilegeMap": { "$ref": "http://redfish.dmtf.org/schemas/v1/PrivilegeRegistry.json#/definitions/PrivilegeRegistry", - "description": "A reference to the Privilege mapping that defines the privileges needed to perform a requested operation on a URI associated with this service.", - "longDescription": "The value of this property shall be a link to a resource of type PrivilegeMappoing that defines the privileges a user context needs in order to perform a requested operation on a URI associated with this service.", + "description": "The link to the mapping of the privileges required to complete a requested operation on a URI associated with this Service.", + "longDescription": "This property shall contain a link to a Resource of type PrivilegeMapping that contains the privileges that are required for a user context to complete a requested operation on a URI associated with this Service.", "readonly": true, "versionAdded": "v1_1_0" }, "Roles": { "$ref": "http://redfish.dmtf.org/schemas/v1/RoleCollection.json#/definitions/RoleCollection", - "description": "A link to a collection of Roles.", - "longDescription": "This property shall contain the link to a collection of type RoleCollection.", + "description": "The collection of Redfish Roles.", + "longDescription": "This property shall contain a link to a Resource Collection of type RoleCollection.", "readonly": true }, "ServiceEnabled": { - "description": "Indicates whether this service is enabled. If set to false, the AccountService is disabled. This means no users can be created, deleted or modified. Any service attempting to access the AccountService resource (for example, the Session Service) will fail. New sessions cannot be started when the service is disabled. However, established sessions may still continue operating. This does not affect Basic AUTH connections.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled. If this is set to false, the AccountService is disabled. This means no users can be created, deleted or modified. Any service attempting to access the Account Service, like the Session Service, will fail accessing. Thus new sessions cannot be started with the service disabled (though established sessions may still continue operating). Note: this does not affect Basic AUTH connections.", + "description": "An indication of whether the Account Service is enabled. If `true`, it is enabled. If `false`, it is disabled and users cannot be created, deleted, or modified, and new sessions cannot be started. However, established sessions may still continue to run. Any service, such as the Session Service, that attempts to access the disabled Account Service fails. However, this does not affect HTTP Basic Authentication connections.", + "longDescription": "This property shall indicate whether the Account Service is enabled. If `true`, it is enabled. If `false`, it is disabled and users cannot be created, deleted, or modified, and new sessions cannot be started. However, established sessions may still continue to run. Any service, such as the Session Service, that attempts to access the disabled Account Service fails. However, this does not affect HTTP Basic Authentication connections.", "readonly": false, "type": [ "boolean", @@ -191,8 +198,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -205,10 +212,10 @@ }, "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", @@ -224,8 +231,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_2_0" } }, @@ -233,10 +240,10 @@ }, "Authentication": { "additionalProperties": false, - "description": "Contains the authentication information for the external service.", - "longDescription": "This type shall contain all the required information to authenticate to the external service.", + "description": "The information required to authenticate to the external service.", + "longDescription": "This type shall contain the information required to authenticate to the external service.", "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", @@ -259,14 +266,14 @@ "type": "null" } ], - "description": "This property contains the type of authentication used to connect to the external account provider.", - "longDescription": "The value of this property shall be the type of authentication used to connect to the external account provider.", + "description": "The type of authentication used to connect to the external account provider.", + "longDescription": "This property shall contain the type of authentication used to connect to the external account provider.", "readonly": false, "versionAdded": "v1_3_0" }, "KerberosKeytab": { - "description": "This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET.", - "longDescription": "The value of this property shall be a base64 encoded version of the kerberos keytab for this account service. The value shall be null for GET requests.", + "description": "The Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. This property is `null` in responses.", + "longDescription": "This property shall contain a Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. The value shall be `null` in responses.", "readonly": false, "type": [ "string", @@ -276,13 +283,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" }, "Password": { - "description": "This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET.", - "longDescription": "The value of this property shall be the password for this account service. The value shall be null for GET requests.", + "description": "The password for this Service. A PATCH or PUT request writes the password. This property is `null` in responses.", + "longDescription": "This property shall contain the password for this Service. A PATCH or PUT operation writes the password. The value shall be `null` in responses.", "readonly": false, "type": [ "string", @@ -291,8 +298,8 @@ "versionAdded": "v1_3_0" }, "Token": { - "description": "This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET.", - "longDescription": "The value of this property shall be the token for this account service. The value shall be null for GET requests.", + "description": "The token for this Service. A PATCH or PUT operation writes the token. This property is `null` in responses.", + "longDescription": "This property shall contain the token for this Service. A PATCH or PUT operation writes the token. The value shall be `null` in responses.", "readonly": false, "type": [ "string", @@ -301,8 +308,8 @@ "versionAdded": "v1_3_0" }, "Username": { - "description": "This property contains the user name for the account service.", - "longDescription": "The value of this property shall be the user name for this account service.", + "description": "The user name for the Service.", + "longDescription": "This property shall contain the user name for this Service.", "readonly": false, "type": "string", "versionAdded": "v1_3_0" @@ -318,19 +325,19 @@ "OEM" ], "enumDescriptions": { - "KerberosKeytab": "A kerberos keytab.", - "OEM": "An OEM specific authentication mechanism.", + "KerberosKeytab": "A Kerberos keytab.", + "OEM": "An OEM-specific authentication mechanism.", "Token": "An opaque authentication token.", - "UsernameAndPassword": "Username and password combination." + "UsernameAndPassword": "A user name and password combination." }, "type": "string" }, "ExternalAccountProvider": { "additionalProperties": false, - "description": "A remote service that can provide accounts for this manager to utilize for authentication.", - "longDescription": "This type shall be used to represent resources that represent external user account services for this manager.", + "description": "The external account provider services that can provide accounts for this manager to use for authentication.", + "longDescription": "This type shall contain properties that represent external account provider services that can provide accounts for this manager to use for authentication.", "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", @@ -353,46 +360,34 @@ "type": "null" } ], - "description": "This property contains the type of external account provider this resource references.", - "longDescription": "The value of this property shall be the type of external account provider referenced by this resource.", + "deprecated": "This property is deprecated because the account provider type is known when used in the LDAP and ActiveDirectory objects.", + "description": "The type of external account provider to which this Service connects.", + "longDescription": "This property shall contain the type of external account provider to which this Service connects.", "readonly": true, - "versionAdded": "v1_3_0" + "versionAdded": "v1_3_0", + "versionDeprecated": "v1_5_0" }, "Authentication": { - "anyOf": [ - { - "$ref": "#/definitions/Authentication" - }, - { - "type": "null" - } - ], - "description": "This property contains the authentication information for the external account provider.", - "longDescription": "The value of this property shall contain the authentication information for the external account provider.", + "$ref": "#/definitions/Authentication", + "description": "The authentication information for the external account provider.", + "longDescription": "This property shall contain the authentication information for the external account provider.", "versionAdded": "v1_3_0" }, "Certificates": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "This is a reference to a collection of certificates used for the external account provider.", - "longDescription": "The value of this property shall be a link to a collection of type CertificateCollection.", + "description": "The link to a collection of certificates that the external account provider uses.", + "longDescription": "This property shall contain a link to a Resource Collection of certificates of the CertificateCollection type that the external account provider uses.", "readonly": true, "versionAdded": "v1_4_0" }, "LDAPService": { - "anyOf": [ - { - "$ref": "#/definitions/LDAPService" - }, - { - "type": "null" - } - ], - "description": "This property contains additional mapping information needed to parse a generic LDAP service.", - "longDescription": "The value of this property shall contain any additional mapping information needed to parse a generic LDAP service.", + "$ref": "#/definitions/LDAPService", + "description": "The additional mapping information needed to parse a generic LDAP service.", + "longDescription": "This property shall contain any additional mapping information needed to parse a generic LDAP service. This property should only be present inside the LDAP property.", "versionAdded": "v1_3_0" }, "RemoteRoleMapping": { - "description": "This property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role.", + "description": "The mapping rules to convert the external account providers account information to the local Redfish Role.", "items": { "anyOf": [ { @@ -403,26 +398,26 @@ } ] }, - "longDescription": "This property shall contain a collection of the mapping rules to convert the external account providers account information to the local Redfish Role.", + "longDescription": "This property shall contain a set of the mapping rules that are used to convert the external account providers account information to the local Redfish Role.", "type": "array", "versionAdded": "v1_3_0" }, "ServiceAddresses": { - "description": "This property contains the addresses of the user account providers this resource references. The format of this field depends on the Type.", + "description": "The addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be the addresses of the account providers this resource references. The format of this field depends on the Type of the ExternalAccountProvider. Each item in the array shall contain a single address. Services may define their own behavior for managing multiple addresses.", + "longDescription": "This property shall contain the addresses of the account providers to which this external account provider links. The format of this field depends on the type of external account provider. Each item in the array shall contain a single address. Services may define their own behavior for managing multiple addresses.", "readonly": false, "type": "array", "versionAdded": "v1_3_0" }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -435,10 +430,10 @@ }, "LDAPSearchSettings": { "additionalProperties": false, - "description": "Contains settings for searching a generic LDAP service.", - "longDescription": "This type shall contain all the required settings for searching a generic LDAP service.", + "description": "The settings to search a generic LDAP service.", + "longDescription": "This type shall contain all required settings to search a generic LDAP service.", "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", @@ -453,21 +448,21 @@ }, "properties": { "BaseDistinguishedNames": { - "description": "The base distinguished names to use when searching the LDAP service.", + "description": "The base distinguished names to use to search an external LDAP service.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be a collection of base distinguished names to use when searching the LDAP service.", + "longDescription": "This property shall contain an array of base distinguished names to use to search an external LDAP service.", "readonly": false, "type": "array", "versionAdded": "v1_3_0" }, "GroupNameAttribute": { - "description": "The attribute name that contains the name of the Group.", - "longDescription": "The value of this property shall be the attribute name that contains the name of the Group.", + "description": "The attribute name that contains the LDAP group name entry.", + "longDescription": "This property shall contain the attribute name that contains the LDAP group name.", "readonly": false, "type": [ "string", @@ -476,8 +471,8 @@ "versionAdded": "v1_3_0" }, "GroupsAttribute": { - "description": "The attribute name that contains the Groups for a user.", - "longDescription": "The value of this property shall be the attribute name that contains the Groups for a user.", + "description": "The attribute name that contains the groups for a user on the LDAP user entry.", + "longDescription": "This property shall contain the attribute name that contains the groups for an LDAP user entry.", "readonly": false, "type": [ "string", @@ -486,8 +481,8 @@ "versionAdded": "v1_3_0" }, "UsernameAttribute": { - "description": "The attribute name that contains the Username.", - "longDescription": "The value of this property shall be the attribute name that contains the Username.", + "description": "The attribute name that contains the LDAP user name entry.", + "longDescription": "This property shall contain the attribute name that contains the LDAP user name.", "readonly": false, "type": [ "string", @@ -500,10 +495,10 @@ }, "LDAPService": { "additionalProperties": false, - "description": "Contains settings for parsing a generic LDAP service.", - "longDescription": "This type shall contain all the required settings for parsing a generic LDAP service.", + "description": "The settings required to parse a generic LDAP service.", + "longDescription": "This type shall contain all required settings to parse a generic LDAP service.", "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", @@ -519,21 +514,14 @@ "properties": { "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" }, "SearchSettings": { - "anyOf": [ - { - "$ref": "#/definitions/LDAPSearchSettings" - }, - { - "type": "null" - } - ], - "description": "This property contains the settings needed to search an external LDAP service.", - "longDescription": "The value of this property shall contain the settings needed to search an external LDAP service.", + "$ref": "#/definitions/LDAPSearchSettings", + "description": "The required settings to search an external LDAP service.", + "longDescription": "This property shall contain the required settings to search an external LDAP service.", "versionAdded": "v1_3_0" } }, @@ -543,26 +531,32 @@ "enum": [ "Enabled", "Disabled", - "Fallback" + "Fallback", + "LocalFirst" ], "enumDescriptions": { - "Disabled": "Authentication via accounts defined in this AccountService is disabled.", - "Enabled": "Authentication via accounts defined in this AccountService is enabled.", - "Fallback": "Authentication via accounts defined in this AccountService is only used if there are external account providers that are currently unreachable." + "Disabled": "The service never authenticates users based on the Account Service-defined accounts collection.", + "Enabled": "The service authenticates users based on the Account Service-defined accounts collection.", + "Fallback": "The service authenticates users based on the Account Service-defined accounts collection only if any external account providers are currently unreachable.", + "LocalFirst": "The service first authenticates users based on the Account Service-defined accounts collection. If authentication fails, the Service authenticates by using external account providers." }, "enumLongDescriptions": { - "Disabled": "This value shall be used to indicate that the service will never authenticate users based on the Accounts collection within this AccountService.", - "Enabled": "This value shall be used to indicate that the service will authenticate users based on the Accounts collection within this AccountService.", - "Fallback": "This value shall be used to indicate that the service will authenticate users based on the Accounts collection within this AccountService only if there are external account providers that are currently unreachable." + "Disabled": "The service shall never authenticate users based on the Account Service-defined Accounts Resource Collection.", + "Enabled": "The service shall authenticate users based on the Account Service-defined Accounts Resource Collection.", + "Fallback": "The service shall authenticate users based on the Account Service-defined Accounts Resource Collection only if any external account providers are currently unreachable.", + "LocalFirst": "The service shall first authenticate users based on the Account Service-defined Accounts Resource Collection. If authentication fails, the Service shall authenticate by using external account providers." + }, + "enumVersionAdded": { + "LocalFirst": "v1_6_0" }, "type": "string" }, "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", @@ -580,10 +574,10 @@ }, "RoleMapping": { "additionalProperties": false, - "description": "Contains mapping rules to convert the external account providers account information to the local Redfish Role.", - "longDescription": "This type shall contain mapping rules to convert the external account providers account information to the local Redfish Role.", + "description": "The mapping rules that are used to convert the external account providers account information to the local Redfish Role.", + "longDescription": "This type shall contain mapping rules that are used to convert the external account providers account information to the local Redfish Role.", "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", @@ -598,8 +592,8 @@ }, "properties": { "LocalRole": { - "description": "The name of the local role in which to map the remote user or group.", - "longDescription": "The value of this property shall contain the value of the RoleId property within a Role resource on this Redfish service in which to map the remote user or group.", + "description": "The name of the local Redfish Role to which to map the remote user or group.", + "longDescription": "This property shall contain the RoleId property value within a Role Resource on this Redfish Service to which to map the remote user or group.", "readonly": false, "type": [ "string", @@ -609,13 +603,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" }, "RemoteGroup": { - "description": "This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.", - "longDescription": "The value of this property shall contain the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.", + "description": "The name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.", + "longDescription": "This property shall contain the name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.", "readonly": false, "type": [ "string", @@ -624,8 +618,8 @@ "versionAdded": "v1_3_0" }, "RemoteUser": { - "description": "This property is the name of the remote user that will be mapped to the local role referenced by this entity.", - "longDescription": "The value of this property shall contain the name of the remote user that will be mapped to the local role referenced by this entity.", + "description": "The name of the remote user that maps to the local Redfish Role to which this entity links.", + "longDescription": "This property shall contain the name of the remote user that maps to the local Redfish Role to which this entity links.", "readonly": false, "type": [ "string", @@ -638,6 +632,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#AccountService.v1_4_0.AccountService" + "release": "2019.2", + "title": "#AccountService.v1_6_0.AccountService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json b/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json index 76ebef944d..73ffca2856 100644 --- a/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json +++ b/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/ActionInfo.v1_1_2.json", "$ref": "#/definitions/ActionInfo", "$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": { "ActionInfo": { "additionalProperties": false, - "description": "The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters.", - "longDescription": "This resource shall be used to represent information about the supported parameters for an Action within a Redfish implementation.", + "description": "The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.", + "longDescription": "This Resource shall represent the supported parameters and other information for a Redfish action on a target within a Redfish implementation. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.", "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", @@ -23,16 +24,16 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "Description": { "anyOf": [ @@ -55,15 +56,15 @@ }, "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." }, "Parameters": { - "description": "The parameters associated with the specified Redfish Action.", + "description": "The list of parameters included in the specified Redfish action.", "items": { "$ref": "#/definitions/Parameters" }, - "longDescription": "This property shall contain a list of parameters associated with a Redfish Action associated with this resource.", + "longDescription": "This property shall list the parameters included in the specified Redfish action for this Resource.", "type": "array" } }, @@ -86,7 +87,7 @@ "ObjectArray" ], "enumDescriptions": { - "Boolean": "A boolean (true or false).", + "Boolean": "A boolean.", "Number": "A number.", "NumberArray": "An array of numbers.", "Object": "An embedded JSON object.", @@ -98,10 +99,10 @@ }, "Parameters": { "additionalProperties": false, - "description": "A parameter associated with the specified Redfish Action.", - "longDescription": "This property shall contain information about a specific parameter associated with a Redfish Action associated with this resource.", + "description": "The information about a parameter included in a Redfish action for this Resource.", + "longDescription": "This property shall contain information about a parameter included in a Redfish Action 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", @@ -116,14 +117,14 @@ }, "properties": { "AllowableValues": { - "description": "A list of values for this parameter supported by this Action target.", + "description": "The allowable values for this parameter as applied to this action target.", "items": { "type": [ "string", "null" ] }, - "longDescription": "This property shall indicate the allowable values for this parameter as applied to this Action target.", + "longDescription": "This property shall indicate the allowable values for this parameter as applied to this action target.", "readonly": true, "type": "array" }, @@ -136,37 +137,39 @@ "type": "null" } ], - "description": "The JSON property type used for this parameter.", - "longDescription": "This property shall indicate the JSON property type of the parameter.", + "description": "The JSON property type for this parameter.", + "longDescription": "This property shall contain the JSON property type for this parameter.", "readonly": true }, "MaximumValue": { - "description": "The maximum supported value of this parameter.", - "longDescription": "This property shall indicate the maximum value of an integer or number type parameter supported by this service. This property shall not be present for parameters that are of types other than integer or number.", + "description": "The maximum supported value for this parameter.", + "longDescription": "This integer or number property shall contain the maximum value that this service supports. This property shall not be present for non-integer or number parameters.", "readonly": true, "type": [ "number", "null" - ] + ], + "versionAdded": "v1_1_0" }, "MinimumValue": { "description": "The minimum supported value for this parameter.", - "longDescription": "This property shall indicate the minimum value of an integer or number type parameter supported by this service. This property shall not be present for parameters that are of types other than integer or number.", + "longDescription": "This integer or number property shall contain the minimum value that this service supports. This property shall not be present for parameters that are of types other than integer or number.", "readonly": true, "type": [ "number", "null" - ] + ], + "versionAdded": "v1_1_0" }, "Name": { - "description": "The name of the parameter for this Action.", - "longDescription": "This property shall contain the name of the parameter used by the associated Redfish Action.", + "description": "The name of the parameter for this action.", + "longDescription": "This property shall contain the name of the parameter included in a Redfish action.", "readonly": true, "type": "string" }, "ObjectDataType": { - "description": "The OData Type of an object-based parameter.", - "longDescription": "This property shall describe the entity type definition (in @odata.type format) for the parameter. This property shall be required for parameters with a DataType of Object or ObjectArray, and shall not be present for parameters with other DataType(s).", + "description": "The data type of an object-based parameter.", + "longDescription": "This property shall describe the entity type definition in `@odata.type` format for the parameter. This property shall be required for parameters with a data type of `Object` or `ObjectArray`, and shall not be present for parameters with other data types.", "readonly": true, "type": [ "string", @@ -174,8 +177,8 @@ ] }, "Required": { - "description": "Indicates whether the parameter is required to perform this Action.", - "longDescription": "This property shall return true if the parameter is required to be present to perform the associated Action, and shall be false if the parameter is not required (optional) to perform the associated Action.", + "description": "An indication of whether the parameter is required to complete this action.", + "longDescription": "This property shall indicate whether the parameter is required to complete this action.", "readonly": true, "type": "boolean" } @@ -187,5 +190,6 @@ } }, "owningEntity": "DMTF", - "title": "#ActionInfo.v1_1_0.ActionInfo" + "release": "2018.2", + "title": "#ActionInfo.v1_1_2.ActionInfo" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Assembly/Assembly.json b/static/redfish/v1/JsonSchemas/Assembly/Assembly.json index c575ab5c53..3fbcc1b61d 100644 --- a/static/redfish/v1/JsonSchemas/Assembly/Assembly.json +++ b/static/redfish/v1/JsonSchemas/Assembly/Assembly.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Assembly.v1_2_2.json", "$ref": "#/definitions/Assembly", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "Assembly": { "additionalProperties": false, - "description": "This is the schema definition for the Assembly properties.", - "longDescription": "This resource shall be used to represent an assembly information resource for a Redfish implementation.", + "description": "The Assembly schema defines an assembly. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.", + "longDescription": "This Resource shall represent an assembly for a Redfish implementation. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.", "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,34 +51,34 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Assemblies": { "autoExpand": true, - "description": "This is the definition for an assembly information record.", + "description": "The assembly records.", "items": { "$ref": "#/definitions/AssemblyData" }, - "longDescription": "These properties shall be the definition for assembly records for a Redfish implementation.", + "longDescription": "These properties shall define assembly records for a Redfish implementation.", "readonly": false, "type": "array" }, "Assemblies@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Description": { "anyOf": [ @@ -100,8 +101,8 @@ }, "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." } }, "required": [ @@ -115,7 +116,7 @@ "AssemblyData": { "additionalProperties": false, "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", @@ -130,17 +131,17 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/AssemblyDataActions", - "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." }, "BinaryDataURI": { - "description": "URI that provides the ability to access an image of the assembly information.", - "format": "uri", - "longDescription": "The value of this property shall be a URI at which the Service provides for the download of the OEM-specific binary image of the assembly data. An HTTP GET from this URI shall return a response payload of MIME time application/octet-stream. An HTTP PUT to this URI, if supported by the Service, shall replace the binary image of the assembly.", + "description": "The URI at which to access an image of the assembly information.", + "format": "uri-reference", + "longDescription": "This property shall contain the URI at which to access an image of the assembly information, using the Redfish protocol and authentication methods. The Service provides this URI for the download of the OEM-specific binary image of the assembly data. An HTTP GET from this URI shall return a response payload of MIME time `application/octet-stream`. If the service supports it, an HTTP PUT to this URI shall replace the binary image of the assembly.", "readonly": true, "type": [ "string", @@ -148,8 +149,8 @@ ] }, "Description": { - "description": "Description of the Assembly.", - "longDescription": "The value of this property shall be a description of this assembly.", + "description": "The description of the assembly.", + "longDescription": "This property shall contain the description of the assembly.", "readonly": true, "type": [ "string", @@ -157,8 +158,8 @@ ] }, "EngineeringChangeLevel": { - "description": "Engineering change level of the Assembly.", - "longDescription": "The value of this property shall be the Engineering Change Level (ECL) or revision of the assembly.", + "description": "The engineering change level of the assembly.", + "longDescription": "This property shall contain the engineering change level or revision of the assembly.", "readonly": true, "type": [ "string", @@ -166,14 +167,14 @@ ] }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "Model": { - "description": "Model number of the Assembly.", - "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the assembly.", + "description": "The model number of the assembly.", + "longDescription": "This property shall contain the name by which the manufacturer generally refers to the assembly.", "readonly": true, "type": [ "string", @@ -181,8 +182,8 @@ ] }, "Name": { - "description": "Name of the Assembly.", - "longDescription": "The value of this property shall be the name of the assembly.", + "description": "The name of the assembly.", + "longDescription": "This property shall contain the name of the assembly.", "readonly": true, "type": [ "string", @@ -191,12 +192,12 @@ }, "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." }, "PartNumber": { - "description": "Part number of the Assembly.", - "longDescription": "The value of this property shall be the name of the assembly.", + "description": "The part number of the assembly.", + "longDescription": "This property shall contain the part number of the assembly.", "readonly": true, "type": [ "string", @@ -205,13 +206,14 @@ }, "PhysicalContext": { "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext", - "description": "Describes the area or device to which this assembly data applies.", - "longDescription": "The value of this property shall be a description of the physical context for this assembly data.", - "readonly": true + "description": "The area or device to which the assembly data applies.", + "longDescription": "This property shall contain a description of the physical context for the assembly data.", + "readonly": true, + "versionAdded": "v1_2_0" }, "Producer": { - "description": "Producer or manufacturer of the Assembly.", - "longDescription": "The value of this property shall be the name of the company which supplied or manufactured this assembly. This value shall be equal to the 'Manufacturer' field in a PLDM FRU structure, if applicable, for this assembly.", + "description": "The producer or manufacturer of the assembly.", + "longDescription": "This property shall contain the name of the company that produced or manufactured the assembly. This value shall be equal to the 'Manufacturer' field value in a PLDM FRU structure, if applicable, for the assembly.", "readonly": true, "type": [ "string", @@ -219,9 +221,9 @@ ] }, "ProductionDate": { - "description": "Production date of the Assembly.", + "description": "The production date of the assembly.", "format": "date-time", - "longDescription": "The value of this property shall be the date of production or manufacture for this assembly. The time of day portion of the property shall be '00:00:00Z' if the time of day is unknown.", + "longDescription": "This property shall contain the date of production or manufacture for the assembly. The time of day portion of the property shall be `00:00:00Z`, if the time of day is unknown.", "readonly": true, "type": [ "string", @@ -229,8 +231,8 @@ ] }, "SKU": { - "description": "SKU of the Assembly.", - "longDescription": "The value of this property shall be the name of the assembly.", + "description": "The SKU of the assembly.", + "longDescription": "This property shall contain the SKU of the assembly.", "readonly": true, "type": [ "string", @@ -238,17 +240,18 @@ ] }, "SerialNumber": { - "description": "The serial number of this assembly.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the assembly.", + "description": "The serial number of the assembly.", + "longDescription": "This property shall contain a manufacturer-allocated number that identifies the assembly.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionAdded": "v1_2_0" }, "SparePartNumber": { - "description": "Spare part number of the Assembly.", - "longDescription": "The value of this property shall be the name of the assembly.", + "description": "The spare part number of the assembly.", + "longDescription": "This property shall contain the spare part number of the assembly.", "readonly": true, "type": [ "string", @@ -257,12 +260,13 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource.", + "versionAdded": "v1_1_0" }, "Vendor": { - "description": "Vendor of the Assembly.", - "longDescription": "The value of this property shall be the name of the company which provides the final product that includes this assembly. This value shall be equal to the 'Vendor' field in a PLDM FRU structure, if applicable, for this assembly.", + "description": "The vendor of the assembly.", + "longDescription": "This property shall contain the name of the company that provides the final product that includes this assembly. This value shall be equal to the 'Vendor' field value in a PLDM FRU structure, if applicable, for the assembly.", "readonly": true, "type": [ "string", @@ -270,8 +274,8 @@ ] }, "Version": { - "description": "Version of the Assembly.", - "longDescription": "The value of this property shall be the version of the assembly as determined by the vendor or supplier.", + "description": "The version of the assembly.", + "longDescription": "This property shall contain the version of the assembly as determined by the vendor or supplier.", "readonly": true, "type": [ "string", @@ -287,10 +291,10 @@ }, "AssemblyDataActions": { "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", @@ -306,18 +310,18 @@ "properties": { "Oem": { "$ref": "#/definitions/AssemblyDataOemActions", - "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." } }, "type": "object" }, "AssemblyDataOemActions": { "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", @@ -335,10 +339,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", @@ -356,5 +360,6 @@ } }, "owningEntity": "DMTF", - "title": "#Assembly.v1_2_0.Assembly" + "release": "2018.2", + "title": "#Assembly.v1_2_2.Assembly" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/AttributeRegistry/AttributeRegistry.json b/static/redfish/v1/JsonSchemas/AttributeRegistry/AttributeRegistry.json index 09cd4e8276..2bb4553a45 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 diff --git a/static/redfish/v1/JsonSchemas/Bios/Bios.json b/static/redfish/v1/JsonSchemas/Bios/Bios.json index 8133cdcb3c..3a06bb8890 100644 --- a/static/redfish/v1/JsonSchemas/Bios/Bios.json +++ b/static/redfish/v1/JsonSchemas/Bios/Bios.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Bios.v1_0_5.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Bios.v1_1_0.json", "$ref": "#/definitions/Bios", "$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", @@ -31,18 +31,18 @@ }, "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." } }, "type": "object" }, "Attributes": { "additionalProperties": false, - "description": "The manufacturer/provider-specific list of BIOS attributes and their values.", - "longDescription": "BIOS Attribute settings shall be described as additional properties in this object. If a BIOS AttributeRegistry is specified, Attributes shall be looked up in that registry by their AttributeName. Attributes in the registry with AttributeType of Enumeration shall use valid ValueName as values in this object, as listed in that registry.", + "description": "The list of BIOS attributes and their values as determined by the manufacturer or provider.", + "longDescription": "This property shall contain the list of BIOS attributes and their values as determined by the manufacturer or provider. This object shall describe BIOS attribute settings as additional properties. If the object specifies a BIOS Attribute Registry, attributes shall be looked up in that Attribute Registry by their attribute name. Attributes in this Attribute Registry with the AttributeType of Enumeration shall use valid ValueName values in this object, as listed in that 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", @@ -68,10 +68,10 @@ }, "Bios": { "additionalProperties": true, - "description": "The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and Actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client will find the @Redfish.Settings term in this resource, and if it is found, the client makes requests to change BIOS settings by modifying the resource identified by the @Redfish.Settings term.", - "longDescription": "This resource shall be used to represent BIOS attributes for a Redfish implementation.", + "description": "The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client finds the `@Redfish.Settings` term in this Resource, and if it is found, the client makes requests to change BIOS settings by modifying the Resource identified by the `@Redfish.Settings` term.", + "longDescription": "This Resource shall represent BIOS attributes 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", @@ -86,25 +86,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AttributeRegistry": { - "description": "The Resource ID of the Attribute Registry that has the system-specific information about a BIOS resource.", - "longDescription": "The reference to the Attribute Registry that lists the metadata describing the BIOS attribute settings in this resource.", + "description": "The Resource ID of the Attribute Registry that has the system-specific information about a BIOS Resource.", + "longDescription": "The link to the Attribute Registry that lists the metadata describing the BIOS attribute settings in this Resource.", "readonly": true, "type": [ "string", @@ -114,7 +114,7 @@ "Attributes": { "$ref": "#/definitions/Attributes", "description": "The list of BIOS attributes specific to the manufacturer or provider.", - "longDescription": "BIOS Attribute settings appear as additional properties in this object, and can be looked up in the Attribute Registry by their AttributeName." + "longDescription": "This property shall contain the list of BIOS attributes specific to the manufacturer or provider. BIOS Attribute settings appear as additional properties in this object, and can be looked up in the Attribute Registry by their AttributeName." }, "Description": { "anyOf": [ @@ -131,14 +131,20 @@ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, + "Links": { + "$ref": "#/definitions/Links", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource.", + "versionAdded": "v1_1_0" + }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "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." } }, "required": [ @@ -151,30 +157,30 @@ }, "ChangePassword": { "additionalProperties": false, - "description": "This action is used to change the BIOS passwords.", - "longDescription": "This action shall perform a change of the selected BIOS password.", + "description": "This action changes a BIOS password.", + "longDescription": "This action shall change the selected BIOS password.", "parameters": { "NewPassword": { - "description": "The value of the new BIOS password.", - "longDescription": "This parameter shall define the value of the new BIOS password.", + "description": "The new BIOS password.", + "longDescription": "This parameter shall contain the new BIOS password.", "requiredParameter": true, "type": "string" }, "OldPassword": { - "description": "The value of the existing password.", - "longDescription": "This parameter shall define the value of the existing BIOS password that is about to be changed.", + "description": "The existing BIOS password.", + "longDescription": "This parameter shall contain the existing BIOS password to change.", "requiredParameter": true, "type": "string" }, "PasswordName": { "description": "The name of the BIOS password to change.", - "longDescription": "This parameter shall define the BIOS password name to change. For instance, this could be the AdminPassword or UserPassword.", + "longDescription": "This parameter shall contain the name of the BIOS password to change. For instance, AdminPassword or UserPassword.", "requiredParameter": true, "type": "string" } }, "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", @@ -190,7 +196,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -200,12 +206,59 @@ }, "type": "object" }, + "Links": { + "additionalProperties": false, + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to this Resource.", + "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": { + "ActiveSoftwareImage": { + "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory", + "description": "The link to the SoftwareInventory that represents the active BIOS firmware image.", + "longDescription": "This property shall contain a link to the SoftwareInventory Resource that represents the active BIOS firmware image.", + "readonly": false, + "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." + }, + "SoftwareImages": { + "description": "The images that are associated with this BIOS.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory" + }, + "longDescription": "This property shall contain an array of links to the SoftwareInventory Resources that represent the firmware images that apply to this BIOS.", + "readonly": true, + "type": "array", + "versionAdded": "v1_1_0" + }, + "SoftwareImages@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" + } + }, + "type": "object" + }, "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", @@ -223,11 +276,11 @@ }, "ResetBios": { "additionalProperties": false, - "description": "This action is used to reset the BIOS attributes to default.", - "longDescription": "This action shall perform a reset of the BIOS attributes to their default values. A system reset may be required for the default values to be applied. This action may impact other resources.", + "description": "This action resets the BIOS attributes to default.", + "longDescription": "This action shall reset the BIOS attributes to their default values. A system reset may be required to apply the default values. This action may impact other Resources.", "parameters": {}, "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", @@ -243,7 +296,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -255,6 +308,6 @@ } }, "owningEntity": "DMTF", - "release": "2016.1", - "title": "#Bios.v1_0_5.Bios" + "release": "2019.2", + "title": "#Bios.v1_1_0.Bios" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/BootOption/BootOption.json b/static/redfish/v1/JsonSchemas/BootOption/BootOption.json index 7b6ac9a1a6..f72a95ed91 100644 --- a/static/redfish/v1/JsonSchemas/BootOption/BootOption.json +++ b/static/redfish/v1/JsonSchemas/BootOption/BootOption.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/BootOption.v1_0_3.json", "$ref": "#/definitions/BootOption", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "BootOption": { "additionalProperties": false, - "description": "This is the schema definition for the BootOption resource. It represents the properties of a bootable device available in the System.", - "longDescription": "This resource shall be used to represent a single boot option contained within a system.", + "description": "The BootOption schema describes a boot option. It represents the properties of a bootable device available in the system.", + "longDescription": "This Resource shall represent a single boot option within a system.", "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,21 +51,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Alias": { "anyOf": [ @@ -75,13 +76,13 @@ "type": "null" } ], - "description": "The alias of this Boot Source.", - "longDescription": "The value of this property shall contain the string alias of this Boot Source that describes the type of boot that will be performed.", + "description": "The alias of this boot source.", + "longDescription": "This property shall contain the string alias of this boot source that describes the type of boot.", "readonly": true }, "BootOptionEnabled": { - "description": "A flag that shows if the Boot Option is enabled.", - "longDescription": "The value of this property shall indicate if the Boot Option is enabled. If this property is set to false, the Boot Option referenced in the Boot Order array found on the Computer System shall be skipped. In the UEFI context, this property shall influence the Load Option Active flag for the Boot Option.", + "description": "An indication of whether the boot option is enabled. If `true`, it is enabled. If `false`, the boot option that the boot order array on the computer system contains is skipped. In the UEFI context, this property shall influence the load option active flag for the boot option.", + "longDescription": "This property shall indicate whether the boot option is enabled. If `true`, it is enabled. If `false`, the boot option that the boot order array on the computer system contains shall be skipped. In the UEFI context, this property shall influence the load option active flag for the boot option.", "readonly": false, "type": [ "boolean", @@ -89,8 +90,8 @@ ] }, "BootOptionReference": { - "description": "The unique boot option string that is referenced in the BootOrder.", - "longDescription": "The value of this property shall contain a string that corresponds to the bootable option or device. For UEFI systems, this string shall match the UEFI Boot Option variable name (e.g. Boot####). This value is referenced by the ComputerSystem BootOrder array.", + "description": "The unique boot option.", + "longDescription": "This property shall correspond to the boot option or device. For UEFI systems, this string shall match the UEFI boot option variable name, such as `Boot####`. The BootOrder array of a ComputerSystem contains this value.", "readonly": true, "type": [ "string", @@ -109,8 +110,8 @@ "readonly": true }, "DisplayName": { - "description": "The user-readable display string of the Boot Option.", - "longDescription": "The value of this property shall be a user readable string that describes this Boot Option as it should show up in the Boot Order list in user interfaces.", + "description": "The user-readable display name of the boot option that appears in the boot order list in the user interface.", + "longDescription": "This property shall contain a user-readable boot option name, as it should appear in the boot order list in the user interface.", "readonly": true, "type": [ "string", @@ -127,24 +128,24 @@ }, "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." }, "RelatedItem": { - "description": "The ID(s) of the resources associated with this Boot Option.", + "description": "An array of one or more IDs for the Resources associated with this boot option.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is being used for this Boot Option.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is being used for this Boot Option.", "readonly": true, "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "UefiDevicePath": { - "description": "The UEFI device path used to access this UEFI Boot Option.", - "longDescription": "This property shall contain the UEFI device path used to identify and locate the specific device for this UEFI Boot Option, as defined by the UEFI Specification.", + "description": "The UEFI device path to access this UEFI Boot Option.", + "longDescription": "This property shall contain the UEFI Specification-defined UEFI device path that identifies and locates the device for this boot option.", "readonly": true, "type": [ "string", @@ -163,10 +164,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", @@ -184,5 +185,6 @@ } }, "owningEntity": "DMTF", - "title": "#BootOption.v1_0_1.BootOption" + "release": "2017.3", + "title": "#BootOption.v1_0_3.BootOption" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Certificate/Certificate.json b/static/redfish/v1/JsonSchemas/Certificate/Certificate.json index a74383d7a4..8c4cac809b 100644 --- a/static/redfish/v1/JsonSchemas/Certificate/Certificate.json +++ b/static/redfish/v1/JsonSchemas/Certificate/Certificate.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Certificate.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Certificate.v1_1_1.json", "$ref": "#/definitions/Certificate", "$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", @@ -23,20 +23,26 @@ } }, "properties": { + "#Certificate.Rekey": { + "$ref": "#/definitions/Rekey" + }, + "#Certificate.Renew": { + "$ref": "#/definitions/Renew" + }, "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." } }, "type": "object" }, "Certificate": { "additionalProperties": false, - "description": "The Certificate resource describes a certificate used to prove the identify of a component, account, or service.", - "longDescription": "This resource shall be used to represent a Certificate for a Redfish implementation.", + "description": "The Certificate schema describes a certificate that proves the identify of a component, account, or service.", + "longDescription": "This Resource contains a certificate 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,25 +57,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "CertificateString": { "description": "The string for the certificate.", - "longDescription": "The value of this property shall be the string of the certificate, and the format shall follow the requirements specified by the value of the CertificateType property. If the certificate contains any private keys, they shall be removed from the string on GET requests. If the private key for the certificate is not known by the service and is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.", + "longDescription": "This property shall contain the certificate, and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.", "readonly": true, "type": [ "string", @@ -107,10 +113,10 @@ "Issuer": { "$ref": "#/definitions/Identifier", "description": "The issuer of the certificate.", - "longDescription": "The value of this property shall be an object containing information about the issuer of the certificate." + "longDescription": "This property shall contain an object containing information about the issuer of the certificate." }, "KeyUsage": { - "description": "The usage of the key contained in the certificate.", + "description": "The key usage extension, which defines the purpose of the public keys in this certificate.", "items": { "anyOf": [ { @@ -121,7 +127,7 @@ } ] }, - "longDescription": "This property shall contain the usage of the key contained in the certificate.", + "longDescription": "This property shall contain the key usage extension, which defines the purpose of the public keys in this certificate.", "readonly": true, "type": "array" }, @@ -131,25 +137,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." }, "Subject": { "$ref": "#/definitions/Identifier", "description": "The subject of the certificate.", - "longDescription": "The value of this property shall be an object containing information about the subject of the certificate." + "longDescription": "This property shall contain an object containing information about the subject of the certificate." }, "ValidNotAfter": { "description": "The date when the certificate is no longer valid.", "format": "date-time", - "longDescription": "The value of this property shall indicate the date on which the certificate validity period ends.", + "longDescription": "This property shall contain the date when the certificate validity period ends.", "readonly": true, "type": "string" }, "ValidNotBefore": { "description": "The date when the certificate becomes valid.", "format": "date-time", - "longDescription": "The value of this property shall indicate the date on which the certificate validity period begins.", + "longDescription": "This property shall contain the date when the certificate validity period begins.", "readonly": true, "type": "string" } @@ -169,9 +175,9 @@ "Identifier": { "additionalProperties": false, "description": "The identifier information about a certificate.", - "longDescription": "This type shall contain the properties used to identify the issuer or subject of a certificate.", + "longDescription": "This type shall contain the properties that identifies the issuer or subject of a certificate.", "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", @@ -199,7 +205,7 @@ }, "Country": { "description": "The country of the organization of the entity.", - "longDescription": "This property shall contain the two letter ISO code for the country of the organization of the entity.", + "longDescription": "This property shall contain the two-letter ISO code for the country of the organization of the entity.", "readonly": true, "type": "string" }, @@ -235,10 +241,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", @@ -253,9 +259,188 @@ }, "properties": {}, "type": "object" + }, + "Rekey": { + "actionResponse": { + "$ref": "#/definitions/RekeyResponse" + }, + "additionalProperties": false, + "description": "This action generates a new key-pair for a certificate and produces a certificate signing request.", + "longDescription": "This action shall use the certificate data to generate a new key-pair for a certificate. The response shall contain a signing request that a certificate authority (CA) must sign. The Service should retain the private key that generated this request for installation of the certificate. The private key should not be part of the response. The private key should not be part of the response.", + "parameters": { + "ChallengePassword": { + "description": "The challenge password to apply to the certificate for revocation requests.", + "longDescription": "This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.", + "type": "string" + }, + "KeyBitLength": { + "description": "The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.", + "longDescription": "This parameter shall contain the length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.", + "type": "integer" + }, + "KeyCurveId": { + "description": "The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.", + "longDescription": "This parameter shall contain the curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'.", + "type": "string" + }, + "KeyPairAlgorithm": { + "description": "The type of key-pair for use with signing algorithms.", + "longDescription": "This parameter shall contain the type of key-pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.", + "type": "string" + } + }, + "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": { + "target": { + "description": "Link to invoke action", + "format": "uri-reference", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object", + "versionAdded": "v1_1_0" + }, + "RekeyResponse": { + "additionalProperties": false, + "description": "The response body for the Rekey action.", + "longDescription": "This type shall contain the properties found in the response body for the Rekey action.", + "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": { + "CSRString": { + "description": "The string for the certificate signing request.", + "longDescription": "This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string.", + "readonly": true, + "type": "string", + "versionAdded": "v1_1_0" + }, + "Certificate": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate", + "description": "The link to the certificate being rekeyed.", + "longDescription": "This property shall contain the URI of the Certificate Resource that is replaced after the certificate authority (CA) signs the certificate.", + "readonly": true, + "versionAdded": "v1_1_0" + } + }, + "required": [ + "Certificate", + "CSRString" + ], + "type": "object" + }, + "Renew": { + "actionResponse": { + "$ref": "#/definitions/RenewResponse" + }, + "additionalProperties": false, + "description": "This action generates a certificate signing request by using the existing information and key-pair of the certificate.", + "longDescription": "This action shall generate a certificate signing request using the existing information and key-pair of the certificate. The response shall contain a signing request that a certificate authority (CA) must sign. The Service should retain the private key that this request generates for when the certificate is installed. The private key should not be part of the response.", + "parameters": { + "ChallengePassword": { + "description": "The challenge password to apply to the certificate for revocation requests.", + "longDescription": "This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.", + "type": "string" + } + }, + "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": { + "target": { + "description": "Link to invoke action", + "format": "uri-reference", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object", + "versionAdded": "v1_1_0" + }, + "RenewResponse": { + "additionalProperties": false, + "description": "The response body for the Renew action.", + "longDescription": "This type shall contain the properties found in the response body for the Renew action.", + "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": { + "CSRString": { + "description": "The string for the certificate signing request.", + "longDescription": "This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string.", + "readonly": true, + "type": "string", + "versionAdded": "v1_1_0" + }, + "Certificate": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate", + "description": "The link to the certificate being renewed.", + "longDescription": "This property shall contain the URI of the Certificate Resource that is replaced after the certificate authority (CA) signs the certificate.", + "readonly": true, + "versionAdded": "v1_1_0" + } + }, + "required": [ + "Certificate", + "CSRString" + ], + "type": "object" } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#Certificate.v1_0_0.Certificate" + "release": "2019.1", + "title": "#Certificate.v1_1_1.Certificate" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/CertificateLocations/CertificateLocations.json b/static/redfish/v1/JsonSchemas/CertificateLocations/CertificateLocations.json index 89a21a473f..2585748814 100644 --- a/static/redfish/v1/JsonSchemas/CertificateLocations/CertificateLocations.json +++ b/static/redfish/v1/JsonSchemas/CertificateLocations/CertificateLocations.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/CertificateLocations.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/CertificateLocations.v1_0_2.json", "$ref": "#/definitions/CertificateLocations", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "CertificateLocations": { "additionalProperties": false, - "description": "The CertificateLocations schema defines a resource that an administrator can use in order to locate all certificates installed on a given service.", - "longDescription": "This resource shall be used to represent the Certificate Location Properties for a Redfish implementation.", + "description": "The CertificateLocations schema describes a Resource that an administrator can use in order to locate all certificates installed on a given service.", + "longDescription": "This Resource shall represent the Certificate Location Properties 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,21 +51,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -84,8 +84,8 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -93,8 +93,8 @@ }, "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." } }, "required": [ @@ -107,10 +107,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -125,31 +125,31 @@ }, "properties": { "Certificates": { - "description": "This property is an array of references to the certificates installed on this service.", + "description": "An array of links to the certificates installed on this service.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate" }, - "longDescription": "This property shall contain an array of references to Certificate resources that are installed on this service.", + "longDescription": "This property shall contain an array of links to Certificate Resources that are installed on this service.", "readonly": true, "type": "array" }, "Certificates@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." } }, "type": "object" }, "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", @@ -168,5 +168,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#CertificateLocations.v1_0_0.CertificateLocations" + "title": "#CertificateLocations.v1_0_2.CertificateLocations" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/CertificateService/CertificateService.json b/static/redfish/v1/JsonSchemas/CertificateService/CertificateService.json index 8177ba8479..9b2915489e 100644 --- a/static/redfish/v1/JsonSchemas/CertificateService/CertificateService.json +++ b/static/redfish/v1/JsonSchemas/CertificateService/CertificateService.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/CertificateService.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/CertificateService.v1_0_2.json", "$ref": "#/definitions/CertificateService", "$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", @@ -31,18 +31,18 @@ }, "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." } }, "type": "object" }, "CertificateService": { "additionalProperties": false, - "description": "The CertificateService schema defines a Certificate Service which represents the actions available to manage certificates and links to where certificates are installed.", - "longDescription": "This resource shall be used to represent the Certificate Service Properties for a Redfish implementation.", + "description": "The CertificateService schema describes a Certificate Service that represents the actions available to manage certificates and links to the certificates.", + "longDescription": "This Resource shall represent the Certificate Service properties 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", @@ -57,26 +57,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "CertificateLocations": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateLocations.json#/definitions/CertificateLocations", - "description": "Information regarding the location of certificates.", - "longDescription": "This property shall contain the link to a resource of type CertificateLocations.", + "description": "The information about the location of certificates.", + "longDescription": "This property shall contain the link to a Resource of type CertificateLocations.", "readonly": true }, "Description": { @@ -100,8 +100,8 @@ }, "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." } }, "required": [ @@ -117,79 +117,79 @@ "$ref": "#/definitions/GenerateCSRResponse" }, "additionalProperties": false, - "description": "This action is used to perform a certificate signing request.", - "longDescription": "This action shall perform a certificate signing request. The response shall contain a signing request that is used to be signed by a certificate authority (CA). The service should retain the private key used for the generation of this request for when the certificate is installed. The private key should not be part of the response.", + "description": "This action makes a certificate signing request.", + "longDescription": "This action shall make a certificate signing request. The response shall contain a signing request that a certificate authority (CA) must sign. The Service should retain the private key that was generated during this request for installation of the certificate. The private key should not be part of the response.", "parameters": { "AlternativeNames": { - "description": "Additional hostnames of the component that is being secured.", + "description": "The additional host names of the component to secure.", "items": { "type": "string" }, - "longDescription": "This parameter shall contain an array of additional hostnames of the component that is being secured as defined by the Subject Alternative Name extension in RFC5280.", + "longDescription": "This parameter shall contain an array of additional host names of the component to secure, as defined by the RFC5280 'subjectAltName' attribute.", "type": "array" }, "CertificateCollection": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "A link to the certificate collection where the certificate will be installed.", - "longDescription": "This parameter shall contain the URI of the Certificate Collection where the certificate will be installed once the CA has signed the certificate.", + "description": "The URI of the Certificate Resource Collection where the certificate is installed after the certificate authority (CA) signs the certificate.", + "longDescription": "This parameter shall contain the URI of the Certificate Resource Collection where the certificate is installed after the certificate authority (CA) signs the certificate.", "requiredParameter": true }, "ChallengePassword": { - "description": "The challenge password to be applied to the certificate for revocation requests.", - "longDescription": "The value of this property shall contain the challenge password to be applied to the certificate for revocation requests as defined by the challengePassword attribute in RFC2985.", + "description": "The challenge password to apply to the certificate for revocation requests.", + "longDescription": "This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.", "type": "string" }, "City": { "description": "The city or locality of the organization making the request.", - "longDescription": "This parameter shall contain the city or locality of the organization making the request as defined by the localityName attribute in RFC5280.", + "longDescription": "This parameter shall contain the city or locality of the organization making the request, as defined by the RFC5280 'localityName' attribute.", "requiredParameter": true, "type": "string" }, "CommonName": { - "description": "The fully qualified domain name of the component that is being secured.", - "longDescription": "This parameter shall contain the fully qualified domain name of the component that is being secured as defined by the commonName attribute in RFC5280.", + "description": "The fully qualified domain name of the component to secure.", + "longDescription": "This parameter shall contain the fully qualified domain name of the component to secure, as defined by the RFC5280 'commonName' attribute.", "requiredParameter": true, "type": "string" }, "ContactPerson": { "description": "The name of the user making the request.", - "longDescription": "The value of this property shall contain the name of the user making the request as defined by the name attribute in RFC5280.", + "longDescription": "This property shall contain the name of the user making the request, as defined by the RFC5280 'name' attribute.", "type": "string" }, "Country": { - "description": "The country of the organization making the request.", - "longDescription": "This parameter shall contain the two letter ISO code for the country of the organization making the request as defined by the countryName attribute in RFC5280.", + "description": "The two-letter country code of the organization making the request.", + "longDescription": "This parameter shall contain the two-letter ISO code for the country of the organization making the request, as defined by the RFC5280 'countryName' attribute.", "requiredParameter": true, "type": "string" }, "Email": { "description": "The email address of the contact within the organization making the request.", - "longDescription": "This parameter shall contain the email address of the contact within the organization making the request as defined by the emailAddress attribute in RFC2985.", + "longDescription": "This parameter shall contain the email address of the contact within the organization making the request, as defined by the RFC2985 'emailAddress' attribute.", "type": "string" }, "GivenName": { "description": "The given name of the user making the request.", - "longDescription": "The value of this property shall contain the given name of the user making the request as defined by the givenName attribute in RFC5280.", + "longDescription": "This parameter shall contain the given name of the user making the request, as defined by the RFC5280 'givenName' attribute.", "type": "string" }, "Initials": { "description": "The initials of the user making the request.", - "longDescription": "The value of this property shall contain the initials of the user making the request as defined by the initials attribute in RFC5280.", + "longDescription": "This parameter shall contain the initials of the user making the request, as defined by the RFC5280 'initials' attribute.", "type": "string" }, "KeyBitLength": { - "description": "The length of the key in bits, if needed based on the value of the 'KeyPairAlgorithm' parameter.", - "longDescription": "The value of this property shall be the length of the key in bits, if needed based on the value of the 'KeyPairAlgorithm' parameter.", + "description": "The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.", + "longDescription": "This parameter shall contain the length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.", "type": "integer" }, "KeyCurveId": { - "description": "The curve ID to be used with the key, if needed based on the value of the 'KeyPairAlgorithm' parameter.", - "longDescription": "The value of this property shall be the curve ID to be used with the key, if needed based on the value of the 'KeyPairAlgorithm' parameter. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'.", + "description": "The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.", + "longDescription": "This parameter shall contain the curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'.", "type": "string" }, "KeyPairAlgorithm": { - "description": "The type of key pair for use with signing algorithms.", - "longDescription": "The value of this property shall be the type of key pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.", + "description": "The type of key-pair for use with signing algorithms.", + "longDescription": "This parameter shall contain the type of key-pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.", "type": "string" }, "KeyUsage": { @@ -197,40 +197,40 @@ "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/KeyUsage" }, - "longDescription": "This parameter shall contain the usage of the key contained in the certificate. If not provided by the client, the service may determine the appropriate key usage settings in the certificate signing request.", + "longDescription": "This parameter shall contain the usage of the key contained in the certificate. If the client does not provide this value, the service may determine the appropriate key usage settings in the certificate signing request.", "type": "array" }, "Organization": { "description": "The name of the organization making the request.", - "longDescription": "This parameter shall contain the name of the organization making the request as defined by the organizationName attribute in RFC5280.", + "longDescription": "This parameter shall contain the name of the organization making the request, as defined by the RFC5280 'organizationName' attribute.", "requiredParameter": true, "type": "string" }, "OrganizationalUnit": { "description": "The name of the unit or division of the organization making the request.", - "longDescription": "This parameter shall contain the name of the unit or division of the organization making the request as defined by the organizationalUnitName attribute in RFC5280.", + "longDescription": "This parameter shall contain the name of the unit or division of the organization making the request, as defined by the RFC5280 'organizationalUnitName' attribute.", "requiredParameter": true, "type": "string" }, "State": { "description": "The state, province, or region of the organization making the request.", - "longDescription": "This parameter shall contain the state, province, or region of the organization making the request as defined by the stateOrProvinceName attribute in RFC5280.", + "longDescription": "This parameter shall contain the state, province, or region of the organization making the request, as defined by the RFC5280 'stateOrProvinceName' attribute.", "requiredParameter": true, "type": "string" }, "Surname": { "description": "The surname of the user making the request.", - "longDescription": "The value of this property shall contain the surname of the user making the request as defined by the surname attribute in RFC5280.", + "longDescription": "This parameter shall contain the surname of the user making the request, as defined by the RFC5280 'surname' attribute.", "type": "string" }, "UnstructuredName": { "description": "The unstructured name of the subject.", - "longDescription": "The value of this property shall contain the unstructured name of the subject as defined by the unstructuredName attribute in RFC2985.", + "longDescription": "This property shall contain the unstructured name of the subject, as defined by the RFC2985 'unstructuredName' attribute.", "type": "string" } }, "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", @@ -246,7 +246,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -261,7 +261,7 @@ "description": "The response body for the GenerateCSR action.", "longDescription": "This type shall contain the properties found in the response body for the GenerateCSR action.", "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", @@ -277,14 +277,14 @@ "properties": { "CSRString": { "description": "The string for the certificate signing request.", - "longDescription": "The value of this property shall be the string of the certificate signing request as a Privacy Enhanced Mail (PEM) encoded string, containing structures specified by RFC2986. The private key should not be part of the string.", + "longDescription": "This property shall contain the Privacy Enhanced Mail (PEM)-encoded string, which contains RFC2986-specified structures, of the certificate signing request. The private key should not be part of the string.", "readonly": true, "type": "string" }, "CertificateCollection": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "A link to the certificate collection where the certificate will be installed.", - "longDescription": "This property shall contain the URI of the Certificate Collection where the certificate will be installed once the CA has signed the certificate.", + "description": "The link to the Certificate Resource Collection where the certificate is installed.", + "longDescription": "This property shall contain the URI of the Certificate Resource Collection where the certificate is installed after the certificate authority (CA) has signed the certificate.", "readonly": true } }, @@ -296,10 +296,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", @@ -317,30 +317,30 @@ }, "ReplaceCertificate": { "additionalProperties": false, - "description": "This action is used to replace an existing certificate.", - "longDescription": "This action shall replace an existing certificate. The Location header in the response shall contain the URI of the new Certificate resource.", + "description": "This action replaces a certificate.", + "longDescription": "This action shall replace a certificate. The Location header in the response shall contain the URI of the new Certificate Resource.", "parameters": { "CertificateString": { "description": "The string for the certificate.", - "longDescription": "The value of this property shall be the string of the certificate, and the format shall follow the requirements specified by the value of the CertificateType property. If the certificate contains any private keys, they shall be removed from the string on GET requests. If the private key for the certificate is not known by the service and is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.", + "longDescription": "This parameter shall contain the string of the certificate, and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and it is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.", "requiredParameter": true, "type": "string" }, "CertificateType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/CertificateType", "description": "The format of the certificate.", - "longDescription": "The value of this parameter shall contain the format type for the certificate.", + "longDescription": "This parameter shall contain the format type for the certificate.", "requiredParameter": true }, "CertificateUri": { "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate", - "description": "A link to the certificate that is being replaced.", - "longDescription": "This parameter shall contain the URI of the Certificate that is being replaced.", + "description": "The link to the certificate that is being replaced.", + "longDescription": "This parameter shall contain the URI of the Certificate Resource that is being replaced.", "requiredParameter": true } }, "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", @@ -356,7 +356,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -369,5 +369,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#CertificateService.v1_0_0.CertificateService" + "title": "#CertificateService.v1_0_2.CertificateService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Chassis/Chassis.json b/static/redfish/v1/JsonSchemas/Chassis/Chassis.json index 1f5f1cbd05..40a97f49da 100644 --- a/static/redfish/v1/JsonSchemas/Chassis/Chassis.json +++ b/static/redfish/v1/JsonSchemas/Chassis/Chassis.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Chassis.v1_9_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Chassis.v1_10_0.json", "$ref": "#/definitions/Chassis", "$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", @@ -28,18 +28,18 @@ }, "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." } }, "type": "object" }, "Chassis": { "additionalProperties": false, - "description": "The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.", - "longDescription": "This resource shall be used to represent a chassis or other physical enclosure for a Redfish implementation.", + "description": "The Chassis schema represents the physical components of a system. This Resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this Resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system.", + "longDescription": "This Resource shall represent a chassis or other physical enclosure 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", @@ -54,32 +54,32 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this chassis.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to the Assembly associated with this chassis.", + "longDescription": "This property shall contain a link to a Resource of type Assembly.", "readonly": true, "versionAdded": "v1_6_0" }, "AssetTag": { - "description": "The user assigned asset tag of this chassis.", - "longDescription": "The value of this property shall be an identifying string used to track the chassis for inventory purposes.", + "description": "The user-assigned asset tag of this chassis.", + "longDescription": "This property shall contain an identifying string that tracks the chassis for inventory purposes.", "readonly": false, "type": [ "string", @@ -94,7 +94,7 @@ }, "DepthMm": { "description": "The depth of the chassis.", - "longDescription": "The value of this property shall represent the depth (length) of the chassis (in millimeters) as specified by the manufacturer.", + "longDescription": "This property shall represent the depth (length) of the chassis (in millimeters) as specified by the manufacturer.", "minimum": 0, "readonly": true, "type": [ @@ -124,14 +124,14 @@ "type": "null" } ], - "description": "The ASHRAE Environmental Class for this Chassis.", - "longDescription": "The value of this property shall be the ASHRAE Environmental Specification Class for this Chassis, as defined by ASHRAE Thermal Guidelines for Data Processing Environments. These classes define respective environmental limits which include temperature, relative humidity, dew point, and maximum allowable elevation.", + "description": "The ASHRAE Environmental Class for this chassis.", + "longDescription": "This property shall contain the ASHRAE Environmental Class for this chassis, as defined by ASHRAE Thermal Guidelines for Data Processing Environments. These classes define respective environmental limits that include temperature, relative humidity, dew point, and maximum allowable elevation.", "readonly": true, "versionAdded": "v1_9_0" }, "HeightMm": { "description": "The height of the chassis.", - "longDescription": "The value of this property shall represent the height of the chassis (in millimeters) as specified by the manufacturer.", + "longDescription": "This property shall represent the height of the chassis (in millimeters) as specified by the manufacturer.", "minimum": 0, "readonly": true, "type": [ @@ -154,30 +154,30 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify the chassis.", - "longDescription": "This value of this property shall contain the indicator light state for the indicator light associated with this system.", + "description": "The state of the indicator LED, which identifies the chassis.", + "longDescription": "This property shall contain the indicator light state for the indicator light associated with this system.", "readonly": false }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the chassis.", + "description": "The location of the chassis.", "longDescription": "This property shall contain location information of the associated chassis.", "versionAdded": "v1_2_0" }, "LogServices": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection", - "description": "A reference to the logs for this chassis.", - "longDescription": "The value of this property shall be a link to a collection of type LogServiceCollection.", + "description": "The link to the logs for this chassis.", + "longDescription": "This property shall contain a link to a Resource Collection of type LogServiceCollection.", "readonly": true }, "Manufacturer": { "description": "The manufacturer of this chassis.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the chassis. This organization might be the entity from whom the chassis is purchased, but this is not necessarily true.", + "longDescription": "This property shall contain the name of the organization responsible for producing the chassis. This organization might be the entity from whom the chassis is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -186,7 +186,7 @@ }, "Model": { "description": "The model number of the chassis.", - "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the chassis.", + "longDescription": "This property shall contain the name by which the manufacturer generally refers to the chassis.", "readonly": true, "type": [ "string", @@ -199,26 +199,33 @@ }, "NetworkAdapters": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkAdapterCollection.json#/definitions/NetworkAdapterCollection", - "description": "A reference to the collection of Network Adapters associated with this chassis.", - "longDescription": "The value of this property shall be a link to a collection of type NetworkAdapterCollection.", + "description": "The link to the collection of Network Adapters associated with this chassis.", + "longDescription": "This property shall contain a link to a Resource Collection of type NetworkAdapterCollection.", "readonly": true, "versionAdded": "v1_4_0" }, "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." + }, + "PCIeDevices": { + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDeviceCollection.json#/definitions/PCIeDeviceCollection", + "description": "The link to the collection of PCIe devices located in this chassis.", + "longDescription": "This property shall contain a link to a Resource Collection of type PCIeDeviceCollection.", + "readonly": true, + "versionAdded": "v1_10_0" }, "PCIeSlots": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeSlots.json#/definitions/PCIeSlots", - "description": "A reference to the PCIe Slot properties of this chassis.", - "longDescription": "The value of this property shall be a reference to the resource that represents the PCIe Slot information for this chassis and shall be of type PCIeSlot.", + "description": "The link to the PCIe slot properties for this chassis.", + "longDescription": "This property shall contain a link to the Resource that represents the PCIe slot information for this chassis and shall be of the PCIeSlot type.", "readonly": true, "versionAdded": "v1_8_0" }, "PartNumber": { "description": "The part number of the chassis.", - "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the chassis.", + "longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the chassis.", "readonly": true, "type": [ "string", @@ -228,13 +235,13 @@ "PhysicalSecurity": { "$ref": "#/definitions/PhysicalSecurity", "description": "The state of the physical security sensor.", - "longDescription": "This value of this property shall contain the sensor state of the physical security.", + "longDescription": "This property shall contain the sensor state of the physical security.", "versionAdded": "v1_1_0" }, "Power": { "$ref": "http://redfish.dmtf.org/schemas/v1/Power.json#/definitions/Power", - "description": "A reference to the power properties (power supplies, power policies, sensors) of this chassis.", - "longDescription": "The value of this property shall be a reference to the resource that represents the power characteristics of this chassis and shall be of type Power.", + "description": "The link to the power properties, or power supplies, power policies, and sensors, for this chassis.", + "longDescription": "This property shall contain a link to the Resource that represents the power characteristics of this chassis and shall be of the Power type.", "readonly": true }, "PowerState": { @@ -247,13 +254,13 @@ } ], "description": "The current power state of the chassis.", - "longDescription": "The value of this property shall contain the power state of the chassis.", + "longDescription": "This property shall contain the power state of the chassis.", "readonly": true, "versionAdded": "v1_0_1" }, "SKU": { "description": "The SKU of the chassis.", - "longDescription": "The value of this property shall be the stock-keeping unit number for this chassis.", + "longDescription": "This property shall contain the stock-keeping unit number for this chassis.", "readonly": true, "type": [ "string", @@ -263,13 +270,13 @@ "Sensors": { "$ref": "http://redfish.dmtf.org/schemas/v1/SensorCollection.json#/definitions/SensorCollection", "description": "The naivgation pointer to the collection of sensors located in the equipment and sub-components.", - "longDescription": "This property shall be a reference to a resource of type SensorCollection that contains the sensors located in the Chassis and sub-components.", + "longDescription": "This property shall contain a link to a Resource of type SensorCollection that contains the sensors located in the chassis and sub-components.", "readonly": true, "versionAdded": "v1_9_0" }, "SerialNumber": { "description": "The serial number of the chassis.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the chassis.", + "longDescription": "This property shall contain a manufacturer-allocated number that identifies the chassis.", "readonly": true, "type": [ "string", @@ -278,13 +285,13 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Thermal": { "$ref": "http://redfish.dmtf.org/schemas/v1/Thermal.json#/definitions/Thermal", - "description": "A reference to the thermal properties (fans, cooling, sensors) of this chassis.", - "longDescription": "The value of this property shall be a reference to the resource that represents the thermal characteristics of this chassis and shall be of type Thermal.", + "description": "The link to the thermal properties, such as fans, cooling, and sensors, for this chassis.", + "longDescription": "This property shall contain a link to the Resource that represents the thermal characteristics of this chassis and shall be of the Thermal type.", "readonly": true }, "UUID": { @@ -296,14 +303,14 @@ "type": "null" } ], - "description": "The Universal Unique Identifier (UUID) for this Chassis.", - "longDescription": "The value of this property shall contain the universal unique identifier number for the chassis.", + "description": "The Universal Unique Identifier (UUID) for this chassis.", + "longDescription": "This property shall contain the universal unique identifier number for the chassis.", "readonly": true, "versionAdded": "v1_7_0" }, "WeightKg": { "description": "The weight of the chassis.", - "longDescription": "The value of this property shall represent the published mass (commonly referred to as weight) of the chassis (in kilograms).", + "longDescription": "This property shall represent the published mass (commonly referred to as weight) of the chassis (in kilograms).", "minimum": 0, "readonly": true, "type": [ @@ -315,7 +322,7 @@ }, "WidthMm": { "description": "The width of the chassis.", - "longDescription": "The value of this property shall represent the width of the chassis (in millimeters) as specified by the manufacturer.", + "longDescription": "This property shall represent the width of the chassis (in millimeters) as specified by the manufacturer.", "minimum": 0, "readonly": true, "type": [ @@ -360,26 +367,26 @@ "Other" ], "enumDescriptions": { - "Blade": "An enclosed or semi-enclosed, typically vertically-oriented, system chassis which must be plugged into a multi-system chassis to function normally.", + "Blade": "An enclosed or semi-enclosed, typically vertically-oriented, system chassis that must be plugged into a multi-system chassis to function normally.", "Card": "A loose device or circuit board intended to be installed in a system or other enclosure.", "Cartridge": "A small self-contained system intended to be plugged into a multi-system chassis.", - "Component": "A small chassis, card, or device which contains devices for a particular subsystem or function.", - "Drawer": "An enclosed or semi-enclosed, typically horizontally-oriented, system chassis which may be slid into a multi-system chassis.", + "Component": "A small chassis, card, or device that contains devices for a particular subsystem or function.", + "Drawer": "An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that may be slid into a multi-system chassis.", "Enclosure": "A generic term for a chassis that does not fit any other description.", - "Expansion": "A chassis which expands the capabilities or capacity of another chassis.", + "Expansion": "A chassis that expands the capabilities or capacity of another chassis.", "IPBasedDrive": "A chassis in a drive form factor with IP-based network connections.", - "Module": "A small, typically removable, chassis or card which contains devices for a particular subsystem or function.", + "Module": "A small, typically removable, chassis or card that contains devices for a particular subsystem or function.", "Other": "A chassis that does not fit any of these definitions.", "Pod": "A collection of equipment racks in a large, likely transportable, container.", "Rack": "An equipment rack, typically a 19-inch wide freestanding unit.", - "RackGroup": "A group of racks which form a single entity or share infrastructure.", - "RackMount": "A single system chassis designed specifically for mounting in an equipment rack.", + "RackGroup": "A group of racks that form a single entity or share infrastructure.", + "RackMount": "A single-system chassis designed specifically for mounting in an equipment rack.", "Row": "A collection of equipment racks.", - "Shelf": "An enclosed or semi-enclosed, typically horizontally-oriented, system chassis which must be plugged into a multi-system chassis to function normally.", + "Shelf": "An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that must be plugged into a multi-system chassis to function normally.", "Sidecar": "A chassis that mates mechanically with another chassis to expand its capabilities or capacity.", - "Sled": "An enclosed or semi-enclosed, system chassis which must be plugged into a multi-system chassis to function normally similar to a blade type chassis.", + "Sled": "An enclosed or semi-enclosed, system chassis that must be plugged into a multi-system chassis to function normally similar to a blade type chassis.", "StandAlone": "A single, free-standing system, commonly called a tower or desktop chassis.", - "StorageEnclosure": "A chassis which encloses storage.", + "StorageEnclosure": "A chassis that encloses storage.", "Zone": "A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated." }, "enumVersionAdded": { @@ -397,10 +404,10 @@ "A4" ], "enumDescriptions": { - "A1": "ASHRAE Environmental Specification Class 'A1'.", - "A2": "ASHRAE Environmental Specification Class 'A2'.", - "A3": "ASHRAE Environmental Specification Class 'A3'.", - "A4": "ASHRAE Environmental Specification Class 'A4'." + "A1": "ASHRAE Environmental Class 'A1'.", + "A2": "ASHRAE Environmental Class 'A2'.", + "A3": "ASHRAE Environmental Class 'A3'.", + "A4": "ASHRAE Environmental Class 'A4'." }, "type": "string" }, @@ -412,19 +419,19 @@ "Off" ], "enumDeprecated": { - "Unknown": "This value has been Deprecated in favor of returning null if the state is unknown." + "Unknown": "This value has been deprecated in favor of returning null if the state is unknown." }, "enumDescriptions": { - "Blinking": "The Indicator LED is blinking.", - "Lit": "The Indicator LED is lit.", - "Off": "The Indicator LED is off.", - "Unknown": "The state of the Indicator LED cannot be determined." + "Blinking": "The indicator LED is blinking.", + "Lit": "The indicator LED is lit.", + "Off": "The indicator LED is off.", + "Unknown": "The state of the indicator LED cannot be determined." }, "enumLongDescriptions": { - "Blinking": "This value shall represent the Indicator LED is in a blinking state where the LED is being turned on and off in repetition. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).", - "Lit": "This value shall represent the Indicator LED is in a solid on state. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).", - "Off": "This value shall represent the Indicator LED is in a solid off state. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).", - "Unknown": "This value shall represent the Indicator LED is in an unknown state. The service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request)." + "Blinking": "This value shall represent the indicator LED is in a blinking state where the LED is being turned on and off in repetition. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.", + "Lit": "This value shall represent the indicator LED is in a solid on state. If the service does not support this value, it shall return the HTTP 400 (Bad Request) status code to reject PATCH or PUT requests that contain this value.", + "Off": "This value shall represent the indicator LED is in a solid off state. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.", + "Unknown": "This value shall represent the indicator LED is in an unknown state. The Service shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code." }, "enumVersionDeprecated": { "Unknown": "v1_2_0" @@ -438,8 +445,8 @@ "TamperingDetected" ], "enumDescriptions": { - "HardwareIntrusion": "A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected as being in an insecure state.", - "Normal": "No abnormal physical security conditions are detected at this time.", + "HardwareIntrusion": "A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected to be in an insecure state.", + "Normal": "No abnormal physical security condition is detected at this time.", "TamperingDetected": "Physical tampering of the monitored entity is detected." }, "type": "string" @@ -450,17 +457,17 @@ "Automatic" ], "enumDescriptions": { - "Automatic": "This sensor would be restored to the Normal state automatically as no abnormal physical security conditions are detected.", - "Manual": "This sensor would be restored to the Normal state by a manual re-arm." + "Automatic": "Because no abnormal physical security condition is detected, this sensor is automatically restored to the normal state.", + "Manual": "A manual re-arm of this sensor restores it to the normal state." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -475,176 +482,178 @@ }, "properties": { "ComputerSystems": { - "description": "An array of references to the computer systems contained in this chassis. This will only reference ComputerSystems that are directly and wholly contained in this chassis.", + "description": "An array of links to the computer systems that this chassis directly and wholly contains.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "The value of this property shall be a reference to the resource that this physical container is associated with and shall reference a resource of type ComputerSystem. If a ComputerSystem is also referenced in a Chassis that is referenced in a Contains link from this resource, that ComputerSystem shall not be referenced in this Chassis.", + "longDescription": "This property shall contain a link to the Resource of type ComputerSystem with which this physical container is associated. If a chassis also links to a computer system to which this Resource also links, this chassis shall not link to that computer system.", "readonly": true, "type": "array" }, "ComputerSystems@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ContainedBy": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the chassis that this chassis is contained by.", - "longDescription": "The value of this property shall be a reference to the resource that represents the chassis that contains this chassis and shall be of type Chassis.", + "description": "The link to the chassis that contains this chassis.", + "longDescription": "This property shall contain a link to the Resource that represents the chassis that contains this chassis and shall be of the Chassis type.", "readonly": true }, "Contains": { - "description": "An array of references to any other chassis that this chassis has in it.", + "description": "An array of links to any other chassis that this chassis has in it.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" }, - "longDescription": "The value of this property shall be a reference to the resource that represents the chassis that this chassis contains and shall be of type Chassis.", + "longDescription": "This property shall contain a link to the Resource that represents the chassis that this chassis contains and shall be of the Chassis type.", "readonly": true, "type": "array" }, "Contains@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "CooledBy": { - "description": "An array of ID[s] of resources that cool this chassis. Normally the ID will be a chassis or a specific set of fans.", + "description": "An array of one or more IDs of Resources that cool this chassis. Normally, the ID is for either a chassis or a specific set of fans.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that cools this chassis.", + "longDescription": "This property shall contain an array of one or more IDs that contain pointers consistent with JSON Pointer syntax to the Resource that cools this chassis.", "readonly": true, "type": "array" }, "CooledBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Drives": { - "description": "An array of references to the disk drives located in this Chassis.", + "description": "An array of links to the drives located in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" }, - "longDescription": "The value of this property shall reference one or more resources of type Drive that are in this Chassis.", + "longDescription": "This property shall link to one or more Resources of the Drive type that are in this chassis.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "Drives@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ManagedBy": { - "description": "An array of references to the Managers responsible for managing this chassis.", + "description": "An array of links to the Managers responsible for managing this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "The value of this property shall be a reference to the resource that manages this chassis and shall reference a resource of type Manager.", + "longDescription": "This property shall contain a link to the Resource of type Manager that manages this chassis.", "readonly": true, "type": "array" }, "ManagedBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ManagersInChassis": { - "description": "An array of references to the managers located in this Chassis.", + "description": "An array of links to the managers located in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "The value of this property shall reference one or more resources of type Manager that are in this Chassis.", + "longDescription": "This property shall link to one or more Resources of the Manager type that are in this chassis.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "ManagersInChassis@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PCIeDevices": { - "description": "An array of references to the PCIe Devices located in this Chassis.", + "deprecated": "This property has been deprecated in favor of the PCIeDevices Resource Collection in the root of this Resource.", + "description": "An array of links to the PCIe devices located in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" }, - "longDescription": "The value of this property shall reference one or more resources of type PCIeDevices.", + "longDescription": "This property shall contain an array of links to one or more Resources of the PCIeDevices type.", "readonly": true, "type": "array", - "versionAdded": "v1_4_0" + "versionAdded": "v1_4_0", + "versionDeprecated": "v1_10_0" }, "PCIeDevices@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "PoweredBy": { - "description": "An array of ID[s] of resources that power this chassis. Normally the ID will be a chassis or a specific set of Power Supplies.", + "description": "An array of one or more IDs of Resources that power this chassis. Normally, the ID is for either a chassis or a specific set of power supplies.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that powers this chassis.", + "longDescription": "This property shall contain an array of one or more IDs that contain pointers consistent with JSON Pointer syntax to the Resource that powers this chassis.", "readonly": true, "type": "array" }, "PoweredBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Processors": { - "description": "An array of references to the Processors located in this Chassis.", + "description": "An array of links to the processors located in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor" }, - "longDescription": "The value of this property shall be an array of references of type Processor that are contained in this Chassis.", + "longDescription": "This property shall contain an array of links of the Processor type that this chassis contains.", "readonly": true, "type": "array", "versionAdded": "v1_9_0" }, "Processors@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ResourceBlocks": { - "description": "An array of references to the Resource Blocks located in this Chassis.", + "description": "An array of links to the Resource Blocks located in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock" }, - "longDescription": "The value of this property shall be an array of references of type ResourceBlock that are contained in this Chassis.", + "longDescription": "This property shall contain an array of links of the ResourceBlock type that this chassis contains.", "readonly": true, "type": "array", "versionAdded": "v1_5_0" }, "ResourceBlocks@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Storage": { - "description": "An array of references to the storage subsystems connected to or inside this Chassis.", + "description": "An array of links to the storage subsystems connected to or inside this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/Storage" }, - "longDescription": "The value of this property shall reference one or more resources of type Storage that are connected to or contained inside this Chassis.", + "longDescription": "This property shall link to one or more Resources of the Storage type that are connected to or contained in this chassis.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "Storage@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Switches": { - "description": "An array of references to the Switches located in this Chassis.", + "description": "An array of links to the Switches located in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Switch.json#/definitions/Switch" }, - "longDescription": "The value of this property shall be an array of references of type Switch that are contained in this Chassis.", + "longDescription": "This property shall contain an array of links of the Switch type that this chassis contains.", "readonly": true, "type": "array", "versionAdded": "v1_7_0" }, "Switches@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -665,7 +674,7 @@ "description": "The state of the physical security sensor.", "longDescription": "This type shall describe the sensor state of the physical security.", "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", @@ -689,13 +698,13 @@ } ], "description": "This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.", - "longDescription": "This property shall represent the state of this physical security sensor. Hardware intrusion indicates the internal hardware is detected as being accessed in an insecure state. Tampering detected indicates the physical tampering of the monitored entity is detected.", + "longDescription": "This property shall represent the state of this physical security sensor. Hardware intrusion indicates the internal hardware is detected as being accessed in an insecure state. Tampering detected indicates the physical tampering of the monitored entity is detected.", "readonly": false, "versionAdded": "v1_1_0" }, "IntrusionSensorNumber": { "description": "A numerical identifier to represent the physical security sensor.", - "longDescription": "The value of this property shall be a numerical identifier for this physical security sensor that is unique within this resource.", + "longDescription": "This property shall contain a numerical identifier for this physical security sensor that is unique within this Resource.", "readonly": true, "type": [ "integer", @@ -712,8 +721,8 @@ "type": "null" } ], - "description": "This indicates how the Normal state to be restored.", - "longDescription": "This property shall represent the method to set back to the Normal statue of this physical security sensor. Manual indicates manual re-arm is needed. Automatic indicates the state is restored automatically as no abnormal physical security conditions are detected.", + "description": "The method that restores this physical security sensor to the normal state.", + "longDescription": "This property shall represent the method that restores this physical security sensor to the normal state. Manual indicates manual re-arm is needed. Automatic indicates the state is restored automatically because no abnormal physical security conditions are detected.", "readonly": true, "versionAdded": "v1_1_0" } @@ -728,26 +737,26 @@ "PoweringOff" ], "enumDescriptions": { - "Off": "The components within the chassis has no power, except some components may continue to have AUX power such as management controller.", - "On": "The components within the chassis has power on.", - "PoweringOff": "A temporary state between On and Off. The components within the chassis can take time to process the power off action.", - "PoweringOn": "A temporary state between Off and On. The components within the chassis can take time to process the power on action." + "Off": "The components within the chassis have no power, except some components may continue to have AUX power, such as the management controller.", + "On": "The components within the chassis have power.", + "PoweringOff": "A temporary state between on and off. The components within the chassis can take time to process the power off action.", + "PoweringOn": "A temporary state between off and on. The components within the chassis can take time to process the power on action." }, "type": "string" }, "Reset": { "additionalProperties": false, - "description": "This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources.", - "longDescription": "This action shall reset the chassis. This action shall not reset Systems or other contained resource, although side effects may occur which affect those resources.", + "description": "This action resets the chassis but does not reset systems or other contained Resources, although side effects may occur that affect those Resources.", + "longDescription": "This action shall reset the chassis but shall not reset systems or other contained Resources, although side effects may occur that affect those Resources.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", - "description": "The type of reset to be performed.", - "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset." + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and complete an implementation-specific default reset." } }, "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", @@ -763,7 +772,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -775,6 +784,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#Chassis.v1_9_0.Chassis" + "release": "2019.2", + "title": "#Chassis.v1_10_0.Chassis" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json b/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json index 237727f27f..6ae64becbf 100644 --- a/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json +++ b/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json @@ -1,14 +1,14 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.v1_1_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.v1_2_0.json", "$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": { "Capability": { "additionalProperties": false, - "description": "This type describes a specific capability of a collection for a given use case.", - "longDescription": "This type shall describe a specific capability of a collection in terms of how a client is able to create new resources within the collection for the specified use case.", + "description": "This type describes a capability of a collection for a specific use case.", + "longDescription": "This type shall describe a capability of a Resource Collection in terms of how a client can create Resources within the collection for the specified use case.", "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", @@ -23,20 +23,20 @@ }, "properties": { "CapabilitiesObject": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", - "description": "Reference to the resource the client may GET to in order to understand how to form a POST request for a given collection.", - "longDescription": "The value of this property shall be a reference to a Resource that matches the type for the given collection and shall contain annotations that describe the properties allowed in the POST request.", + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", + "description": "The link to the Resource the client may GET to understand how to form a POST request for a collection.", + "longDescription": "This property shall contain a link to a Resource that matches the type for a Resource Collection and shall contain annotations that describe the properties allowed in the POST request.", "readonly": true }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "UseCase": { "$ref": "#/definitions/UseCase", - "description": "This property represents the use case in which a client may issue a POST request to the collection.", - "longDescription": "The value of this property shall be an enumerated value describing the use case for this capability instance.", + "description": "The use case in which a client may issue a POST request to the collection.", + "longDescription": "This property shall contain an enumerated value that describes the use case for this capability instance.", "readonly": true } }, @@ -50,9 +50,9 @@ "CollectionCapabilities": { "additionalProperties": false, "description": "This type describes the capabilities of a collection.", - "longDescription": "This type shall describe any capabilities of a collection in terms of how a client is able to create new resources within the collection.", + "longDescription": "This type shall describe any capabilities of a Resource Collection in terms of how a client can create Resources within the Resource Collection.", "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", @@ -67,22 +67,30 @@ }, "properties": { "Capabilities": { - "description": "This property contains the list of capabilities supported by this resource.", + "description": "The list of capabilities supported by this Resource.", "items": { "$ref": "#/definitions/Capability" }, - "longDescription": "The value of this property shall be an array of Capability structures.", + "longDescription": "This property shall contain an array of Capability structures.", "type": "array" + }, + "MaxMembers": { + "description": "The maximum number of members allowed in this collection.", + "longDescription": "This integer property shall contain the maximum number of members allowed in this Resource Collection.", + "minimum": 1, + "readonly": true, + "type": "integer", + "versionAdded": "v1_2_0" } }, "type": "object" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -98,25 +106,25 @@ "properties": { "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." }, "RelatedItem": { - "description": "The ID(s) of the resources associated with this capability.", + "description": "The ID(s) of the Resources associated with this capability.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is related to this capability.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is related to this capability.", "readonly": true, "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "TargetCollection": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResourceCollection", "description": "Reference to the collection that this capabilities structure is describing.", - "longDescription": "The value of this property shall be a reference to a Resource Collection that this structure is describing. This structure may be used by a client in order to understand how to form the POST request for the given collection.", + "longDescription": "This property shall contain a link to a Resource Collection that this structure describes. A client may use this structure to understand how to form the POST request for the collection.", "readonly": true } }, @@ -143,6 +151,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.2", - "title": "#CollectionCapabilities.v1_1_1" + "release": "2019.2", + "title": "#CollectionCapabilities.v1_2_0" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/CompositionService/CompositionService.json b/static/redfish/v1/JsonSchemas/CompositionService/CompositionService.json index 38ba465018..78c55e6c8a 100644 --- a/static/redfish/v1/JsonSchemas/CompositionService/CompositionService.json +++ b/static/redfish/v1/JsonSchemas/CompositionService/CompositionService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/CompositionService.v1_1_2.json", "$ref": "#/definitions/CompositionService", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "CompositionService": { "additionalProperties": false, - "description": "The CompositionService schema defines a Composition Service which represents the properties for the service and links to the resources available for composition.", - "longDescription": "This resource shall be used to represent the Composition Service Properties for a Redfish implementation.", + "description": "The CompositionService schema describes a Composition Service and its properties and links to the Resources available for composition.", + "longDescription": "This Resource shall represent the Composition Service and its properties 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", @@ -50,39 +51,41 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AllowOverprovisioning": { - "description": "This indicates whether this service is allowed to overprovision a composition relative to the composition request.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is allowed to overprovision a composition relative to the composition request.", + "description": "An indication of whether this service is allowed to overprovision a composition relative to the composition request.", + "longDescription": "This property shall indicate whether this service is allowed to overprovision a composition relative to the composition request.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_1_0" }, "AllowZoneAffinity": { - "description": "This indicates whether a client is allowed to request that given composition request is fulfilled by a specified Resource Zone.", - "longDescription": "The value of this property shall be a boolean indicating whether a client is allowed to request that given composition request is fulfilled by a specified Resource Zone.", + "description": "An indication of whether a client can request that a specific Resource Zone fulfill a composition request.", + "longDescription": "This property shall indicate whether a client can request that a specific Resource Zone fulfill a composition request.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_1_0" }, "Description": { "anyOf": [ @@ -105,24 +108,24 @@ }, "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." }, "ResourceBlocks": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlockCollection.json#/definitions/ResourceBlockCollection", - "description": "The resource blocks available on the service.", - "longDescription": "This property shall contain the link to a collection of type ResourceBlockCollection.", + "description": "The Resource Blocks available on the service.", + "longDescription": "This property shall contain the link to a Resource Collection of type ResourceBlockCollection.", "readonly": true }, "ResourceZones": { "$ref": "http://redfish.dmtf.org/schemas/v1/ZoneCollection.json#/definitions/ZoneCollection", - "description": "The resource zones available on the service.", - "longDescription": "This property shall contain the link to a collection of type ZoneCollection.", + "description": "The Resource Zones available on the service.", + "longDescription": "This property shall contain the link to a Resource Collection of type ZoneCollection.", "readonly": true }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -131,8 +134,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -145,10 +148,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", @@ -166,5 +169,6 @@ } }, "owningEntity": "DMTF", - "title": "#CompositionService.v1_1_0.CompositionService" + "release": "2018.2", + "title": "#CompositionService.v1_1_2.CompositionService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ComputerSystem/ComputerSystem.json b/static/redfish/v1/JsonSchemas/ComputerSystem/ComputerSystem.json index 86ffac2124..9c8f952dc7 100644 --- a/static/redfish/v1/JsonSchemas/ComputerSystem/ComputerSystem.json +++ b/static/redfish/v1/JsonSchemas/ComputerSystem/ComputerSystem.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.v1_6_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.v1_8_0.json", "$ref": "#/definitions/ComputerSystem", "$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", @@ -37,36 +37,36 @@ }, "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." } }, "type": "object" }, "AddResourceBlock": { "additionalProperties": false, - "description": "This action is used to add a Resource Block to a system.", - "longDescription": "This action shall be used to add a Resource Block to a system.", + "description": "This action adds a Resource Block to a system.", + "longDescription": "This action shall add a Resource Block to a system.", "parameters": { "ComputerSystemETag": { "description": "The current ETag of the system.", - "longDescription": "This parameter shall be a the current ETag of the system. If provided by the client, the service shall reject the request by returning HTTP 428 (Precondition Required) if the provided ETag does not match the current ETag of the system.", + "longDescription": "This parameter shall contain the current ETag of the system. If the client-provided ETag does not match the current ETag of the system, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.", "type": "string" }, "ResourceBlock": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock", "description": "The Resource Block to add to the system.", - "longDescription": "This parameter shall be a link to the specified Resource Block to add to the system.", + "longDescription": "This parameter shall contain a link to the specified Resource Block to add to the system.", "requiredParameter": true }, "ResourceBlockETag": { "description": "The current ETag of the Resource Block to add to the system.", - "longDescription": "This parameter shall be a the current ETag of the Resource Block to add to the system. If provided by the client, the service shall reject the request by returning HTTP 428 (Precondition Required) if the provided ETag does not match the current ETag of the Resource Block specified by the ResourceBlock parameter.", + "longDescription": "This parameter shall contain the current ETag of the Resource Block to add to the system. If the client-provided ETag does not match the current ETag of the Resource Block that the ResourceBlock parameter specifies, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.", "type": "string" } }, "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", @@ -82,7 +82,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -95,10 +95,10 @@ }, "Boot": { "additionalProperties": false, - "description": "This object contains the boot information for the current resource.", - "longDescription": "This type shall contain properties which describe boot information for a system.", + "description": "The boot information for this Resource.", + "longDescription": "This type shall contain properties that describe boot information for a system.", "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", @@ -113,7 +113,7 @@ }, "properties": { "AliasBootOrder": { - "description": "Ordered array of boot source aliases representing the persistent Boot Order associated with this computer system.", + "description": "Ordered array of boot source aliases representing the persistent boot order associated with this computer system.", "items": { "anyOf": [ { @@ -124,14 +124,14 @@ } ] }, - "longDescription": "The value of this property shall be an ordered array of boot source aliases (of type BootSource) representing the persistent Boot Order of this computer system.", + "longDescription": "This property shall contain an ordered array of boot source aliases of the BootSource type that represents the persistent boot order of this computer system.", "readonly": false, "type": "array", "versionAdded": "v1_6_0" }, "BootNext": { - "description": "This property is the BootOptionReference of the Boot Option to perform a one time boot from when BootSourceOverrideTarget is UefiBootNext.", - "longDescription": "The value of this property shall be the BootOptionReference of the UEFI Boot Option for one time boot, as defined by the UEFI Specification. The valid values for this property are specified in the values of the BootOrder array. BootSourceOverrideEnabled = Continuous is not supported for UEFI BootNext as this setting is defined in UEFI as a one-time boot only.", + "description": "The BootOptionReference of the Boot Option to perform a one-time boot from when BootSourceOverrideTarget is `UefiBootNext`.", + "longDescription": "This property shall contain the BootOptionReference of the UEFI boot option for one time boot, as defined by the UEFI Specification. The valid values for this property are specified in the values of the BootOrder array. BootSourceOverrideEnabled set to `Continuous` is not supported for UEFI BootNext because this setting is defined in UEFI as a one-time boot only.", "readonly": false, "type": [ "string", @@ -141,20 +141,20 @@ }, "BootOptions": { "$ref": "http://redfish.dmtf.org/schemas/v1/BootOptionCollection.json#/definitions/BootOptionCollection", - "description": "A reference to the collection of the UEFI Boot Options associated with this Computer System.", - "longDescription": "The value of this property shall be a link to a collection of type BootOptionCollection.", + "description": "The link to the collection of the UEFI boot options associated with this computer system.", + "longDescription": "This property shall contain a link to a Resource Collection of type BootOptionCollection.", "readonly": true, "versionAdded": "v1_5_0" }, "BootOrder": { - "description": "Ordered array of BootOptionReference strings representing the persistent Boot Order associated with this computer system.", + "description": "An array of BootOptionReference strings that represent the persistent boot order for with this computer system.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be an ordered array of BootOptionReference strings representing the persistent Boot Order of this computer system. For UEFI systems, this is the UEFI BootOrder as defined by the UEFI Specification.", + "longDescription": "This property shall contain an array of BootOptionReference strings that represent the persistent boot order for this computer system. For UEFI systems, this is the UEFI Specification-defined UEFI BootOrder.", "readonly": false, "type": "array", "versionAdded": "v1_5_0" @@ -168,8 +168,8 @@ "type": "null" } ], - "description": "Choice of which boot order property to use when specifying the boot order.", - "longDescription": "The value of this property shall indicate which boot order property the system uses when specifying the persistent boot order.", + "description": "The name of the boot order property that the system uses for the persistent boot order.", + "longDescription": "This property shall indicate which boot order property the system uses for the persistent boot order.", "readonly": false, "versionAdded": "v1_6_0" }, @@ -182,8 +182,8 @@ "type": "null" } ], - "description": "Describes the state of the Boot Source Override feature.", - "longDescription": "The value of this property shall be Once if this is a one time boot override and Continuous if this selection should remain active until cancelled. If the property value is set to Once, the value will be reset back to Disabled after the BootSourceOverrideTarget actions have been completed. Changes to this property do not alter the BIOS persistent boot order configuration.", + "description": "The state of the boot source override feature.", + "longDescription": "This property shall contain `Once` for a one-time boot override, and `Continuous` for a remain-active-until-cancelled override. The `Continuous` value is not supported for this property for UEFI boot source override because UEFI supports one-time boot only. If set to `Once`, the value is reset to `Disabled` after the BootSourceOverrideTarget actions have completed successfully. Changes to this property do not alter the BIOS persistent boot order configuration.", "readonly": false }, "BootSourceOverrideMode": { @@ -195,8 +195,8 @@ "type": "null" } ], - "description": "The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from.", - "longDescription": "The value of this property shall be Legacy for non-UEFI BIOS boot or UEFI for UEFI boot from boot source specified in BootSourceOverrideTarget property.", + "description": "The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.", + "longDescription": "This property shall contain the BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.", "readonly": false, "versionAdded": "v1_1_0" }, @@ -209,13 +209,20 @@ "type": "null" } ], - "description": "The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.", - "longDescription": "The value of this property shall contain the source to boot the system from, overriding the normal boot order. The valid values for this property are specified through the Redfish.AllowableValues annotation. Pxe indicates to PXE boot from the primary NIC; Floppy, Cd, Usb, Hdd indicates to boot from their devices respectively. BiosSetup indicates to boot into the native BIOS screen setup. Utilities and Diags indicate to boot from the local utilities or diags partitions. UefiTarget indicates to boot from the UEFI device path found in UefiTargetBootSourceOverride. UefiBootNext indicates to boot from the UEFI BootOptionReference found in BootNext. Changes to this property do not alter the BIOS persistent boot order configuration.", + "description": "The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled is `true`.", + "longDescription": "This property shall contain the source to boot the system from, overriding the normal boot order. The Redfish.AllowableValues annotation specifies the valid values for this property. `Pxe` indicates to PXE boot from the primary NIC; `Floppy`, `Cd`, `Usb`, and `Hdd` indicate to boot from their devices respectively. `BiosSetup` indicates to boot into the native BIOS screen setup. `Utilities` and `Diags` indicate to boot from the local utilities or diags partitions. `UefiTarget` indicates to boot from the UEFI device path found in UefiTargetBootSourceOverride. `UefiBootNext` indicates to boot from the UEFI BootOptionReference found in BootNext. Changes to this property do not alter the BIOS persistent boot order configuration.", "readonly": false }, + "Certificates": { + "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", + "description": "The link to a collection of certificates used for booting through HTTPS by this computer system.", + "longDescription": "This property shall contain a link to a Resource Collection of type CertificateCollection.", + "readonly": true, + "versionAdded": "v1_7_0" + }, "UefiTargetBootSourceOverride": { - "description": "This property is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget.", - "longDescription": "The value of this property shall be the UEFI device path of the override boot target. The valid values for this property are specified through the Redfish.AllowableValues annotation. BootSourceOverrideEnabled = Continuous is not supported for UEFI Boot Source Override as this setting is defined in UEFI as a one time boot only. Changes to this property do not alter the BIOS persistent boot order configuration.", + "description": "The UEFI device path of the device from which to boot when BootSourceOverrideTarget is `UefiTarget`.", + "longDescription": "This property shall contain the UEFI device path of the override boot target. The Redfish.AllowableValues annotation specifies the values for this property. The `Continuous` value is not supported for the BootSourceOverrideEnabled property for UEFI boot source override because UEFI supports one-time boot only. Changes to this property do not alter the BIOS persistent boot order configuration.", "readonly": false, "type": [ "string", @@ -232,8 +239,8 @@ "AliasBootOrder" ], "enumDescriptions": { - "AliasBootOrder": "The system uses the AliasBootOrder property for specifying persistent boot order.", - "BootOrder": "The system uses the BootOrder property for specifying persistent boot order." + "AliasBootOrder": "The system uses the AliasBootOrder property to specify the persistent boot order.", + "BootOrder": "The system uses the BootOrder property to specify the persistent boot order." }, "type": "string" }, @@ -244,9 +251,9 @@ "Continuous" ], "enumDescriptions": { - "Continuous": "The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled.", - "Disabled": "The system will boot normally.", - "Once": "On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled." + "Continuous": "The system boots to the target specified in the BootSourceOverrideTarget property until this property is `Disabled`.", + "Disabled": "The system boots normally.", + "Once": "On its next boot cycle, the system boots one time to the boot source override target. Then, the BootSourceOverrideEnabled value is reset to `Disabled`." }, "type": "string" }, @@ -256,17 +263,17 @@ "UEFI" ], "enumDescriptions": { - "Legacy": "The system will boot in non-UEFI boot mode to the Boot Source Override Target.", - "UEFI": "The system will boot in UEFI boot mode to the Boot Source Override Target." + "Legacy": "The system boots in non-UEFI boot mode to the boot source override target.", + "UEFI": "The system boots in UEFI boot mode to the boot source override target." }, "type": "string" }, "ComputerSystem": { "additionalProperties": false, - "description": "This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.", - "longDescription": "This resource shall be used to represent resources that represent a computing system in the Redfish specification.", + "description": "The ComputerSystem schema represents a computer or system instance and the software-visible Resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those Resources or subsystems are also linked through this Resource.", + "longDescription": "This Resource shall represent a computing system in the Redfish Specification.", "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", @@ -281,25 +288,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AssetTag": { - "description": "The user definable tag that can be used to track this computer system for inventory or other client purposes.", - "longDescription": "The value of this property shall contain the value of the asset tag of the system.", + "description": "The user-definable tag that can track this computer system for inventory or other client purposes.", + "longDescription": "This property shall contain the system asset tag value.", "readonly": false, "type": [ "string", @@ -308,14 +315,14 @@ }, "Bios": { "$ref": "http://redfish.dmtf.org/schemas/v1/Bios.json#/definitions/Bios", - "description": "A reference to the BIOS settings associated with this system.", - "longDescription": "The value of this property shall be a link to a resource of type Bios that lists the BIOS settings for this system.", + "description": "The link to the BIOS settings associated with this system.", + "longDescription": "This property shall contain a link to a Resource of type Bios that lists the BIOS settings for this system.", "readonly": true, "versionAdded": "v1_1_0" }, "BiosVersion": { "description": "The version of the system BIOS or primary system firmware.", - "longDescription": "The value of this property shall be the version string of the currently installed and running BIOS (for x86 systems). For other systems, the value may contain a version string representing the primary system firmware.", + "longDescription": "This property shall contain the version string of the currently installed and running BIOS for x86 systems. For other systems, the property may contain a version string that represents the primary system firmware.", "readonly": true, "type": [ "string", @@ -324,8 +331,8 @@ }, "Boot": { "$ref": "#/definitions/Boot", - "description": "Information about the boot settings for this system.", - "longDescription": "This object shall contain properties which describe boot information for the current resource." + "description": "The boot settings for this system.", + "longDescription": "This property shall contain the boot settings for this system." }, "Description": { "anyOf": [ @@ -340,13 +347,13 @@ }, "EthernetInterfaces": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection", - "description": "A reference to the collection of Ethernet interfaces associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type EthernetInterfaceCollection.", + "description": "The link to the collection of Ethernet interfaces associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type EthernetInterfaceCollection.", "readonly": true }, "HostName": { - "description": "The DNS Host Name, without any domain information.", - "longDescription": "The value of this property shall be the host name for this system, as reported by the operating system or hypervisor. This value is typically provided to the Manager by a service running in the host operating system.", + "description": "The DNS host name, without any domain information.", + "longDescription": "This property shall contain the host name for this system, as reported by the operating system or hypervisor. A service running in the host operating system typically reports this value to the manager.", "readonly": false, "type": [ "string", @@ -355,22 +362,22 @@ }, "HostWatchdogTimer": { "$ref": "#/definitions/WatchdogTimer", - "description": "This object describes the Host Watchdog Timer functionality for this system.", - "longDescription": "This object shall contain properties which describe the host watchdog timer functionality for this ComputerSystem.", + "description": "The host watchdog timer functionality for this system.", + "longDescription": "This object shall contain properties that describe the host watchdog timer functionality for this ComputerSystem.", "versionAdded": "v1_5_0" }, "HostedServices": { "$ref": "#/definitions/HostedServices", "description": "The services that this computer system supports.", - "longDescription": "The values of this collection shall describe services supported by this computer system.", + "longDescription": "This property shall describe services that this computer system supports.", "versionAdded": "v1_2_0" }, "HostingRoles": { - "description": "The hosing roles that this computer system supports.", + "description": "The hosting roles that this computer system supports.", "items": { "$ref": "#/definitions/HostingRole" }, - "longDescription": "The values of this collection shall be the hosting roles supported by this computer system.", + "longDescription": "This property shall contain the hosting roles that this computer system supports.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" @@ -388,24 +395,24 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify the system.", - "longDescription": "The value of this property shall contain the indicator light state for the indicator light associated with this system.", + "description": "The state of the indicator LED, which identifies the system.", + "longDescription": "This property shall contain the state of the indicator light, which identifies this system.", "readonly": false }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "LogServices": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection", - "description": "A reference to the collection of Log Services associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type LogServiceCollection.", + "description": "The link to the collection of Log Services associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type LogServiceCollection.", "readonly": true }, "Manufacturer": { "description": "The manufacturer or OEM of this system.", - "longDescription": "The value of this property shall contain a value that represents the manufacturer of the system.", + "longDescription": "This property shall contain a value that represents the manufacturer of the system.", "readonly": true, "type": [ "string", @@ -414,33 +421,26 @@ }, "Memory": { "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryCollection.json#/definitions/MemoryCollection", - "description": "A reference to the collection of Memory associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type MemoryCollection.", + "description": "The link to the collection of memory associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type MemoryCollection.", "readonly": true, "versionAdded": "v1_1_0" }, "MemoryDomains": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryDomainCollection.json#/definitions/MemoryDomainCollection" - }, - { - "type": "null" - } - ], - "description": "A reference to the collection of Memory Domains associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type MemoryDomainCollection.", + "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryDomainCollection.json#/definitions/MemoryDomainCollection", + "description": "The link to the collection of memory domains associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type MemoryDomainCollection.", "readonly": true, "versionAdded": "v1_2_0" }, "MemorySummary": { "$ref": "#/definitions/MemorySummary", - "description": "This object describes the central memory of the system in general detail.", - "longDescription": "This object shall contain properties which describe the central memory for the current resource." + "description": "The central memory of the system in general detail.", + "longDescription": "This property shall describe the central memory for this Resource." }, "Model": { "description": "The product name for this system, without the manufacturer name.", - "longDescription": "The value of this property shall contain the information about how the manufacturer references this system. This is typically the product name, without the manufacturer name.", + "longDescription": "This property shall describe how the manufacturer refers to this system. Typically, this value is the product name for this system without the manufacturer name.", "readonly": true, "type": [ "string", @@ -453,45 +453,45 @@ }, "NetworkInterfaces": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkInterfaceCollection.json#/definitions/NetworkInterfaceCollection", - "description": "A reference to the collection of Network Interfaces associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type NetworkInterfaceCollection.", + "description": "The link to the collection of Network Interfaces associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type NetworkInterfaceCollection.", "readonly": true, "versionAdded": "v1_3_0" }, "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." }, "PCIeDevices": { - "description": "A reference to a collection of PCIe Devices used by this computer system.", + "description": "The link to a collection of PCIe devices that this computer system uses.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" }, - "longDescription": "The value of this property shall be an array of references of type PCIeDevice.", + "longDescription": "This property shall contain an array of links of the PCIeDevice type.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "PCIeDevices@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "PCIeFunctions": { - "description": "A reference to a collection of PCIe Functions used by this computer system.", + "description": "The link to a collection of PCIe functions that this computer system uses.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction" }, - "longDescription": "The value of this property shall be an array of references of type PCIeFunction.", + "longDescription": "This property shall contain an array of links of the PCIeFunction type.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "PCIeFunctions@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "PartNumber": { "description": "The part number for this system.", - "longDescription": "The value of this property shall contain the part number for the system as defined by the manufacturer.", + "longDescription": "This property shall contain the manufacturer-defined part number for the system.", "readonly": true, "type": [ "string", @@ -501,7 +501,7 @@ "PowerRestorePolicy": { "$ref": "#/definitions/PowerRestorePolicyTypes", "description": "The desired power state of the system when power is restored after a power loss.", - "longDescription": "This property shall indicate the desired PowerState of the system when power is applied to the system. A value of 'LastState' shall return the system to the PowerState it was in when power was lost.", + "longDescription": "This property shall indicate the desired PowerState of the system when power is applied to the system. The `LastState` value shall return the system to the PowerState it was in when power was lost.", "readonly": false, "versionAdded": "v1_6_0" }, @@ -514,38 +514,38 @@ "type": "null" } ], - "description": "This is the current power state of the system.", - "longDescription": "The value of this property shall contain the power state of the system.", + "description": "The current power state of the system.", + "longDescription": "This property shall contain the power state of the system.", "readonly": true }, "ProcessorSummary": { "$ref": "#/definitions/ProcessorSummary", - "description": "This object describes the central processors of the system in general detail.", - "longDescription": "This object shall contain properties which describe the central processors for the current resource." + "description": "The central processors of the system in general detail.", + "longDescription": "This property shall describe the central processors for this Resource." }, "Processors": { "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorCollection.json#/definitions/ProcessorCollection", - "description": "A reference to the collection of Processors associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type ProcessorCollection.", + "description": "The link to the collection of processors associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type ProcessorCollection.", "readonly": true }, "Redundancy": { "autoExpand": true, - "description": "A reference to a collection of Redundancy entities that each name a set of computer systems that provide redundancy for this ComputerSystem.", + "description": "The link to a collection of redundancy entities. Each entity specifies a kind and level of redundancy and a collection, or redundancy set, of other computer systems that provide the specified redundancy to this computer system.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "If present, each entry shall reference a redundancy entity that specifies a kind and level of redundancy and a collection (RedundancySet) of other ComputerSystems that provide the specified redundancy to this ComputerSystem.", + "longDescription": "This property shall contain a set of redundancy entities. Each entity specifies a kind and level of redundancy and a collection, or redundancy set, of other computer systems that provide the specified redundancy to this computer system.", "readonly": true, "type": "array", "versionAdded": "v1_5_0" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SKU": { "description": "The manufacturer SKU for this system.", - "longDescription": "The value of this property shall contain the Stock Keeping Unit (SKU) for the system.", + "longDescription": "This property shall contain the SKU for the system.", "readonly": true, "type": [ "string", @@ -554,14 +554,14 @@ }, "SecureBoot": { "$ref": "http://redfish.dmtf.org/schemas/v1/SecureBoot.json#/definitions/SecureBoot", - "description": "A reference to the UEFI SecureBoot resource associated with this system.", - "longDescription": "The value of this property shall be a link to a resource of type SecureBoot.", + "description": "The link to the UEFI Secure Boot associated with this system.", + "longDescription": "This property shall contain a link to a Resource of type SecureBoot.", "readonly": true, "versionAdded": "v1_1_0" }, "SerialNumber": { "description": "The serial number for this system.", - "longDescription": "The value of this property shall contain the serial number for the system.", + "longDescription": "This property shall contain the serial number for the system.", "readonly": true, "type": [ "string", @@ -570,25 +570,25 @@ }, "SimpleStorage": { "$ref": "http://redfish.dmtf.org/schemas/v1/SimpleStorageCollection.json#/definitions/SimpleStorageCollection", - "description": "A reference to the collection of storage devices associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type SimpleStorageCollection.", + "description": "The link to the collection of storage devices associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type SimpleStorageCollection.", "readonly": true }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Storage": { "$ref": "http://redfish.dmtf.org/schemas/v1/StorageCollection.json#/definitions/StorageCollection", - "description": "A reference to the collection of storage devices associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type StorageCollection.", + "description": "The link to the collection of storage devices associated with this system.", + "longDescription": "This property shall contain a link to a Resource Collection of type StorageCollection.", "readonly": true, "versionAdded": "v1_1_0" }, "SubModel": { "description": "The sub-model for this system.", - "longDescription": "The value of this property shall contain the information about the sub-model (or config) of the system. This shall not include the model/product name or the manufacturer name.", + "longDescription": "This property shall contain the information about the sub-model (or config) of the system. This shall not include the model/product name or the manufacturer name.", "readonly": true, "type": [ "string", @@ -598,16 +598,16 @@ }, "SystemType": { "$ref": "#/definitions/SystemType", - "description": "The type of computer system represented by this resource.", - "longDescription": "An enumeration that indicates the kind of system that this resource represents.", + "description": "The type of computer system that this Resource represents.", + "longDescription": "An enumeration that indicates the kind of system that this Resource represents.", "readonly": true }, "TrustedModules": { - "description": "This object describes the array of Trusted Modules in the system.", + "description": "An array of trusted modules in the system.", "items": { "$ref": "#/definitions/TrustedModules" }, - "longDescription": "This object shall contain an array of objects with properties which describe the truted modules for the current resource.", + "longDescription": "This object shall contain an array of objects with properties that describe the trusted modules for this Resource.", "type": "array", "versionAdded": "v1_1_0" }, @@ -620,8 +620,8 @@ "type": "null" } ], - "description": "The universal unique identifier (UUID) for this system.", - "longDescription": "The value of this property shall be used to contain a universal unique identifier number for the system. RFC4122 describes methods that can be used to create the value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID. If the system supports SMBIOS, the value of the property should be formed by following the SMBIOS 2.6+ recommendation for converting the SMBIOS 16-byte UUID structure into the redfish canonical xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx string format so that the property value matches the byte order presented by current OS APIs such as WMI and dmidecode.", + "description": "The UUID for this system.", + "longDescription": "This property shall contain the UUID for the system. RFC4122 describes methods to create this value. The value should be considered to be opaque. Client software should only treat the overall value as a UUID and should not interpret any sub-fields within the UUID. If the system supports SMBIOS, the property value should follow the SMBIOS 2.6 and later recommendation for converting the SMBIOS 16-byte UUID structure into the Redfish canonical `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` string format, so that the property value matches the byte order presented by current OS APIs, such as WMI and dmidecode.", "readonly": true } }, @@ -635,10 +635,10 @@ }, "HostedServices": { "additionalProperties": false, - "description": "This object describes services that may be running or installed on the system.", - "longDescription": "The values of this collection shall describe services supported by a computer system.", + "description": "The services that may be running or installed on the system.", + "longDescription": "This type shall describe services that a computer system 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", @@ -654,14 +654,14 @@ "properties": { "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_2_0" }, "StorageServices": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/HostedStorageServices.json#/definitions/HostedStorageServices", - "description": "A reference to a collection of storage services supported by this computer system.", - "longDescription": "The value of this property shall be a link to a collection of type HostedStorageServices.", + "description": "The link to a collection of storage services that this computer system supports.", + "longDescription": "This property shall contain a link to a Resource Collection of type HostedStorageServices.", "readonly": true, "versionAdded": "v1_2_0" } @@ -690,19 +690,19 @@ "Off" ], "enumDeprecated": { - "Unknown": "This value has been Deprecated in favor of returning null if the state is unknown." + "Unknown": "This value has been deprecated in favor of returning null if the state is unknown." }, "enumDescriptions": { - "Blinking": "The Indicator LED is blinking.", - "Lit": "The Indicator LED is lit.", - "Off": "The Indicator LED is off.", - "Unknown": "The state of the Indicator LED cannot be determined." + "Blinking": "The indicator LED is blinking.", + "Lit": "The indicator LED is lit.", + "Off": "The indicator LED is off.", + "Unknown": "The state of the indicator LED cannot be determined." }, "enumLongDescriptions": { - "Blinking": "This value shall represent the Indicator LED is in a blinking state where the LED is being turned on and off in repetition. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).", - "Lit": "This value shall represent the Indicator LED is in a solid on state. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).", - "Off": "This value shall represent the Indicator LED is in a solid off state. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).", - "Unknown": "This value shall represent the Indicator LED is in an unknown state. The service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request)." + "Blinking": "This value shall represent that the indicator LED is in a blinking state where the LED is being turned on and off in repetition. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.", + "Lit": "This value shall represent that the indicator LED is in a solid on state. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.", + "Off": "This value shall represent that the indicator LED is in a solid off state. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.", + "Unknown": "This value shall represent that the indicator LED is in an unknown state. The Service shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code." }, "enumVersionDeprecated": { "Unknown": "v1_1_0" @@ -731,19 +731,19 @@ "OemMethod" ], "enumDescriptions": { - "BiosSetting": "The TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute.", - "FirmwareUpdate": "The TrustedModule supports switching InterfaceType via a firmware update.", + "BiosSetting": "The TrustedModule supports switching InterfaceType through platform software, such as a BIOS configuration attribute.", + "FirmwareUpdate": "The TrustedModule supports switching InterfaceType through a firmware update.", "None": "The TrustedModule does not support switching the InterfaceType.", - "OemMethod": "The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism." + "OemMethod": "The TrustedModule supports switching InterfaceType through an OEM proprietary mechanism." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -758,109 +758,109 @@ }, "properties": { "Chassis": { - "description": "An array of references to the chassis in which this system is contained.", + "description": "An array of links to the chassis that contains this system.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" }, - "longDescription": "The value of this property shall reference a resource of type Chassis that represents the physical container associated with this resource.", + "longDescription": "This property shall link to a Resource of type Chassis that represents the physical container associated with this Resource.", "readonly": true, "type": "array" }, "Chassis@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ConsumingComputerSystems": { - "description": "An array of references to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.", + "description": "An array of links to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "The value shall be an array of references to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.", + "longDescription": "The value shall be an array of links to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.", "readonly": true, "type": "array", "versionAdded": "v1_5_0" }, "ConsumingComputerSystems@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "CooledBy": { - "description": "An array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans.", + "description": "An array of one or more IDs for Resources that cool this computer system. Normally, the ID is for either a chassis or a specific set of fans.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that powers this computer system.", + "longDescription": "This property shall contain an array of IDs that contain pointers consistent with JSON Pointer syntax to the Resource that powers this computer system.", "readonly": true, "type": "array" }, "CooledBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Endpoints": { - "description": "An array of references to the endpoints that connect to this system.", + "description": "An array of links to the endpoints that connect to this system.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be a reference to the resources that this system is associated with and shall reference a resource of type Endpoint.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this system is associated.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ManagedBy": { - "description": "An array of references to the Managers responsible for this system.", + "description": "An array of links to the managers responsible for this system.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "The value of this property shall reference a resource of type manager that represents the resource with management responsibility for this resource.", + "longDescription": "This property shall link to a Resource of type Manager that represents the Resource with management responsibility for this Resource.", "readonly": true, "type": "array" }, "ManagedBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PoweredBy": { - "description": "An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of Power Supplies.", + "description": "An array of one or more IDs for Resources that power this computer system. Normally, the ID is for either a chassis or a specific set of power supplies.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that powers this computer system.", + "longDescription": "This property shall contain an array of IDs that contain pointers consistent with JSON Pointer syntax to the Resource that powers this computer system.", "readonly": true, "type": "array" }, "PoweredBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ResourceBlocks": { - "description": "An array of references to the Resource Blocks that are used in this Computer System.", + "description": "An array of links to the Resource Blocks that are used in this computer system.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock" }, - "longDescription": "The value of this property shall be an array of references of type ResourceBlock that show the Resource Blocks that are used in this Computer System.", + "longDescription": "This property shall contain an array of links of the ResourceBlock type that show the Resource Blocks that are used in this computer system.", "readonly": false, "type": "array", "versionAdded": "v1_4_0" }, "ResourceBlocks@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SupplyingComputerSystems": { - "description": "An array of references to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.", + "description": "An array of links to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "The value shall be an array of references to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.", + "longDescription": "The value shall be an array of links to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.", "readonly": true, "type": "array", "versionAdded": "v1_5_0" }, "SupplyingComputerSystems@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" @@ -876,16 +876,16 @@ "DIMM": "The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored.", "Hybrid": "The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be mirrored.", "None": "The system does not support DIMM mirroring.", - "System": "The system supports DIMM mirroring at the System level. Individual DIMMs are not paired for mirroring in this mode." + "System": "The system supports DIMM mirroring at the system level. Individual DIMMs are not paired for mirroring in this mode." }, "type": "string" }, "MemorySummary": { "additionalProperties": false, - "description": "This object describes the memory of the system in general detail.", - "longDescription": "This type shall contain properties which describe the central memory for a system.", + "description": "The memory of the system in general detail.", + "longDescription": "This type shall contain properties that describe the central memory for a system.", "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", @@ -908,15 +908,22 @@ "type": "null" } ], - "description": "The ability and type of memory mirroring supported by this system.", - "longDescription": "This property shall contain the ability and type of memory mirring supported by this system.", + "description": "The ability and type of memory mirroring that this computer system supports.", + "longDescription": "This property shall contain the ability and type of memory mirring that this computer system supports.", "readonly": true, "versionAdded": "v1_1_0" }, + "Metrics": { + "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.json#/definitions/MemoryMetrics", + "description": "The link to the metrics associated with all memory in this system.", + "longDescription": "This property shall contain a link to the metrics associated with all memory in this system.", + "readonly": true, + "versionAdded": "v1_8_0" + }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "TotalSystemMemoryGiB": { "description": "The total configured operating system-accessible memory (RAM), measured in GiB.", @@ -946,10 +953,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", @@ -973,9 +980,9 @@ "LastState" ], "enumDescriptions": { - "AlwaysOff": "The system will always remain powered off when power is applied.", - "AlwaysOn": "The system will always power on when power is applied.", - "LastState": "The system will return to its last power state (on or off) when power is applied." + "AlwaysOff": "The system always remains powered off when power is applied.", + "AlwaysOn": "The system always powers on when power is applied.", + "LastState": "The system returns to its last on or off power state when power is applied." }, "type": "string" }, @@ -989,17 +996,17 @@ "enumDescriptions": { "Off": "The system is powered off, although some components may continue to have AUX power such as management controller.", "On": "The system is powered on.", - "PoweringOff": "A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process.", - "PoweringOn": "A temporary state between Off and On. This temporary state can be very short." + "PoweringOff": "A temporary state between on and off. The power off action can take time while the OS is in the shutdown process.", + "PoweringOn": "A temporary state between off and on. This temporary state can be very short." }, "type": "string" }, "ProcessorSummary": { "additionalProperties": false, - "description": "This object describes the central processors of the system in general detail.", - "longDescription": "This type shall contain properties which describe the central processors for a system.", + "description": "The central processors of the system in general detail.", + "longDescription": "This type shall contain properties that describe the central processors for a system.", "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", @@ -1034,6 +1041,13 @@ ], "versionAdded": "v1_5_0" }, + "Metrics": { + "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.json#/definitions/ProcessorMetrics", + "description": "The link to the metrics associated with all processors in this system.", + "longDescription": "This property shall contain a link to the metrics associated with all processors in this system.", + "readonly": true, + "versionAdded": "v1_7_0" + }, "Model": { "description": "The processor model for the primary or majority of processors in this system.", "longDescription": "This property shall contain the processor model for the central processors in the system, per the description in the Processor Information - Processor Family section of the SMBIOS Specification DSP0134 2.8 or later.", @@ -1045,36 +1059,36 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "type": "object" }, "RemoveResourceBlock": { "additionalProperties": false, - "description": "This action is used to remove a Resource Block from a system.", - "longDescription": "This action shall be used to remove a Resource Block from a system.", + "description": "This action removes a Resource Block from a system.", + "longDescription": "This action shall remove a Resource Block from a system.", "parameters": { "ComputerSystemETag": { "description": "The current ETag of the system.", - "longDescription": "This parameter shall be a the current ETag of the system. If provided by the client, the service shall reject the request by returning HTTP 428 (Precondition Required) if the provided ETag does not match the current ETag of the system.", + "longDescription": "This parameter shall contain the current ETag of the system. If the client-provided ETag does not match the current ETag of the system, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.", "type": "string" }, "ResourceBlock": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock", "description": "The Resource Block to remove from the system.", - "longDescription": "This parameter shall be a link to the specified Resource Block to remove from the system.", + "longDescription": "This parameter shall contain a link to the specified Resource Block to remove from the system.", "requiredParameter": true }, "ResourceBlockETag": { "description": "The current ETag of the Resource Block to remove from the system.", - "longDescription": "This parameter shall be a the current ETag of the Resource Block to remove from the system. If provided by the client, the service shall reject the request by returning HTTP 428 (Precondition Required) if the provided ETag does not match the current ETag of the Resource Block specified by the ResourceBlock parameter.", + "longDescription": "This parameter shall contain the current ETag of the Resource Block to remove from the system. If the client-provided ETag does not match the current ETag of the Resource Block that the ResourceBlock parameter specifies, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.", "type": "string" } }, "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", @@ -1090,7 +1104,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1103,17 +1117,17 @@ }, "Reset": { "additionalProperties": false, - "description": "This action is used to reset the system.", - "longDescription": "This action shall perform a reset of the ComputerSystem. For systems which implement ACPI Power Button functionality, the PushPowerButton value shall perform or emulate an ACPI Power Button push. The ForceOff value shall remove power from the system or perform an ACPI Power Button Override (commonly known as a 4-second hold of the Power Button). The ForceRestart value shall perform a ForceOff action followed by a On action.", + "description": "This action resets the system.", + "longDescription": "This action shall reset the system represented by the Resource. For systems that implement ACPI Power Button functionality, the PushPowerButton value shall perform or emulate an ACPI Power Button Push. The ForceOff value shall remove power from the system or perform an ACPI Power Button Override, commonly known as a four-second hold of the Power Button. The ForceRestart value shall perform a ForceOff action, followed by an On action.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", - "description": "The type of reset to be performed.", - "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset." + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation-specific default reset." } }, "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", @@ -1129,7 +1143,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1141,11 +1155,11 @@ }, "SetDefaultBootOrder": { "additionalProperties": false, - "description": "This action is used to set the Boot Order to the default settings.", - "longDescription": "This action shall perform a set the BootOrder to the default values.", + "description": "This action sets the BootOrder to the default settings.", + "longDescription": "This action shall set the BootOrder array to the default settings.", "parameters": {}, "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", @@ -1161,7 +1175,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1182,7 +1196,7 @@ "Composed" ], "enumDescriptions": { - "Composed": "A computer system that has been created by binding resource blocks together.", + "Composed": "A computer system constructed by binding Resource Blocks together.", "OS": "An operating system instance.", "Physical": "A computer system.", "PhysicallyPartitioned": "A hardware-based partition of a computer system.", @@ -1190,12 +1204,12 @@ "VirtuallyPartitioned": "A virtual or software-based partition of a computer system." }, "enumLongDescriptions": { - "Composed": "A SystemType of Composed is typically used when representating a single system constructed from disaggregated resource via the Redfish Composition service.", - "OS": "A SystemType of OS is typically used when representating an OS or hypervisor view of the system.", - "Physical": "A SystemType of Physical is typically used when representating the hardware aspects of a system such as is done by a management controller.", - "PhysicallyPartitioned": "A SystemType of PhysicallyPartition is typically used when representating a single system constructed from one or more physical systems via a firmware or hardware-based service.", - "Virtual": "A SystemType of Virtual is typically used when representating a system that is actually a virtual machine instance.", - "VirtuallyPartitioned": "A SystemType of VirtuallyPartition is typically used when representating a single system constructed from one or more virtual systems via a software-based service." + "Composed": "A SystemType of Composed typically represents a single system constructed from disaggregated Resources through the Redfish Composition Service.", + "OS": "A SystemType of OS typically represents an OS or hypervisor view of the system.", + "Physical": "A SystemType of Physical typically represents the hardware aspects of a system, such as a management controller.", + "PhysicallyPartitioned": "A SystemType of PhysicallyPartition typically represents a single system constructed from one or more physical systems through a firmware or hardware-based service.", + "Virtual": "A SystemType of Virtual typically represents a system that is actually a virtual machine instance.", + "VirtuallyPartitioned": "A SystemType of VirtuallyPartition typically represents a single system constructed from one or more virtual systems through a software-based service." }, "enumVersionAdded": { "Composed": "v1_4_0" @@ -1204,10 +1218,10 @@ }, "TrustedModules": { "additionalProperties": false, - "description": "This object describes the inventory of a Trusted Modules installed in the system.", - "longDescription": "This type shall describe a truted module for a system.", + "description": "The Trusted Module installed in the system.", + "longDescription": "This type shall describe a Trusted Module for a system.", "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", @@ -1232,7 +1246,7 @@ "versionAdded": "v1_1_0" }, "FirmwareVersion2": { - "description": "The 2nd firmware version of this Trusted Module, if applicable.", + "description": "The second firmware version of this Trusted Module, if applicable.", "longDescription": "This property shall contain the 2nd firmware version, if applicable, as defined by the manufacturer for the Trusted Module.", "readonly": true, "type": [ @@ -1250,7 +1264,7 @@ "type": "null" } ], - "description": "This property indicates the interface type of the Trusted Module.", + "description": "The interface type of the Trusted Module.", "longDescription": "This property shall contain the interface type of the installed Trusted Module.", "readonly": true, "versionAdded": "v1_1_0" @@ -1264,28 +1278,28 @@ "type": "null" } ], - "description": "The Interface Type selection supported by this Trusted Module.", - "longDescription": "This property shall contain the Interface Type Selection method (for example to switch between TPM1_2 and TPM2_0) that is supported by this TrustedModule.", + "description": "The interface type selection supported by this Trusted Module.", + "longDescription": "This property shall contain the interface type Selection method (for example to switch between TPM1_2 and TPM2_0) that is supported by this TrustedModule.", "readonly": true, "versionAdded": "v1_3_0" }, "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_1_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource.", "versionAdded": "v1_1_0" } }, "type": "object" }, "WatchdogTimeoutActions": { - "description": "The enumerations of WatchdogTimeoutActions specify the choice of action to take when the Host Watchdog Timer reaches its timeout value.", + "description": "The enumerations of WatchdogTimeoutActions specify the choice of action to take when the host watchdog timer reaches its timeout value.", "enum": [ "None", "ResetSystem", @@ -1304,10 +1318,10 @@ }, "WatchdogTimer": { "additionalProperties": false, - "description": "This type describes the Host Watchdog Timer functionality for this system.", - "longDescription": "This type shall contain properties which describe the host watchdog timer functionality for this ComputerSystem.", + "description": "This type describes the host watchdog timer functionality for this system.", + "longDescription": "This type shall contain properties that describe the host watchdog timer functionality for this ComputerSystem.", "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", @@ -1322,8 +1336,8 @@ }, "properties": { "FunctionEnabled": { - "description": "This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function.", - "longDescription": "The value of this property shall indicate whether the host watchdog timer functionality has been enabled or not. This property indicates only that the functionality is enabled or disabled by the user, and updates to this property shall not initiate a watchdog timer countdown.", + "description": "An indication of whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer.", + "longDescription": "This property shall indicate whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer.", "readonly": false, "type": [ "boolean", @@ -1333,14 +1347,14 @@ }, "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_5_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource.", "versionAdded": "v1_5_0" }, "TimeoutAction": { @@ -1352,8 +1366,8 @@ "type": "null" } ], - "description": "This property indicates the action to perform when the Watchdog Timer reaches its timeout value.", - "longDescription": "This property shall contain the action to perform upon the expiration of the Watchdog Timer.", + "description": "The action to perform when the watchdog timer reaches its timeout value.", + "longDescription": "This property shall contain the action to perform when the watchdog timer reaches its timeout value.", "readonly": false, "versionAdded": "v1_5_0" }, @@ -1366,8 +1380,8 @@ "type": "null" } ], - "description": "This property indicates the action to perform when the Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.", - "longDescription": "This property shall contain the action to perform prior to the expiration of the Watchdog Timer. This action typically occurs 3-10 seconds prior to the timeout value, but the exact timing is dependent on the implementation.", + "description": "The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.", + "longDescription": "This property shall contain the action to perform before the watchdog timer expires. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.", "readonly": false, "versionAdded": "v1_5_0" } @@ -1379,7 +1393,7 @@ "type": "object" }, "WatchdogWarningActions": { - "description": "The enumerations of WatchdogWarningActions specify the choice of action to take when the Host Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.", + "description": "The enumerations of WatchdogWarningActions specify the choice of action to take when the host watchdog timer is close (typically 3-10 seconds) to reaching its timeout value.", "enum": [ "None", "DiagnosticInterrupt", @@ -1400,6 +1414,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#ComputerSystem.v1_6_0.ComputerSystem" + "release": "2019.2", + "title": "#ComputerSystem.v1_8_0.ComputerSystem" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Drive/Drive.json b/static/redfish/v1/JsonSchemas/Drive/Drive.json index 6175bc3731..a3fb11c30b 100644 --- a/static/redfish/v1/JsonSchemas/Drive/Drive.json +++ b/static/redfish/v1/JsonSchemas/Drive/Drive.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Drive.v1_5_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Drive.v1_7_0.json", "$ref": "#/definitions/Drive", "$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", @@ -23,23 +23,26 @@ } }, "properties": { + "#Drive.Reset": { + "$ref": "#/definitions/Reset" + }, "#Drive.SecureErase": { "$ref": "#/definitions/SecureErase" }, "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." } }, "type": "object" }, "Drive": { "additionalProperties": false, - "description": "The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.", - "longDescription": "This resource shall be used to represent a disk drive or other physical storage medium for a Redfish implementation.", + "description": "The Drive schema represents a single physical drive for a system, including links to associated volumes.", + "longDescription": "This Resource shall represent a drive or other physical storage medium 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", @@ -54,32 +57,32 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this drive.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to the assembly associated with this drive.", + "longDescription": "This property shall contain a link to a Resource of type Assembly.", "readonly": true, "versionAdded": "v1_3_0" }, "AssetTag": { - "description": "The user assigned asset tag for this drive.", - "longDescription": "The value of this property shall be an identifying string used to track the drive for inventory purposes.", + "description": "The user-assigned asset tag for this drive.", + "longDescription": "This property shall track the drive for inventory purposes.", "readonly": false, "type": [ "string", @@ -87,8 +90,8 @@ ] }, "BlockSizeBytes": { - "description": "The size of the smallest addressible unit (Block) of this drive in bytes.", - "longDescription": "This property shall contain size of the smallest addressible unit of the associated drive.", + "description": "The size, in bytes, of the smallest addressable unit, or block.", + "longDescription": "This property shall contain size of the smallest addressable unit of the associated drive.", "readonly": true, "type": [ "integer", @@ -97,8 +100,8 @@ "units": "By" }, "CapableSpeedGbs": { - "description": "The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second.", - "longDescription": "This property shall contain fastest capable bus speed of the associated drive.", + "description": "The speed, in gigabit per second (Gbit/s), at which this drive can communicate to a storage controller in ideal conditions.", + "longDescription": "This property shall contain fastest capable bus speed, in gigabit per second (Gbit/s), of the associated drive.", "readonly": true, "type": [ "number", @@ -107,8 +110,8 @@ "units": "Gbit/s" }, "CapacityBytes": { - "description": "The size in bytes of this Drive.", - "longDescription": "This property shall contain the raw size in bytes of the associated drive.", + "description": "The size, in bytes, of this drive.", + "longDescription": "This property shall contain the raw size, in bytes, of the associated drive.", "readonly": true, "type": [ "integer", @@ -136,7 +139,7 @@ "type": "null" } ], - "description": "The encryption abilities of this drive.", + "description": "The encryption ability of this drive.", "longDescription": "This property shall contain the encryption ability for the associated drive.", "readonly": true }, @@ -149,13 +152,13 @@ "type": "null" } ], - "description": "The status of the encrytion of this drive.", - "longDescription": "This property shall contain the encrytion status for the associated drive.", + "description": "The status of the encryption of this drive.", + "longDescription": "This property shall contain the encryption status for the associated drive.", "readonly": true }, "FailurePredicted": { - "description": "Is this drive currently predicting a failure in the near future.", - "longDescription": "This property shall contain failure information as defined by the manufacturer for the associated drive.", + "description": "An indication of whether this drive currently predicts a failure in the near future.", + "longDescription": "This property shall indicate whether this drive currently predicts a manufacturer-defined failure.", "readonly": true, "type": [ "boolean", @@ -171,8 +174,8 @@ "type": "null" } ], - "description": "The replacement mode for the hotspare drive.", - "longDescription": "This property shall specify if a commissioned hotspare will continue to serve as a hotspare once the failed drive is replaced.", + "description": "The replacement mode for the hot spare drive.", + "longDescription": "This property shall indicate whether a commissioned hot spare continues to serve as a hot spare after the failed drive is replaced.", "readonly": false, "versionAdded": "v1_5_0" }, @@ -185,8 +188,8 @@ "type": "null" } ], - "description": "The type of hotspare this drive is currently serving as.", - "longDescription": "This property shall contain the hot spare type for the associated drive. If the drive is currently serving as a hot spare its Status.State field shall be 'StandbySpare' and 'Enabled' when it is being used as part of a Volume.", + "description": "The type of hot spare that this drive currently serves as.", + "longDescription": "This property shall contain the hot spare type for the associated drive. If the drive currently serves as a hot spare, its Status.State field shall be 'StandbySpare' and 'Enabled' when it is part of a volume.", "readonly": true }, "Id": { @@ -194,7 +197,7 @@ "readonly": true }, "Identifiers": { - "description": "The Durable names for the drive.", + "description": "The durable names for the drive.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" }, @@ -210,26 +213,28 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify the drive.", - "longDescription": "This value of this property shall contain the indicator light state for the indicator light associated with this drive.", + "description": "The state of the indicator LED, that identifies the drive.", + "longDescription": "This property shall contain the state for the indicator light associated with this drive.", "readonly": false }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Location": { - "description": "The Location of the drive.", + "deprecated": "This property has been deprecated in favor of the singular property PhysicalLocation found in Drive.v1_4_0.", + "description": "The location of the drive.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location" }, "longDescription": "This property shall contain location information of the associated drive.", - "type": "array" + "type": "array", + "versionDeprecated": "v1_4_0" }, "Manufacturer": { - "description": "This is the manufacturer of this drive.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the drive. This organization might be the entity from whom the drive is purchased, but this is not necessarily true.", + "description": "The manufacturer of this drive.", + "longDescription": "This property shall contain the name of the organization responsible for producing the drive. This organization might be the entity from whom the drive is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -250,8 +255,8 @@ "readonly": true }, "Model": { - "description": "This is the model number for the drive.", - "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the drive.", + "description": "The model number for the drive.", + "longDescription": "This property shall contain the name by which the manufacturer generally refers to the drive.", "readonly": true, "type": [ "string", @@ -263,8 +268,8 @@ "readonly": true }, "NegotiatedSpeedGbs": { - "description": "The speed which this drive is currently communicating to the storage controller in Gigabits per second.", - "longDescription": "This property shall contain current bus speed of the associated drive.", + "description": "The speed, in gigabit per second (Gbit/s), at which this drive currently communicates to the storage controller.", + "longDescription": "This property shall contain current bus speed, in gigabit per second (Gbit/s), of the associated drive.", "readonly": true, "type": [ "number", @@ -274,8 +279,8 @@ }, "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." }, "Operations": { "description": "The operations currently running on the Drive.", @@ -288,7 +293,7 @@ }, "PartNumber": { "description": "The part number for this drive.", - "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the drive.", + "longDescription": "This property shall contain the part number assigned by the organization that is responsible for producing or manufacturing the drive.", "readonly": true, "type": [ "string", @@ -297,13 +302,13 @@ }, "PhysicalLocation": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the drive.", + "description": "The location of the drive.", "longDescription": "This property shall contain location information of the associated drive.", "versionAdded": "v1_4_0" }, "PredictedMediaLifeLeftPercent": { - "description": "The percentage of reads and writes that are predicted to still be available for the media.", - "longDescription": "This property shall contain an indicator of the percentage of life remaining in the Drive's media.", + "description": "The percentage of reads and writes that are predicted to be available for the media.", + "longDescription": "This property shall contain an indicator of the percentage of life remaining in the drive's media.", "readonly": true, "type": [ "number", @@ -320,13 +325,13 @@ "type": "null" } ], - "description": "The protocol this drive is using to communicate to the storage controller.", - "longDescription": "This property shall contain the protocol the associated drive is using to communicate to the storage controller for this system.", + "description": "The protocol that this drive currently uses to communicate to the storage controller.", + "longDescription": "This property shall contain the protocol that the associated drive currently uses to communicate to the storage controller for this system.", "readonly": true }, "Revision": { - "description": "The revision of this Drive. This is typically the firmware/hardware version of the drive.", - "longDescription": "This property shall contain the revision as defined by the manufacturer for the associated drive.", + "description": "The revision of this drive. This is typically the firmware or hardware version of the drive.", + "longDescription": "This property shall contain the manufacturer-defined revision for the associated drive.", "readonly": true, "type": [ "string", @@ -334,8 +339,8 @@ ] }, "RotationSpeedRPM": { - "description": "The rotation speed of this Drive in Revolutions per Minute (RPM).", - "longDescription": "This property shall contain rotation speed of the associated drive.", + "description": "The rotation speed of this drive, in revolutions per minute (RPM).", + "longDescription": "This property shall contain the rotation speed, in revolutions per minute (RPM), of the associated drive.", "readonly": true, "type": [ "number", @@ -344,8 +349,8 @@ "units": "RPM" }, "SKU": { - "description": "This is the SKU for this drive.", - "longDescription": "The value of this property shall be the stock-keeping unit number for this drive.", + "description": "The SKU for this drive.", + "longDescription": "This property shall contain the stock-keeping unit (SKU) number for this drive.", "readonly": true, "type": [ "string", @@ -354,7 +359,7 @@ }, "SerialNumber": { "description": "The serial number for this drive.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the drive.", + "longDescription": "This property shall contain the manufacturer-allocated number that identifies the drive.", "readonly": true, "type": [ "string", @@ -363,8 +368,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "StatusIndicator": { "anyOf": [ @@ -375,9 +380,19 @@ "type": "null" } ], - "description": "The state of the status indicator, used to communicate status information about this drive.", - "longDescription": "The value of this property shall contain the status indicator state for the status indicator associated with this drive. The valid values for this property are specified through the Redfish.AllowableValues annotation.", + "description": "The state of the status indicator, which communicates status information about this drive.", + "longDescription": "This property shall contain the status indicator state for the status indicator associated with this drive. The Redfish.AllowableValues annotation specifies the valid values for this property.", "readonly": false + }, + "WriteCacheEnabled": { + "description": "An indication of whether the drive write cache is enabled.", + "longDescription": "This property shall indicate whether the drive write cache is enabled.", + "readonly": false, + "type": [ + "boolean", + "null" + ], + "versionAdded": "v1_7_0" } }, "required": [ @@ -395,9 +410,9 @@ "Other" ], "enumDescriptions": { - "None": "The drive is not capable of self encryption.", - "Other": "The drive is capable of self encryption through some other means.", - "SelfEncryptingDrive": "The drive is capable of self encryption per the Trusted Computing Group's Self Encrypting Drive Standard." + "None": "The drive is not capable of self-encryption.", + "Other": "The drive is capable of self-encryption through some other means.", + "SelfEncryptingDrive": "The drive is capable of self-encryption per the Trusted Computing Group's Self Encrypting Drive Standard." }, "type": "string" }, @@ -410,14 +425,14 @@ "Unencrypted" ], "enumDeprecated": { - "Unecrypted": "This value has been Deprecated in favor of Unencrypted." + "Unecrypted": "This value has been deprecated in favor of Unencrypted." }, "enumDescriptions": { "Foreign": "The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data.", - "Locked": "The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically.", + "Locked": "The drive is currently encrypted and the data is not accessible to the user. However, the system can unlock the drive automatically.", "Unecrypted": "The drive is not currently encrypted.", "Unencrypted": "The drive is not currently encrypted.", - "Unlocked": "The drive is currently encrypted but the data is accessible to the user unencrypted." + "Unlocked": "The drive is currently encrypted but the data is accessible to the user in unencrypted form." }, "enumVersionAdded": { "Unencrypted": "v1_1_0" @@ -433,8 +448,8 @@ "NonRevertible" ], "enumDescriptions": { - "NonRevertible": "A hotspare drive that is commissioned due to a drive failure will remain as a data drive and will not revert to a hotspare if the failed drive is replaced.", - "Revertible": "A hotspare drive that is commissioned due to a drive failure will revert to being a hotspare once the failed drive is replaced and rebuilt." + "NonRevertible": "The hot spare drive that is commissioned due to a drive failure remains as a data drive and does not revert to a hot spare if the failed drive is replaced.", + "Revertible": "The hot spare drive that is commissioned due to a drive failure reverts to a hot spare after the failed drive is replaced and rebuilt." }, "type": "string" }, @@ -446,19 +461,19 @@ "Dedicated" ], "enumDescriptions": { - "Chassis": "The drive is currently serving as a hotspare for all other drives in the chassis.", - "Dedicated": "The drive is currently serving as a hotspare for a user defined set of drives.", - "Global": "The drive is currently serving as a hotspare for all other drives in the storage system.", - "None": "The drive is not currently a hotspare." + "Chassis": "The drive is currently serving as a hot spare for all other drives in the chassis.", + "Dedicated": "The drive is currently serving as a hot spare for a user-defined set of drives.", + "Global": "The drive is currently serving as a hot spare for all other drives in the storage system.", + "None": "The drive is not currently a hot spare." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -474,40 +489,52 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the Chassis which contains this Drive.", - "longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Drive.", + "description": "The link to the chassis that contains this drive.", + "longDescription": "This property shall contain a link to a Resource of type Chassis that represents the physical container associated with this drive.", "readonly": true, "versionAdded": "v1_2_0" }, "Endpoints": { - "description": "An array of references to the endpoints that connect to this drive.", + "description": "An array of links to the endpoints that connect to this drive.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be a reference to the resources that this drive is associated with and shall reference a resource of type Endpoint.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this drive is associated.", "readonly": true, "type": "array", "versionAdded": "v1_1_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." + }, + "PCIeFunctions": { + "description": "An array of links to the PCIe functions that the drive produces.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction" + }, + "longDescription": "This property shall link to a Resource of type PCIeFunction that represents the PCIe functions associated with this Resource.", + "type": "array", + "versionAdded": "v1_6_0" + }, + "PCIeFunctions@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Volumes": { - "description": "An array of references to the volumes contained in this drive. This will reference Volumes that are either wholly or only partly contained by this drive.", + "description": "An array of links to the volumes that this drive either wholly or only partially contains.", "items": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume" }, - "longDescription": "The value of this property shall be a reference to the resources that this drive is associated with and shall reference a resource of type Volume. This shall include all Volume resources of which this Drive is a member and all Volumes for which this Drive is acting as a spare if the HotspareType is Dedicated.", + "longDescription": "This property shall contain a link to the Resources of the Volume type with which this drive is associated. This property shall include all Volume Resources of which this drive is a member and all volumes for which this drive acts as a spare if the hot spare type is `Dedicated`.", "readonly": true, "type": "array" }, "Volumes@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" @@ -527,10 +554,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", @@ -548,10 +575,10 @@ }, "Operations": { "additionalProperties": false, - "description": "An operation currently running on this resource.", - "longDescription": "This type shall describe a currently running operation on the resource.", + "description": "An operation currently running on this Resource.", + "longDescription": "This type shall describe a currently running operation on the 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", @@ -567,14 +594,14 @@ "properties": { "AssociatedTask": { "$ref": "http://redfish.dmtf.org/schemas/v1/Task.json#/definitions/Task", - "description": "A reference to the task associated with the operation if any.", - "longDescription": "The value of this property shall be a reference to a resource of type Task that represents the task associated with the operation.", + "description": "The link to the task associated with the operation, if any.", + "longDescription": "This property shall contain a link to a Resource of type Task that represents the task associated with the operation.", "readonly": true, "versionAdded": "v1_1_0" }, "OperationName": { "description": "The name of the operation.", - "longDescription": "This property shall be a string of the name of the operation.", + "longDescription": "This property shall contain a string of the name of the operation.", "readonly": true, "type": [ "string", @@ -584,7 +611,7 @@ }, "PercentageComplete": { "description": "The percentage of the operation that has been completed.", - "longDescription": "This property shall be an interger of the percentage of the operation that has been completed.", + "longDescription": "This property shall contain an interger of the percentage of the operation that has been completed.", "readonly": true, "type": [ "integer", @@ -596,13 +623,52 @@ }, "type": "object" }, + "Reset": { + "additionalProperties": false, + "description": "This action resets this drive.", + "longDescription": "This action shall reset this drive.", + "parameters": { + "ResetType": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation specific default reset." + } + }, + "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": { + "target": { + "description": "Link to invoke action", + "format": "uri-reference", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object", + "versionAdded": "v1_7_0" + }, "SecureErase": { "additionalProperties": false, - "description": "This action is used to securely erase the contents of the drive.", - "longDescription": "This action shall perform a secure erase of the drive.", + "description": "This action securely erases the contents of the drive.", + "longDescription": "This action shall securely erase the drive.", "parameters": {}, "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", @@ -618,7 +684,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -640,17 +706,17 @@ ], "enumDescriptions": { "Fail": "The drive has failed.", - "Hotspare": "The drive is marked to be automatically rebuilt and used as a replacement for a failed drive.", - "InACriticalArray": "The array that this drive is a part of is degraded.", - "InAFailedArray": "The array that this drive is a part of is failed.", + "Hotspare": "The drive has been marked to automatically rebuild and replace a failed drive.", + "InACriticalArray": "The array to which this drive belongs has been degraded.", + "InAFailedArray": "The array to which this drive belongs has failed.", "OK": "The drive is OK.", - "PredictiveFailureAnalysis": "The drive is still working but predicted to fail soon.", + "PredictiveFailureAnalysis": "The drive still works but is predicted to fail soon.", "Rebuild": "The drive is being rebuilt." }, "type": "string" } }, "owningEntity": "DMTF", - "release": "2018.2", - "title": "#Drive.v1_5_1.Drive" + "release": "2019.2", + "title": "#Drive.v1_7_0.Drive" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Endpoint/Endpoint.json b/static/redfish/v1/JsonSchemas/Endpoint/Endpoint.json index 876aa4cbf9..6b0783b54a 100644 --- a/static/redfish/v1/JsonSchemas/Endpoint/Endpoint.json +++ b/static/redfish/v1/JsonSchemas/Endpoint/Endpoint.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Endpoint.v1_3_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Endpoint.v1_3_2.json", "$ref": "#/definitions/Endpoint", "$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,26 +24,19 @@ }, "properties": { "Oem": { - "anyOf": [ - { - "$ref": "#/definitions/OemActions" - }, - { - "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." + "$ref": "#/definitions/OemActions", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This property shall contain the available OEM-specific actions for this Resource." } }, "type": "object" }, "ConnectedEntity": { "additionalProperties": false, - "description": "Represents a remote resource that is connected to the network accessible to this endpoint.", - "longDescription": "This type shall represent a remote resource that is connected to a network accessible to an endpoint.", + "description": "Represents a remote Resource that is connected to the network accessible to this endpoint.", + "longDescription": "This type shall represent a remote Resource that is connected to a network accessible to an endpoint.", "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", @@ -58,29 +51,15 @@ }, "properties": { "EntityLink": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource" - }, - { - "type": "null" - } - ], - "description": "A link to the associated entity.", - "longDescription": "This property shall be a reference to an entity of the type specified by the description of the value of the EntityType property.", + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource", + "description": "The link to the associated entity.", + "longDescription": "This property shall contain a link to an entity of the type specified by the description of the EntityType property value.", "readonly": true }, "EntityPciId": { - "anyOf": [ - { - "$ref": "#/definitions/PciId" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/PciId", "description": "The PCI ID of the connected entity.", - "longDescription": "The value of this property shall be the PCI ID of the connected PCIe entity." + "longDescription": "This property shall contain the PCI ID of the connected PCIe entity." }, "EntityRole": { "anyOf": [ @@ -92,7 +71,7 @@ } ], "description": "The role of the connected entity.", - "longDescription": "The value of this property shall indicate if the specified entity is an initiator, target, or both.", + "longDescription": "This property shall indicate if the specified entity is an initiator, target, or both.", "readonly": true }, "EntityType": { @@ -105,57 +84,54 @@ } ], "description": "The type of the connected entity.", - "longDescription": "The value of this property shall indicate if type of connected entity.", + "longDescription": "This property shall indicate if type of connected entity.", "readonly": true }, "Identifiers": { "description": "Identifiers for the remote entity.", "items": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" - }, - { - "type": "null" - } - ] + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" }, - "longDescription": "Identifiers for the remote entity shall be unique in the context of other resources that can reached over the connected network.", + "longDescription": "Identifiers for the remote entity shall be unique in the context of other Resources that can reached over the connected network.", "type": "array" }, "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." }, "PciClassCode": { - "description": "The Class Code, Subclass code, and Programming Interface code of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Class Code, Subclass code, and Programming Interface code of the PCIe device function.", + "deprecated": "This property has been deprecated in favor of the ClassCode property inside the EntityPciId object.", + "description": "The Class Code, Subclass, and Programming Interface code of this PCIe function.", + "longDescription": "This property shall contain the PCI Class Code, Subclass, and Programming Interface of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){3}$", "readonly": true, "type": [ "string", "null" - ] + ], + "versionDeprecated": "v1_2_0" }, "PciFunctionNumber": { + "deprecated": "This property has been deprecated in favor of the FunctionNumber property inside the EntityPciId object.", "description": "The PCI ID of the connected entity.", - "longDescription": "The value of this property shall be the PCI Function Number of the connected PCIe entity.", + "longDescription": "This property shall contain the PCI Function Number of the connected PCIe entity.", "readonly": true, "type": [ "integer", "null" - ] + ], + "versionDeprecated": "v1_2_0" } }, "type": "object" }, "Endpoint": { "additionalProperties": false, - "description": "This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport.", - "longDescription": "This resource shall be used to represent a fabric endpoint for a Redfish implementation.", + "description": "The Endpoint schema contains the properties of an Endpoint Resource that represents the properties of an entity that sends or receives protocol-defined messages over a transport.", + "longDescription": "This Resource contains a fabric endpoint 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", @@ -170,35 +146,28 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "ConnectedEntities": { "description": "All the entities connected to this endpoint.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/ConnectedEntity" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/ConnectedEntity" }, - "longDescription": "This value of this property shall contain all the entities which this endpoint allows access to.", + "longDescription": "This property shall contain all entities to which this endpoint allows access.", "type": "array" }, "Description": { @@ -222,12 +191,12 @@ } ], "description": "The protocol supported by this endpoint.", - "longDescription": "The value of this property shall contain the protocol this endpoint uses to communicate with other endpoints on this fabric.", + "longDescription": "This property shall contain the protocol this endpoint uses to communicate with other endpoints on this fabric.", "readonly": true }, "HostReservationMemoryBytes": { - "description": "The amount of memory in Bytes that the Host should allocate to connect to this endpoint.", - "longDescription": "The value of this property shall be the amount of memory in Bytes that the Host should allocate to connect to this endpoint.", + "description": "The amount of memory in bytes that the host should allocate to connect to this endpoint.", + "longDescription": "This property shall contain the amount of memory in bytes that the host should allocate to connect to this endpoint.", "readonly": true, "type": [ "integer", @@ -236,16 +205,9 @@ "units": "By" }, "IPTransportDetails": { - "description": "This array contains details for each IP transport supported by this endpoint. The array structure can be used to model multiple IP addresses for this endpoint.", + "description": "An array of details for each IP transport supported by this endpoint. The array structure can model multiple IP addresses for this endpoint.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/IPTransportDetails" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/IPTransportDetails" }, "longDescription": "This array shall contain the details for each IP transport supported by this endpoint.", "type": "array", @@ -258,22 +220,15 @@ "Identifiers": { "description": "Identifiers for this endpoint.", "items": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" - }, - { - "type": "null" - } - ] + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" }, "longDescription": "Identifiers for this endpoint shall be unique in the context of other endpoints that can reached over the connected network.", "type": "array" }, "Links": { "$ref": "#/definitions/Links", - "description": "The links object contains the links to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -281,37 +236,30 @@ }, "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." }, "PciId": { - "anyOf": [ - { - "$ref": "#/definitions/PciId" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/PciId", "description": "The PCI ID of the endpoint.", - "longDescription": "The value of this property shall be the PCI ID of the endpoint." + "longDescription": "This property shall contain the PCI ID of the endpoint." }, "Redundancy": { "autoExpand": true, - "description": "Redundancy information for the lower level endpoints supporting this endpoint.", + "description": "Redundancy information for the lower-level endpoints supporting this endpoint.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show how this endpoint is grouped with other endpoints for form redundancy sets.", + "longDescription": "The values of the properties in this array shall show how this endpoint is grouped with other endpoints for form redundancy sets.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -329,9 +277,9 @@ "Both" ], "enumDescriptions": { - "Both": "The entity is acting as both an initiator and a target.", - "Initiator": "The entity is acting as an initiator.", - "Target": "The entity is acting as a target." + "Both": "The entity can both send and receive commands, messages, and other requests to or from other entities on the fabric.", + "Initiator": "The entity sends commands, messages, or other types of requests to other entities on the fabric, but cannot receive commands from other entities.", + "Target": "The entity receives commands, messages, or other types of requests from other entities on the fabric, but cannot send commands to other entities." }, "type": "string" }, @@ -349,16 +297,16 @@ "AccelerationFunction" ], "enumDescriptions": { - "AccelerationFunction": "The entity is an acceleration function realized through a device, such as an FPGA. The EntityLink property (if present) should be a AccelerationFunction.AccelerationFunction entity.", + "AccelerationFunction": "The entity is an acceleration function realized through a device, such as an FPGA. The EntityLink property, if present, should be an AccelerationFunction type.", "Bridge": "The entity is a PCI(e) bridge.", "DisplayController": "The entity is a display controller.", - "Drive": "The entity is a disk drive. The EntityLink property (if present) should be a Drive.Drive entity.", - "NetworkController": "The entity is a network controller. The EntityLink property (if present) should be an EthernetInterface.EthernetInterface entity.", + "Drive": "The entity is a disk drive. The EntityLink property, if present, should be a Drive type.", + "NetworkController": "The entity is a network controller. The EntityLink property, if present, should contain an EthernetInterface type.", "Processor": "The entity is a processor device.", - "RootComplex": "The entity is a PCI(e) root complex. The EntityLink property (if present) should be a ComputerSystem.ComputerSystem entity.", - "StorageExpander": "The entity is a storage expander. The EntityLink property (if present) should be a Chassis.Chassis entity.", - "StorageInitiator": "The entity is a storage initator. The EntityLink property (if present) should be a Storage.StorageController entity.", - "Volume": "The entity is a volume. The EntityLink property (if present) should be a Volume.Volume entity." + "RootComplex": "The entity is a PCI(e) root complex. The EntityLink property, if present, should be a ComputerSystem type.", + "StorageExpander": "The entity is a storage expander. The EntityLink property, if present, should be a Chassis type.", + "StorageInitiator": "The entity is a storage initator. The EntityLink property, if present, should be a StorageController type.", + "Volume": "The entity is a volume. The EntityLink property, if present, should be a Volume type." }, "enumVersionAdded": { "AccelerationFunction": "v1_3_0", @@ -368,10 +316,10 @@ }, "IPTransportDetails": { "additionalProperties": false, - "description": "This object contains properties which specify the details of the transport supported by the endpoint. The properties which are present, is dependemt on the type of transport supported by the endpoint.", - "longDescription": "The type shall contain properties which specify the details of the transport supported by the endpoint.", + "description": "This type specifies the details of the transport supported by the endpoint. The properties that are present are dependent on the type of transport supported by the endpoint.", + "longDescription": "The type shall contain properties that specify the details of the transport supported by the endpoint.", "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", @@ -387,19 +335,19 @@ "properties": { "IPv4Address": { "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address", - "description": "The IPv4 addresses assigned to the Endpoint.", - "longDescription": "The value of this property shall specify the IPv4Address.", + "description": "The IPv4 addresses assigned to the endpoint.", + "longDescription": "This property shall contain the IPv4Address.", "versionAdded": "v1_1_0" }, "IPv6Address": { "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6Address", - "description": "The IPv6 addresses assigned to the Endpoint.", - "longDescription": "The value of this property shall specify the IPv6Address.", + "description": "The IPv6 addresses assigned to the endpoint.", + "longDescription": "This property shall contain the IPv6Address.", "versionAdded": "v1_1_0" }, "Port": { - "description": "The UDP or TCP port number used by the Endpoint.", - "longDescription": "The value of this property shall be an specify UDP or TCP port number used for communication with the Endpoint.", + "description": "The UDP or TCP port number used by the endpoint.", + "longDescription": "This property shall contain an specify UDP or TCP port number used for communication with the endpoint.", "maximum": 65535, "minimum": 0, "readonly": true, @@ -409,7 +357,7 @@ "TransportProtocol": { "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol", "description": "The protocol used by the connection entity.", - "longDescription": "The value shall be the protocol used by the connection entity.", + "longDescription": "This property shall contain the protocol used by the connection entity.", "readonly": true, "versionAdded": "v1_1_0" } @@ -418,10 +366,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -436,56 +384,56 @@ }, "properties": { "MutuallyExclusiveEndpoints": { - "description": "An array of references to the endpoints that may not be used in zones if this endpoint is used in a zone.", + "description": "An array of links to the endpoints that may not be used in zones if this endpoint is in a zone.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be an array of references of type Endpoint that cannot be used in a zone if this endpoint is used in a zone.", + "longDescription": "This property shall contain an array of links of the Endpoint type that cannot be used in a zone if this endpoint is in a zone.", "readonly": true, "type": "array" }, "MutuallyExclusiveEndpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "NetworkDeviceFunction": { - "description": "When NetworkDeviceFunction resources are present, this array contains references to the network device function that connect to this endpoint.", + "description": "When NetworkDeviceFunction Resources are present, this array contains links to the network device functions that connect to this endpoint.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction" }, - "longDescription": "The value of this property shall be a reference to a NetworkDeviceFunction resource, with which this endpoint is associated.", + "longDescription": "This property shall contain a link to a NetworkDeviceFunction Resource, with which this endpoint is associated.", "readonly": true, "type": "array", "versionAdded": "v1_1_0" }, "NetworkDeviceFunction@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "Ports": { - "description": "An array of references to the the physical ports associated with this endpoint.", + "description": "An array of links to the physical ports associated with this endpoint.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port" }, - "longDescription": "The value of this property shall be an array of references of type Port that are utilized by this endpoint.", + "longDescription": "This property shall contain an array of links of the Port type that are utilized by this endpoint.", "readonly": true, "type": "array" }, "Ports@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -506,7 +454,7 @@ "description": "A PCI ID.", "longDescription": "This type shall describe a PCI ID.", "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", @@ -521,8 +469,8 @@ }, "properties": { "ClassCode": { - "description": "The Class Code, Subclass code, and Programming Interface code of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Class Code, Subclass code, and Programming Interface code of the PCIe device function.", + "description": "The Class Code, Subclass, and Programming Interface code of this PCIe function.", + "longDescription": "This property shall contain the PCI Class Code, Subclass, and Programming Interface of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){3}$", "readonly": true, "type": [ @@ -533,7 +481,7 @@ }, "DeviceId": { "description": "The Device ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Device ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -543,7 +491,7 @@ }, "FunctionNumber": { "description": "The PCI ID of the connected entity.", - "longDescription": "The value of this property shall be the PCI Function Number of the connected PCIe entity.", + "longDescription": "This property shall contain the PCI Function Number of the connected PCIe entity.", "readonly": true, "type": [ "integer", @@ -553,7 +501,7 @@ }, "SubsystemId": { "description": "The Subsystem ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -563,7 +511,7 @@ }, "SubsystemVendorId": { "description": "The Subsystem Vendor ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -573,7 +521,7 @@ }, "VendorId": { "description": "The Vendor ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Vendor ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Vendor ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -587,5 +535,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#Endpoint.v1_3_0.Endpoint" + "title": "#Endpoint.v1_3_2.Endpoint" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json b/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json index 6a106789e9..27c09568e9 100644 --- a/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json +++ b/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.v1_5_1.json", "$ref": "#/definitions/EthernetInterface", "$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,18 +25,37 @@ "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_3_0" } }, "type": "object" }, + "DHCPFallback": { + "enum": [ + "Static", + "AutoConfig", + "None" + ], + "enumDescriptions": { + "AutoConfig": "Fall back to an autoconfigured address.", + "None": "Continue attempting DHCP without a fallback address.", + "Static": "Fall back to a static address specified by IPv4StaticAddresses." + }, + "enumLongDescriptions": { + "AutoConfig": "DHCP shall fall back to an address generated by the implementation.", + "None": "DHCP shall continue trying to obtain an address without falling back to a fixed address.", + "Static": "DHCP shall fall back to a static address specified by IPv4StaticAddresses." + }, + "type": "string" + }, "DHCPv4Configuration": { "additionalProperties": false, "description": "DHCPv4 configuration for this interface.", "longDescription": "This type shall describe the configuration of DHCP v4.", "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,58 +70,78 @@ }, "properties": { "DHCPEnabled": { - "description": "Determines whether DHCPv4 is enabled on this interface.", - "longDescription": "This property shall indicate whether DHCP v4 is enabled for this EthernetInterface.", + "description": "An indication of whether DHCP v4 is enabled on this Ethernet interface.", + "longDescription": "This property shall indicate whether DHCP v4 is enabled for this Ethernet interface.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" + }, + "FallbackAddress": { + "anyOf": [ + { + "$ref": "#/definitions/DHCPFallback" + }, + { + "type": "null" + } + ], + "description": "DHCPv4 fallback address method for this interface.", + "longDescription": "This property shall contain the fallback address method of DHCPv4.", + "readonly": false, + "versionAdded": "v1_5_0" }, "UseDNSServers": { - "description": "Determines whether to use DHCPv4-supplied DNS servers.", - "longDescription": "This property shall indicate whether the interface will use DHCPv4-supplied DNS servers.", + "description": "An indication of whether this interface uses DHCP v4-supplied DNS servers.", + "longDescription": "This property shall indicate whether the interface uses DHCP v4-supplied DNS servers.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseDomainName": { - "description": "Determines whether to use a DHCPv4-supplied domain name.", - "longDescription": "This property shall indicate whether the interface will use a DHCPv4-supplied domain name.", + "description": "An indication of whether this interface uses a DHCP v4-supplied domain name.", + "longDescription": "This property shall indicate whether the interface uses a DHCP v4-supplied domain name.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseGateway": { - "description": "Determines whether to use a DHCPv4-supplied gateway.", - "longDescription": "This property shall indicate whether the interface will use a DHCPv4-supplied gateway.", + "description": "An indication of whether this interface uses a DHCP v4-supplied gateway.", + "longDescription": "This property shall indicate whether the interface uses a DHCP v4-supplied gateway.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseNTPServers": { - "description": "Determines whether to use DHCPv4-supplied NTP servers.", - "longDescription": "This property shall indicate whether the interface will use DHCPv4-supplied NTP servers.", + "description": "An indication of whether the interface uses DHCP v4-supplied NTP servers.", + "longDescription": "This property shall indicate whether the interface uses DHCP v4-supplied NTP servers.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseStaticRoutes": { - "description": "Determines whether to use DHCPv4-supplied static routes.", - "longDescription": "This property shall indicate whether the interface will use a DHCPv4-supplied static routes.", + "description": "An indication of whether the interface uses DHCP v4-supplied static routes.", + "longDescription": "This property shall indicate whether the interface uses a DHCP v4-supplied static routes.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" } }, "type": "object" @@ -111,7 +151,7 @@ "description": "DHCPv6 configuration for this interface.", "longDescription": "This type shall describe the configuration of DHCP v6.", "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", @@ -135,44 +175,49 @@ } ], "description": "Determines the DHCPv6 operating mode for this interface.", - "longDescription": "This property shall control the operating mode of DHCPv6 on this interface. DHCPv6 stateful mode is used to configure addresses, and when it is enabled, stateless mode is also implicitly enabled.", - "readonly": false + "longDescription": "This property shall control the operating mode of DHCPv6 on this interface. DHCPv6 stateful mode configures addresses, and when it is enabled, stateless mode is also implicitly enabled.", + "readonly": false, + "versionAdded": "v1_4_0" }, "UseDNSServers": { - "description": "When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used.", - "longDescription": "This property shall indicate whether the interface will use DHCPv6-supplied DNS servers.", + "description": "An indication of whether the interface uses DHCP v6-supplied DNS servers.", + "longDescription": "This property shall indicate whether the interface uses DHCP v6-supplied DNS servers.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseDomainName": { - "description": "When enabled, the domain name supplied through DHCPv6 stateless mode will be used.", - "longDescription": "This property shall indicate whether the interface will use a domain name supplied through DHCPv6 stateless mode.", + "description": "An indication of whether the interface uses a domain name supplied through DHCP v6 stateless mode.", + "longDescription": "This property shall indicate whether the interface uses a domain name supplied through DHCP v6 stateless mode.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseNTPServers": { - "description": "When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used.", - "longDescription": "This property shall indicate whether the interface will use DHCPv6-supplied NTP servers.", + "description": "An indication of whether the interface uses DHCP v6-supplied NTP servers.", + "longDescription": "This property shall indicate whether the interface uses DHCP v6-supplied NTP servers.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseRapidCommit": { - "description": "Determines whether to use DHCPv6 rapid commit mode for stateful mode address assignments. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments.", - "longDescription": "This property shall indicate whether the interface will use DHCPv6 rapid commit mode for stateful mode address assignments.", + "description": "An indication of whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments. Do not enable this option in networks where more than one DHCP v6 server is configured to provide address assignments.", + "longDescription": "This property shall indicate whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" } }, "type": "object" @@ -190,17 +235,17 @@ }, "enumLongDescriptions": { "Disabled": "DHCPv6 shall be disabled for this interface.", - "Stateful": "DHCPv6 shall operate in stateful mode on this interface. DHCPv6 stateful mode is used to configure addresses, and when it is enabled, stateless mode is also implicitly enabled.", - "Stateless": "DHCPv6 shall operate in stateless mode on this interface. DHCPv6 stateless mode allows configuring the interface using DHCP options but does not configure addresses. It is always enabled by default whenever DHCPv6 Stateful mode is also enabled." + "Stateful": "DHCPv6 shall operate in stateful mode on this interface. DHCPv6 stateful mode configures addresses, and when it is enabled, stateless mode is also implicitly enabled.", + "Stateless": "DHCPv6 shall operate in stateless mode on this interface. DHCPv6 stateless mode allows configuring the interface using DHCP options but does not configure addresses. It is always enabled by default whenever DHCPv6 Stateful mode is also enabled." }, "type": "string" }, "EthernetInterface": { "additionalProperties": false, - "description": "The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).", - "longDescription": "This resource shall be used to represent NIC resources as part of the Redfish specification.", + "description": "The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).", + "longDescription": "This Resource contains NIC Resources as part of the Redfish Specification.", "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", @@ -215,25 +260,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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_3_0" }, "AutoNeg": { - "description": "This indicates if the speed and duplex are automatically negotiated and configured on this interface.", - "longDescription": "The value of this property shall be true if auto negotiation of speed and duplex is enabled on this interface and false if it is disabled.", + "description": "An indication of whether the speed and duplex are automatically negotiated and configured on this interface.", + "longDescription": "This property shall indicate whether the speed and duplex are automatically negotiated and configured on this interface.", "readonly": false, "type": [ "boolean", @@ -241,28 +287,16 @@ ] }, "DHCPv4": { - "anyOf": [ - { - "$ref": "#/definitions/DHCPv4Configuration" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/DHCPv4Configuration", "description": "DHCPv4 configuration for this interface.", - "longDescription": "This property shall contain the configuration of DHCP v4." + "longDescription": "This property shall contain the configuration of DHCP v4.", + "versionAdded": "v1_4_0" }, "DHCPv6": { - "anyOf": [ - { - "$ref": "#/definitions/DHCPv6Configuration" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/DHCPv6Configuration", "description": "DHCPv6 configuration for this interface.", - "longDescription": "This property shall contain the configuration of DHCP v6." + "longDescription": "This property shall contain the configuration of DHCP v6.", + "versionAdded": "v1_4_0" }, "Description": { "anyOf": [ @@ -276,8 +310,8 @@ "readonly": true }, "FQDN": { - "description": "This is the complete, fully qualified domain name obtained by DNS for this interface.", - "longDescription": "The value of this property shall be the fully qualified domain name for this interface.", + "description": "The complete, fully qualified domain name that DNS obtains for this interface.", + "longDescription": "This property shall contain the fully qualified domain name that DNS obtains for this interface.", "readonly": false, "type": [ "string", @@ -285,8 +319,8 @@ ] }, "FullDuplex": { - "description": "This indicates if the interface is in Full Duplex mode or not.", - "longDescription": "The value of this property shall represent the duplex status of the Ethernet connection on this interface.", + "description": "An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface.", + "longDescription": "This property shall indicate whether full-duplex mode is enabled on the Ethernet connection for this interface.", "readonly": false, "type": [ "boolean", @@ -294,8 +328,8 @@ ] }, "HostName": { - "description": "The DNS Host Name, without any domain information.", - "longDescription": "The value of this property shall be host name for this interface.", + "description": "The DNS host name, without any domain information.", + "longDescription": "This property shall contain DNS host name for this interface.", "readonly": false, "type": [ "string", @@ -307,36 +341,51 @@ "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address" }, - "longDescription": "The value of this property shall be an array of objects used to represent the IPv4 connection characteristics for this interface. It is recommended that this propety be regarded as read-only, with configuration of static addresses performed by updating the values within IPv4StaticAddessses. Services may reject updates to this array for this reason.", + "longDescription": "This property shall contain an array of objects that represent the IPv4 connection characteristics for this interface. It is recommended that this property be regarded as read-only with configuration of static addresses performed by updating the values within IPv4StaticAddessses. Services may reject updates to this array for this reason.", "type": "array" }, "IPv4StaticAddresses": { "description": "The IPv4 static addresses assigned to this interface.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address" + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address" + }, + { + "type": "null" + } + ] }, - "longDescription": "The value of this property shall be an array of objects used to represent all IPv4 static addresses assigned (but not necessarily in use) to this interface. Addresses in use by this interface shall also appear in the IPv4Addresses property.", - "type": "array" + "longDescription": "This property shall contain an array of objects that represent all IPv4 static addresses assigned to, but not necessarily in use by, this interface. The IPv4Addresses property shall also list the addresses that this interface uses .", + "type": "array", + "versionAdded": "v1_4_0" }, "IPv6AddressPolicyTable": { - "description": "An array representing the RFC 6724 Address Selection Policy Table.", + "description": "An array that represents the RFC6724-defined address selection policy table.", "items": { - "$ref": "#/definitions/IPv6AddressPolicyEntry" + "anyOf": [ + { + "$ref": "#/definitions/IPv6AddressPolicyEntry" + }, + { + "type": "null" + } + ] }, - "longDescription": "The value of this property shall be an array of objects used to represent the Address Selection Policy Table as defined in RFC 6724.", + "longDescription": "This property shall contain an array of objects that represent the RFC6724-defined address selection policy table.", "type": "array" }, "IPv6Addresses": { - "description": "Enumerates in an array all of the currently assigned IPv6 addresses on this interface.", + "description": "An array of the currently assigned IPv6 addresses on this interface.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6Address" }, - "longDescription": "The value of this property shall be an array of objects used to represent the IPv6 connection characteristics for this interface.", + "longDescription": "This property shall contain an array of objects that represent the IPv6 connection characteristics for this interface.", "type": "array" }, "IPv6DefaultGateway": { - "description": "This is the IPv6 default gateway address that is currently in use on this interface.", - "longDescription": "The value of this property shall be the current IPv6 default gateway address that is in use on this interface.", + "description": "The IPv6 default gateway address in use on this interface.", + "longDescription": "This property shall contain the current IPv6 default gateway address in use on this interface.", "readonly": true, "type": [ "string", @@ -344,28 +393,43 @@ ] }, "IPv6StaticAddresses": { - "description": "Represents in an array all of the IPv6 static addresses to be assigned on this interface.", + "description": "An array of the IPv6 static addresses to assign on this interface.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6StaticAddress" + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6StaticAddress" + }, + { + "type": "null" + } + ] }, - "longDescription": "The value of this property shall be an array of objects used to represent the IPv6 static connection characteristics for this interface.", + "longDescription": "This property shall contain an array of objects that represent the IPv6 static connection characteristics for this interface.", "type": "array" }, "IPv6StaticDefaultGateways": { "description": "The IPv6 static default gateways for this interface.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6GatewayStaticAddress" + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6GatewayStaticAddress" + }, + { + "type": "null" + } + ] }, "longDescription": "The values in this array shall represent the IPv6 static default gateway addresses for this interface.", - "type": "array" + "type": "array", + "versionAdded": "v1_4_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "InterfaceEnabled": { - "description": "This indicates whether this interface is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled.", + "description": "An indication of whether this interface is enabled.", + "longDescription": "This property shall indicate whether this interface is enabled.", "readonly": false, "type": [ "boolean", @@ -381,14 +445,16 @@ "type": "null" } ], - "description": "The link status of this interface (port).", - "longDescription": "The value of this property shall be the link status of this interface (port).", - "readonly": true + "description": "The link status of this interface, or port.", + "longDescription": "This property shall contain the link status of this interface, or port.", + "readonly": true, + "versionAdded": "v1_1_0" }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", + "versionAdded": "v1_1_0" }, "MACAddress": { "anyOf": [ @@ -399,13 +465,13 @@ "type": "null" } ], - "description": "This is the currently configured MAC address of the (logical port) interface.", - "longDescription": "The value of this property shall be the effective current MAC Address of this interface. If an assignable MAC address is not supported, this is a read only alias of the PermanentMACAddress.", + "description": "The currently configured MAC address of the interface, or logical port.", + "longDescription": "This property shall contain the effective current MAC address of this interface. If an assignable MAC address is not supported, this value is a read-only alias of the PermanentMACAddress.", "readonly": false }, "MTUSize": { - "description": "This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface.", - "longDescription": "The value of this property shall be the size in bytes of largest Protocol Data Unit (PDU) that can be passed in an Ethernet (MAC) frame on this interface.", + "description": "The currently configured maximum transmission unit (MTU), in bytes, on this interface.", + "longDescription": "This property shall contain the size, in bytes, of largest protocol data unit (PDU) that can be passed in an Ethernet (MAC) frame on this interface.", "readonly": false, "type": [ "integer", @@ -413,8 +479,8 @@ ] }, "MaxIPv6StaticAddresses": { - "description": "This indicates the maximum number of Static IPv6 addresses that can be configured on this interface.", - "longDescription": "The value of this property shall indicate the number of array items supported by IPv6StaticAddresses.", + "description": "The maximum number of static IPv6 addresses that can be configured on this interface.", + "longDescription": "This property shall indicate the number of array items supported by IPv6StaticAddresses, or the maximum number of static IPv6 addresses that can be configured on this interface.", "readonly": true, "type": [ "integer", @@ -426,18 +492,18 @@ "readonly": true }, "NameServers": { - "description": "This represents DNS name servers that are currently in use on this interface.", + "description": "The DNS servers in use on this interface.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be the DNS name servers used on this interface.", + "longDescription": "This property shall contain the DNS servers in use on this interface.", "readonly": true, "type": "array" }, "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." }, "PermanentMACAddress": { "anyOf": [ @@ -448,13 +514,13 @@ "type": "null" } ], - "description": "This is the permanent MAC address assigned to this interface (port).", - "longDescription": "The value of this property shall be the Permanent MAC Address of this interface (port). This value is typically programmed during the manufacturing time. This address is not assignable.", + "description": "The permanent MAC address assigned to this interface, or port.", + "longDescription": "This property shall contain the permanent MAC address of this interface, or port. Typically, this value is programmed during manufacturing. This address is not assignable.", "readonly": true }, "SpeedMbps": { - "description": "This is the current speed in Mbps of this interface.", - "longDescription": "The value of this property shall be the link speed of the interface in Mbps.", + "description": "The current speed, in Mbps, of this interface.", + "longDescription": "This property shall contain the link speed of the interface, in Mbps. This property shall be writable only when the AutoNeg property is `false`.", "readonly": false, "type": [ "integer", @@ -463,34 +529,32 @@ "units": "Mbit/s" }, "StatelessAddressAutoConfig": { - "anyOf": [ - { - "$ref": "#/definitions/StatelessAddressAutoConfiguration" - }, - { - "type": "null" - } - ], - "description": "Stateless Address Automatic Configuration (SLAAC) parameters for this interface.", - "longDescription": "This object shall contain the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) properties for this interface." + "$ref": "#/definitions/StatelessAddressAutoConfiguration", + "description": "Stateless address autoconfiguration (SLAAC) parameters for this interface.", + "longDescription": "This object shall contain the IPv4 and IPv6 stateless address automatic configuration (SLAAC) properties for this interface.", + "versionAdded": "v1_4_0" }, "StaticNameServers": { - "description": "A statically defined set of DNS server IP addresses (both IPv4 and IPv6).", + "description": "The statically-defined set of DNS server IPv4 and IPv6 addresses.", "items": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "longDescription": "A statically defined set of DNS server IP addresses to be used when DHCP provisioning is not in enabled for name server configuration. As an implementation option they may also be used in addition to DHCP provided addresses, or in cases where the DHCP server provides no DNS assigments.", + "longDescription": "This property shall contain the statically-defined set of DNS server IP addresses to use when DHCP provisioning is not enabled for name server configuration. As an implementation option, they may also be used in addition to DHCP-provided addresses, or in cases where the DHCP server provides no DNS assigments.", "readonly": false, - "type": "array" + "type": "array", + "versionAdded": "v1_4_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UefiDevicePath": { "description": "The UEFI device path for this interface.", - "longDescription": "The value of this property shall be the UEFI device path to the device which implements this interface (port).", + "longDescription": "This property shall contain the UEFI device path to the device that implements this interface, or port.", "readonly": true, "type": [ "string", @@ -498,21 +562,14 @@ ] }, "VLAN": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN" - }, - { - "type": "null" - } - ], - "description": "If this Network Interface supports more than one VLAN, this property is not present. VLANs collections appear in the Link section of this resource.", - "longDescription": "The value of this property shall be the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead." + "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN", + "description": "If this network interface supports more than one VLAN, this property is absent. VLAN collections appear in the Link section of this Resource.", + "longDescription": "This property shall contain the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall be absent and, instead, the VLAN collection link shall be present." }, "VLANs": { "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterfaceCollection.json#/definitions/VLanNetworkInterfaceCollection", - "description": "This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs.", - "longDescription": "The value of this property shall reference a collection of VLAN resources. If this property is used, the VLANEnabled and VLANId property shall not be used.", + "description": "The link to a collection of VLANs, which applies only if the interface supports more than one VLAN. If this property applies, the VLANEnabled and VLANId properties do not apply.", + "longDescription": "This property shall contain a link to a collection of VLAN Resources, which applies only if the interface supports more than one VLAN. If this property is present, the VLANEnabled and VLANId properties shall not be present.", "readonly": true } }, @@ -526,10 +583,10 @@ }, "IPv6AddressPolicyEntry": { "additionalProperties": false, - "description": "A entry in the RFC 6724 Address Selection Policy Table.", - "longDescription": "This type shall describe and entry in the Address Selection Policy Table as defined in RFC 6724.", + "description": "The entry in the RFC6724-defined address selection policy table.", + "longDescription": "This type shall describe an entry in the RFC6724-defined address selection policy table.", "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", @@ -544,8 +601,8 @@ }, "properties": { "Label": { - "description": "The IPv6 Label (as defined in RFC 6724 section 2.1).", - "longDescription": "This property shall contain the IPv6 Label value for this table entry as defined in RFC 6724 section 2.1.", + "description": "The IPv6 label, as defined in RFC6724, section 2.1.", + "longDescription": "This property shall contain the IPv6 label value for this table entry, as defined in RFC6724, section 2.1.", "maximum": 100, "minimum": 0, "readonly": false, @@ -555,8 +612,8 @@ ] }, "Precedence": { - "description": "The IPv6 Precedence (as defined in RFC 6724 section 2.1.", - "longDescription": "This property shall contain the IPv6 Precedence value for this table entry as defined in RFC 6724 section 2.1.", + "description": "The IPv6 precedence, as defined in RFC6724, section 2.1.", + "longDescription": "This property shall contain the IPv6 precedence value for this table entry, as defined in RFC6724, section 2.1.", "maximum": 100, "minimum": 1, "readonly": false, @@ -566,8 +623,8 @@ ] }, "Prefix": { - "description": "The IPv6 Address Prefix (as defined in RFC 6724 section 2.1).", - "longDescription": "This property shall contain the IPv6 Address Prefix for this table entry as defined in RFC 6724 section 2.1.", + "description": "The IPv6 address prefix, as defined in RFC6724, section 2.1.", + "longDescription": "This property shall contain the IPv6 address prefix for this table entry, as defined in RFC6724, section 2.1.", "readonly": false, "type": [ "string", @@ -584,18 +641,18 @@ "LinkDown" ], "enumDescriptions": { - "LinkDown": "There is no link on this interface, but the interface is connected.", + "LinkDown": "No link is detected on this interface, but the interface is connected.", "LinkUp": "The link is available for communication on this interface.", - "NoLink": "There is no link or connection detected on this interface." + "NoLink": "No link or connection is detected on this interface." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -611,32 +668,35 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the Chassis which contains this Ethernet Interface.", - "longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Ethernet Interface.", - "readonly": true + "description": "The link to the chassis that contains this Ethernet interface.", + "longDescription": "This property shall contain a link to a Resource of type Chassis that represent the physical container associated with this Ethernet interface.", + "readonly": true, + "versionAdded": "v1_3_0" }, "Endpoints": { - "description": "An array of references to the endpoints that connect to this ethernet interface.", + "description": "An array of links to the endpoints that connect to this Ethernet interface.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be a reference to the resources that this ethernet interface is associated with and shall reference a resource of type Endpoint.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this Ethernet interface is associated.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "HostInterface": { "$ref": "http://redfish.dmtf.org/schemas/v1/HostInterface.json#/definitions/HostInterface", - "description": "This is a reference to a Host Interface that is associated with this Ethernet Interface.", - "longDescription": "The value of this property shall be a reference to a resource of type HostInterface which represents the interface used by a host to communicate with a Manager.", - "readonly": true + "description": "The link to a Host Interface that is associated with this Ethernet interface.", + "longDescription": "This property shall contain a link to a Resource of type HostInterface that represents the interface that a host uses to communicate with a manager.", + "readonly": true, + "versionAdded": "v1_2_0" }, "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." } }, "type": "object" @@ -647,10 +707,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", @@ -668,10 +728,10 @@ }, "StatelessAddressAutoConfiguration": { "additionalProperties": false, - "description": "Stateless Address Automatic Configuration (SLAAC) parameters for this interface.", - "longDescription": "This type shall describe the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) for this interface.", + "description": "Stateless address autoconfiguration (SLAAC) parameters for this interface.", + "longDescription": "This type shall describe the IPv4 and IPv6 stateless address autoconfiguration (SLAAC) for this interface.", "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", @@ -686,27 +746,30 @@ }, "properties": { "IPv4AutoConfigEnabled": { - "description": "Indicates whether IPv4 SLAAC is enabled for this interface.", - "longDescription": "This property shall indicate whether IPv4 Stateless Address Auto-Configuration (SLAAC) is enabled for this interface.", + "description": "An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.", + "longDescription": "This property shall indicate whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "IPv6AutoConfigEnabled": { - "description": "Indicates whether IPv6 SLAAC is enabled for this interface.", - "longDescription": "This property shall indicate whether IPv6 Stateless Address Auto-Configuration (SLAAC) is enabled for this interface.", + "description": "An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.", + "longDescription": "This property shall indicate whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" } }, "type": "object" } }, "owningEntity": "DMTF", - "title": "#EthernetInterface.v1_4_1.EthernetInterface" + "release": "2019.1", + "title": "#EthernetInterface.v1_5_1.EthernetInterface" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Event/Event.json b/static/redfish/v1/JsonSchemas/Event/Event.json index 9c76636c86..f834372f5e 100644 --- a/static/redfish/v1/JsonSchemas/Event/Event.json +++ b/static/redfish/v1/JsonSchemas/Event/Event.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Event.v1_3_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Event.v1_4_1.json", "$ref": "#/definitions/Event", "$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_2_0" } }, @@ -34,10 +34,10 @@ }, "Event": { "additionalProperties": false, - "description": "The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.", - "longDescription": "This resource shall be used to represent an event for a Redfish implementation.", + "description": "The Event schema describes the JSON payload received by an Event Destination, which has subscribed to event notification, when events occur. This Resource contains data about events, including descriptions, severity, and a MessageId link to a Message Registry that can be accessed for further information.", + "longDescription": "This Resource contains an event 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", @@ -52,26 +52,20 @@ }, "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" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@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_2_0" }, "Context": { "description": "A context can be supplied at subscription time. This property is the context value supplied by the subscriber.", - "longDescription": "This property shall contain a client supplied context for the Event Destination to which this event is being sent.", + "longDescription": "This property shall contain a client supplied context for the event destination to which this event is being sent.", "readonly": true, "type": "string", "versionAdded": "v1_1_0" @@ -89,15 +83,15 @@ }, "Events": { "autoExpand": true, - "description": "Each event in this array has a set of properties that describe the event. Since this is an array, more than one event can be sent simultaneously.", + "description": "Each event in this array has a set of properties that describe the event. Because this is an array, more than one event can be sent simultaneously.", "items": { "$ref": "#/definitions/EventRecord" }, - "longDescription": "The value of this resource shall be an array of Event objects used to represent the occurrence of one or more events.", + "longDescription": "This property shall contain an array of Event objects that represent the occurrence of one or more events.", "type": "array" }, "Events@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -109,13 +103,12 @@ }, "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." } }, "required": [ "Events", - "@odata.id", "@odata.type", "Id", "Name" @@ -125,7 +118,7 @@ "EventRecord": { "additionalProperties": false, "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", @@ -139,89 +132,90 @@ } }, "properties": { - "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" - }, "Actions": { "$ref": "#/definitions/EventRecordActions", - "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_2_0" }, "Context": { + "deprecated": "Events are triggered independently from subscriptions to those events. This property has been deprecated in favor of Context found at the root level of the object.", "description": "A context can be supplied at subscription time. This property is the context value supplied by the subscriber.", - "longDescription": "This property shall contain a client supplied context for the Event Destination to which this event is being sent.", + "longDescription": "This property shall contain a client supplied context for the event destination to which this event is being sent.", "readonly": true, - "type": "string" + "type": "string", + "versionDeprecated": "v1_1_0" }, "EventGroupId": { - "description": "This value is the identifier used to correlate events that came from the same cause.", - "longDescription": "The value of this property shall indicate that events are related and shall have the same value in the case where multiple Event messages are produced by the same root cause. Implementations shall use separate values for events with separate root cause. There shall not be ordering of events implied by the value of this property.", + "description": "The identifier that correlates events with the same root cause. If `0`, no other event is related to this event.", + "longDescription": "This property shall indicate that events are related and shall have the same value when multiple event messages are produced by the same root cause. Implementations shall use separate values for events with a separate root cause. This property value shall not imply an ordering of events. The `0` value shall indicate that this event is not grouped with any other event.", "readonly": true, "type": "integer", "versionAdded": "v1_3_0" }, "EventId": { - "description": "This is a unique instance identifier of an event.", - "longDescription": "The value of this property shall indicate a unique identifier for the event, the format of which is implementation dependent.", + "description": "The unique instance identifier of an event.", + "longDescription": "This property shall indicate a unique identifier for the event. The value should be a string of a positive integer, and should be generated in a sequential manner.", "readonly": true, "type": "string" }, "EventTimestamp": { - "description": "This is time the event occurred.", + "description": "The time the event occurred.", "format": "date-time", - "longDescription": "The value of this property shall indicate the time the event occurred where the value shall be consistent with the Redfish service time that is also used for the values of the Modified property.", + "longDescription": "This property shall indicate the time the event occurred where the value shall be consistent with the Redfish Service time that is also used for the values of the Modified property.", "readonly": true, "type": "string" }, "EventType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType", - "description": "This indicates the type of event sent, according to the definitions in the EventService.", - "longDescription": "The value of this property shall indicate the type of event as defined in the EventService schema.", - "readonly": true + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "The type of event.", + "longDescription": "This property shall indicate the type of EventService schema-defined event.", + "readonly": true, + "versionDeprecated": "v1_3_0" }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "Message": { - "description": "This is the human readable message, if provided.", - "longDescription": "This property shall contain an optional human readable message.", + "description": "The human-readable event message.", + "longDescription": "This property shall contain a human-readable event message.", "readonly": true, "type": "string" }, "MessageArgs": { - "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.", + "description": "An array of message arguments that are substituted for the arguments in the message when looked up in the Message Registry.", "items": { "type": "string" }, - "longDescription": "This property has the same semantics as the MessageArgs property in the Event schema for Redfish.", + "longDescription": "This property shall contain an array of message arguments that are substituted for the arguments in the message when looked up in the Message Registry. It has the same semantics as the MessageArgs property in the Redfish Event schema.", "readonly": true, "type": "array" }, "MessageId": { - "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.", + "description": "The key used to find the message in a Message Registry.", + "longDescription": "This property shall contain a MessageId, as defined in the Redfish Specification.", "pattern": "^[A-Za-z0-9]+\\.\\d+\\.\\d+\\.[A-Za-z0-9.]+$", "readonly": true, "type": "string" }, "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." }, "OriginOfCondition": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", - "description": "This indicates the resource that originated the condition that caused the event to be generated.", - "longDescription": "The value of this property shall contain a pointer consistent with JSON pointer syntax to the resource that caused the event to be generated.", + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", + "description": "The Resource that originated the condition that caused the event to be generated.", + "longDescription": "This property shall contain a pointer consistent with JSON Pointer syntax to the Resource that caused the event to be generated.", "readonly": true }, "Severity": { - "description": "This is the severity of the event.", - "longDescription": "The value of this property shall be the severity of the event, as defined in the Status section of the Redfish specification.", + "description": "The severity of the event.", + "longDescription": "This property shall contain the severity of the event, as defined in the Status section of the Redfish Specification.", "readonly": true, "type": "string" } @@ -229,17 +223,16 @@ "required": [ "EventType", "MessageId", - "@odata.id", "MemberId" ], "type": "object" }, "EventRecordActions": { "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", @@ -255,8 +248,8 @@ "properties": { "Oem": { "$ref": "#/definitions/EventRecordOemActions", - "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_2_0" } }, @@ -264,10 +257,10 @@ }, "EventRecordOemActions": { "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", @@ -285,10 +278,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", @@ -306,6 +299,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.2", - "title": "#Event.v1_3_1.Event" + "release": "2019.1", + "title": "#Event.v1_4_1.Event" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/EventDestination/EventDestination.json b/static/redfish/v1/JsonSchemas/EventDestination/EventDestination.json index 775934ca0b..821b284751 100644 --- a/static/redfish/v1/JsonSchemas/EventDestination/EventDestination.json +++ b/static/redfish/v1/JsonSchemas/EventDestination/EventDestination.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/EventDestination.v1_6_0.json", "$ref": "#/definitions/EventDestination", "$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", @@ -22,20 +23,37 @@ } }, "properties": { + "#EventDestination.ResumeSubscription": { + "$ref": "#/definitions/ResumeSubscription" + }, "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_2_0" } }, "type": "object" }, + "DeliveryRetryPolicy": { + "enum": [ + "TerminateAfterRetries", + "SuspendRetries", + "RetryForever" + ], + "enumDescriptions": { + "RetryForever": "The subscription is not suspended or terminated, and attempts at delivery of future events shall continue even after the after the maximum number of retries is reached.", + "SuspendRetries": "The subscription is suspended after the maximum number of retries is reached.", + "TerminateAfterRetries": "The subscription is terminated after the maximum number of retries is reached." + }, + "type": "string" + }, "EventDestination": { "additionalProperties": false, - "description": "An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.", - "longDescription": "This resource shall be used to represent the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.", + "description": "The EventDestination schema defines the target of an event subscription, including the event types and context to provide to the target in the Event payload.", + "longDescription": "This Resource shall represent the target of an event subscription, including the event types and context to provide to the target in the Event payload.", "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,31 +68,46 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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_2_0" }, "Context": { "description": "A client-supplied string that is stored with the event destination subscription.", - "longDescription": "This property shall contain a client supplied context that will remain with the connection through the connections lifetime.", + "longDescription": "This property shall contain a client-supplied context that remains with the connection through the connection's lifetime.", "readonly": false, "type": [ "string", "null" ] }, + "DeliveryRetryPolicy": { + "anyOf": [ + { + "$ref": "#/definitions/DeliveryRetryPolicy" + }, + { + "type": "null" + } + ], + "description": "This property shall contain the subscription delivery retry policy for events, where the subscription type is RedfishEvent.", + "longDescription": "This property shall indicate the subscription delivery retry policy for events where the subscription type is RedfishEvent. If this property is not present, the policy shall be assumed to be TerminateAfterRetries.", + "readonly": false, + "versionAdded": "v1_6_0" + }, "Description": { "anyOf": [ { @@ -87,9 +120,9 @@ "readonly": true }, "Destination": { - "description": "The URI of the destination Event Service.", - "format": "uri", - "longDescription": "This property shall contain a URI to the destination where the events will be sent.", + "description": "The URI of the destination event receiver.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI to the destination where the events are sent.", "readonly": true, "type": "string" }, @@ -102,25 +135,28 @@ "type": "null" } ], - "description": "Indicates the content types of the message that will be sent to the EventDestination.", - "longDescription": "The value of this property shall indicate the the content types of the message that this service will send to the EventDestination. If this property is not present, the EventFormatType shall be assumed to be Event.", - "readonly": true + "description": "The content types of the message that are sent to the EventDestination.", + "longDescription": "This property shall indicate the content types of the message that this service sends to the EventDestination. If this property is not present, the EventFormatType shall be assumed to be Event.", + "readonly": true, + "versionAdded": "v1_4_0" }, "EventTypes": { - "description": "This property contains the types of events that will be sent to the desination.", + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. Use EventFormatType to create subscriptions for Metric Reports. If the subscription does not include this property, the service shall use a single element with a default of `Other`.", + "description": "The types of events that are sent to the destination.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType" }, - "longDescription": "This property shall be an array that contains the types of events that shall be sent to the destination.", + "longDescription": "This property shall contain an array that contains the types of events that shall be sent to the destination. To specify that a client is subscribing for Metric Reports, the EventTypes property should include 'MetricReport'. If the subscription does not include this property, the service shall use a single element with a default of `Other`.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_5_0" }, "HttpHeaders": { - "description": "This is for setting HTTP headers, such as authorization information. This object will be null on a GET.", + "description": "An array of settings for HTTP headers, such as authorization information. This array is null or an empty array in responses. An empty array is the preferred return value on read operations.", "items": { "$ref": "#/definitions/HttpHeaderProperty" }, - "longDescription": "This property shall contain an object consisting of the names and values of of HTTP header to be included with every event POST to the Event Destination. This property shall be null on a GET.", + "longDescription": "This property shall contain an object consisting of the names and values of of HTTP header to be included with every event POST to the Event Destination. This object shall be null or an empty array in responses. An empty array is the preferred return value in responses.", "type": "array" }, "Id": { @@ -128,16 +164,30 @@ "readonly": true }, "MessageIds": { - "description": "A list of MessageIds that the service will only send. If this property is absent or the array is empty, then Events with any MessageId will be sent to the subscriber.", + "description": "The list of MessageIds that the service sends. If this property is absent or the array is empty, events with any MessageId are sent to the subscriber.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall specify an array of MessageIds that are the only allowable values for the MessageId property within an EventRecord sent to the subscriber. Events with MessageIds not contained in this array shall not be sent to the subscriber. If this property is absent or the array is empty, the service shall send Events with any MessageId to the subscriber.", + "longDescription": "This property shall specify an array of MessageIds that are the only allowable values for the MessageId property within an EventRecord sent to the subscriber. Events with MessageIds that are not contained in this array shall not be sent to the subscriber. If this property is absent or the array is empty, the service shall send events with any MessageId to the subscriber.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" + }, + "MetricReportDefinitions": { + "description": "A list of metric report definitions for which the service only sends related metric reports. If this property is absent or the array is empty, metric reports that originate from any metric report definition are sent to the subscriber.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinition.json#/definitions/MetricReportDefinition" + }, + "longDescription": "This property shall specify an array of metric report definitions that are the only allowable generators of metric reports for this subscription. Metric reports originating from metric report definitions not contained in this array shall not be sent to the subscriber. If this property is absent or the array is empty, the service shall send metric reports originating from any metric report definition to the subscriber.", + "readonly": true, + "type": "array", + "versionAdded": "v1_6_0" + }, + "MetricReportDefinitions@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -145,59 +195,69 @@ }, "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." }, "OriginResources": { - "description": "A list of resources for which the service will only send related events. If this property is absent or the array is empty, then Events originating from any resource will be sent to the subscriber.", + "description": "The array of Resources for which the service sends only related events. If this property is absent or the array is empty, the service sends the events that originate from any Resource to the subscriber.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall specify an array of Resources, Resource Collections, or Referenceable Members that are the only allowable values for the OriginOfCondition property within an EventRecord sent to the subscriber. Events originating from Resources, Resource Collections, or Referenceable Members not contained in this array shall not be sent to the subscriber. If this property is absent or the array is empty, the service shall send Events originating from any Resource, Resource Collection, or Referenceable Member to the subscriber.", + "longDescription": "This property shall specify an array of Resources, Resource Collections, or Referenceable Members that are the only allowable values for the OriginOfCondition property within an EventRecord that the service sends to the subscriber. The service shall not send events that originate from Resources, Resource Collections, or Referenceable Members, and that this array does not contain, to the subscriber. If this property is absent or the array is empty, the service shall send events that originate from any Resource, Resource Collection, or Referenceable Member to the subscriber.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "OriginResources@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Protocol": { "$ref": "#/definitions/EventDestinationProtocol", "description": "The protocol type of the event connection.", - "longDescription": "This property shall contain the protocol type that the event will use for sending the event to the destination. A value of Redfish shall be used to indicate that the event type shall adhere to that defined in the Redfish specification.", + "longDescription": "This property shall contain the protocol type that the event uses to send the event to the destination. A `Redfish` value shall indicate that the event type shall adhere to the type defined in the Redfish Specification.", "readonly": true }, "RegistryPrefixes": { - "description": "A list of the Prefixes for the Message Registries that contain the MessageIds that will be sent to this event destination.", + "description": "The list of the prefixes for the Message Registries that contain the MessageIds that are sent to this event destination.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property is the array of the Prefixes of the Message Registries that contain the MessageIds in the Events that shall be sent to the EventDestination. If this property is absent or the array is empty, the service shall send Events with MessageIds from any Message Registry.", + "longDescription": "This property shall contain the array of the prefixes of the Message Registries that contain the MessageIds in the Events that shall be sent to the EventDestination. If this property is absent or the array is empty, the service shall send events with MessageIds from any Message Registry.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_4_0" }, "ResourceTypes": { - "description": "A list of Resource Type values (Schema names) that correspond to the OriginOfCondition. The version and full namespace should not be specified.", + "description": "The list of Resource Type values (Schema names) that correspond to the OriginOfCondition. The version and full namespace should not be specified.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall specify an array of Resource Type values. When an event is generated, if the OriginOfCondition's Resource Type matches a value in this array, the event shall be sent to the event destination (unless it would be filtered by other property conditions such as RegistryPrefix). If this property is absent or the array is empty, the service shall send Events from any Resource Type to the subscriber. The value of this property shall be only the general namespace for the type and not the versioned value. For example, it shall not be Task.v1_2_0.Task and instead shall just be Task.", + "longDescription": "This property shall specify an array of Resource Type values. When an event is generated, if the OriginOfCondition's Resource Type matches a value in this array, the event shall be sent to the event destination (unless it would be filtered by other property conditions such as RegistryPrefix). If this property is absent or the array is empty, the service shall send Events from any Resource type to the subscriber. This property shall contain only the general namespace for the type and not the versioned value. For example, it shall not contain Task.v1_2_0.Task and instead shall contain Task. To specify that a client is subscribing to metric reports, the EventTypes property should include `MetricReport`.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_4_0" + }, + "Status": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", + "description": "This property shall contain the status of the subscription.", + "longDescription": "This property shall contain the status of the subscription.", + "versionAdded": "v1_6_0" }, "SubordinateResources": { - "description": "By setting this to true and specifying OriginResources, this indicates the subscription will be for events from the OriginsResources specified and also all subordinate resources. Note that resources associated via the Links section are not considered subordinate.", - "longDescription": "When set to true and OriginResources is specifed, indicates the subscription shall be for events from the OriginsResources specified and all subordinate resources. When set to false and OriginResources is specified, indicates subscription shall be for events only from the OriginResources. If OriginResources is not specified, it has no relevenace.", + "description": "An indication of whether the subscription is for events in the OriginResources array and its subordinate Resources. If `true` and the OriginResources array is specified, the subscription is for events in the OriginResources array and its subordinate Resources. Note that Resources associated through the Links section are not considered subordinate. If `false` and the OriginResources array is specified, the subscription shall be for events in the OriginResources array only. If the OriginResources array is not present, this property shall have no relevance.", + "longDescription": "This property shall indicate whether the subscription is for events in the OriginResources array and its subordinate Resources. If `true` and the OriginResources array is specified, the subscription is for events in the OriginResources array and its subordinate Resources. Note that Resources associated through the Links section are not considered subordinate. If `false` and the OriginResources array is specified, the subscription shall be for events in the OriginResources array only. If the OriginResources array is not present, this property shall have no relevance.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "SubscriptionType": { "anyOf": [ @@ -208,9 +268,10 @@ "type": "null" } ], - "description": "Indicates the subscription type for events.", - "longDescription": "The value of this property shall indicate the type of subscription for events. If this property is not present, the SubscriptionType shall be assumed to be RedfishEvent.", - "readonly": true + "description": "The subscription type for events.", + "longDescription": "This property shall indicate the type of subscription for events. If this property is not present, the SubscriptionType shall be assumed to be RedfishEvent.", + "readonly": true, + "versionAdded": "v1_3_0" } }, "required": [ @@ -223,7 +284,6 @@ ], "requiredOnCreate": [ "Destination", - "EventTypes", "Protocol" ], "type": "object" @@ -233,27 +293,16 @@ "Redfish" ], "enumDescriptions": { - "Redfish": "The destination follows the Redfish specification for event notifications." - }, - "type": "string" - }, - "EventFormatType": { - "enum": [ - "Event", - "MetricReport" - ], - "enumDescriptions": { - "Event": "The subscription destination will receive JSON Bodies of the Resource Type Event.", - "MetricReport": "The subscription destination will receive JSON Bodies of the Resource Type MetricReport." + "Redfish": "The destination follows the Redfish Specification for event notifications." }, "type": "string" }, "HttpHeaderProperty": { "additionalProperties": false, - "description": "The value of the HTTP header is the property value. The header name is the property name.", - "longDescription": "This type shall a names and value of an HTTP header to be included with every event POST to the Event Destination.", + "description": "The HTTP header value is the property value. The header name is the property name.", + "longDescription": "This type shall contain the HTTP header name and value to include with every event POST to the event eestination.", "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", @@ -274,10 +323,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", @@ -293,18 +342,51 @@ "properties": {}, "type": "object" }, + "ResumeSubscription": { + "additionalProperties": false, + "description": "This action resumes a suspended event subscription.", + "longDescription": "This action shall resume a suspended event subscription, which affects the subscription status.", + "parameters": {}, + "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": { + "target": { + "description": "Link to invoke action", + "format": "uri-reference", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object" + }, "SubscriptionType": { "enum": [ "RedfishEvent", "SSE" ], "enumDescriptions": { - "RedfishEvent": "The subscription follows the Redfish specification for event notifications, which is done by a service sending an HTTP POST to the subscriber's destination URI.", + "RedfishEvent": "The subscription follows the Redfish Specification for event notifications. To send an event notification, a service sends an HTTP POST to the subscriber's destination URI.", "SSE": "The subscription follows the HTML5 Server-Sent Event definition for event notifications." }, "type": "string" } }, "owningEntity": "DMTF", - "title": "#EventDestination.v1_4_0.EventDestination" + "release": "2019.2", + "title": "#EventDestination.v1_6_0.EventDestination" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/EventService/EventService.json b/static/redfish/v1/JsonSchemas/EventService/EventService.json index 8d9923d041..f616f392bb 100644 --- a/static/redfish/v1/JsonSchemas/EventService/EventService.json +++ b/static/redfish/v1/JsonSchemas/EventService/EventService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/EventService.v1_4_0.json", "$ref": "#/definitions/EventService", "$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", @@ -27,8 +28,8 @@ }, "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." } }, "type": "object" @@ -39,17 +40,17 @@ "MetricReport" ], "enumDescriptions": { - "Event": "The subscription destination will receive JSON Bodies of the Resource Type Event.", - "MetricReport": "The subscription destination will receive JSON Bodies of the Resource Type MetricReport." + "Event": "The subscription destination receives JSON bodies of the Event type.", + "MetricReport": "The subscription destination receives JSON bodies of the MetricReport type." }, "type": "string" }, "EventService": { "additionalProperties": false, - "description": "The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).", - "longDescription": "This resource shall be used to represent an event service for a Redfish implementation.", + "description": "The EventService schema contains properties for managing event subcriptions and generates the events sent to subscribers. The Resource has links to the actual collection of subscriptions, which are called event destinations.", + "longDescription": "This Resource shall represent an Event Service 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", @@ -64,31 +65,31 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "DeliveryRetryAttempts": { - "description": "This is the number of attempts an event posting is retried before the subscription is terminated. This retry is at the service level, meaning the HTTP POST to the Event Destination was returned by the HTTP operation as unsuccessful (4xx or 5xx return code) or an HTTP timeout occurred this many times before the Event Destination subscription is terminated.", - "longDescription": "The value of this property shall be the number of retrys attempted for any given event to the subscription destination before the subscription is terminated. This retry is at the service level, meaning the HTTP POST to the Event Destination was returned by the HTTP operation as unsuccessful (4xx or 5xx return code) or an HTTP timeout occurred this many times before the Event Destination subscription is terminated.", + "description": "The number of times that the POST of an event is retried before the subscription terminates. This retry occurs at the service level, which means that the HTTP POST to the event destination fails with an HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times before the event destination subscription terminates.", + "longDescription": "This property shall contain the number of times that the POST of an event is retried before the subscription terminates. This retry occurs at the service level, which means that the HTTP POST to the event destination fails with an HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times before the event destination subscription terminates.", "readonly": false, "type": "integer" }, "DeliveryRetryIntervalSeconds": { - "description": "This represents the number of seconds between retry attempts for sending any given Event.", - "longDescription": "The value of this property shall be the interval in seconds between the retry attempts for any given event to the subscription destination.", + "description": "The interval, in seconds, between retry attempts for sending any event.", + "longDescription": "This property shall contain the interval, in seconds, between the retry attempts for any event sent to the subscription destination.", "readonly": false, "type": "integer", "units": "s" @@ -105,7 +106,7 @@ "readonly": true }, "EventFormatTypes": { - "description": "Indicates the content types of the message that this service can send to the event destination.", + "description": "The content types of the message that this service can send to the event destination.", "items": { "anyOf": [ { @@ -116,18 +117,21 @@ } ] }, - "longDescription": "The value of this property shall indicate the the content types of the message that this service can send to the event destination. If this property is not present, the EventFormatType shall be assumed to be Event.", + "longDescription": "This property shall contain the content types of the message that this service can send to the event destination. If this property is not present, the EventFormatType shall be assumed to be `Event`.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "EventTypesForSubscription": { - "description": "This is the types of Events that can be subscribed to.", + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "The types of events to which a client can subscribe.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType" }, - "longDescription": "The value of this property shall be the types of events that subscriptions can subscribe to. The semantics associated with the enumerations values are defined in the Redfish specification.", + "longDescription": "This property shall contain the types of events to which a client can subscribe. The semantics associated with the enumeration values are defined in the Redfish Specification.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_3_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -139,48 +143,52 @@ }, "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." }, "RegistryPrefixes": { - "description": "A list of the Prefixes of the Message Registries that can be used for the RegistryPrefix property on a subscription.", + "description": "The list of the prefixes of the Message Registries that can be used for the RegistryPrefix property on a subscription. If this property is absent or contains an empty array, the service does not support RegistryPrefix-based subscriptions.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property is the array of the Prefixes of the Message Registries that shall be allowed for an Event Subscription.", + "longDescription": "This property shall contain the array of the prefixes of the Message Registries that shall be allowed for an event subscription.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "ResourceTypes": { - "description": "A list of @odata.type values (Schema names) that can be specified in a ResourceType on a subscription.", + "description": "The list of @odata.type values, or Schema names, that can be specified in the ResourceTypes array in a subscription. If this property is absent or contains an empty array, the service does not support Resource type-based subscriptions.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall specify an array of the valid @odata.type values that can be used for an Event Subscription.", + "longDescription": "This property shall specify an array of the valid @odata.type values that can be used for an event subscription.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "SSEFilterPropertiesSupported": { "$ref": "#/definitions/SSEFilterPropertiesSupported", - "description": "Contains a set of properties that indicate which properties are supported in the $filter query parameter for the ServerSentEventUri.", - "longDescription": "The value of this property shall contain a set of properties that indicate which properties are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property." + "description": "The set of properties that are supported in the $filter query parameter for the ServerSentEventUri.", + "longDescription": "This property shall contain the properties that are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.", + "versionAdded": "v1_2_0" }, "ServerSentEventUri": { - "description": "Link to a URI for receiving Sever Sent Event representations of the events generated by this service.", - "format": "uri", - "longDescription": "The value of this property shall be a URI that specifies an HTML5 Server-Sent Event conformant endpoint.", + "description": "The link to a URI for receiving Server-Sent Event representations for the events that this service generates.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI that specifies an HTML5 Server-Sent Event-conformant endpoint.", "readonly": true, - "type": "string" + "type": "string", + "versionAdded": "v1_1_0" }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -189,22 +197,23 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SubordinateResourcesSupported": { - "description": "This indicates if the service supports the SubordinateResource property on Event Subscriptions.", - "longDescription": "When set to true, the service is indicating that it supports the SubordinateResource property on Event Subscriptions and on generated Events.", + "description": "An indication of whether the service supports the SubordinateResource property on both event subscriptions and generated events.", + "longDescription": "This property shall indicate whether the service supports the SubordinateResource property on both event subscriptions and generated events.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_2_0" }, "Subscriptions": { "$ref": "http://redfish.dmtf.org/schemas/v1/EventDestinationCollection.json#/definitions/EventDestinationCollection", - "description": "This is a reference to a collection of Event Destination resources.", - "longDescription": "The value of this property shall contain the link to a collection of type EventDestinationCollection.", + "description": "The link to a collection of event destination Resources.", + "longDescription": "This property shall contain the link to a Resource Collection of type EventDestinationCollection.", "readonly": true } }, @@ -218,10 +227,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", @@ -239,10 +248,10 @@ }, "SSEFilterPropertiesSupported": { "additionalProperties": false, - "description": "Contains a set of properties that indicate which properties are supported in the $filter query parameter for the ServerSentEventUri.", - "longDescription": "The type shall contain a set of properties that indicate which properties are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.", + "description": "The set of properties that are supported in the $filter query parameter for the ServerSentEventUri.", + "longDescription": "The type shall contain a set of properties that are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.", "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", @@ -257,111 +266,128 @@ }, "properties": { "EventFormatType": { - "description": "This indicates if the EventFormatType property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the EventFormatType property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the EventFormatType property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the EventFormatType property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "EventType": { - "description": "This indicates if the EventType property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the EventType property in the $filter query parameter as described by the specification.", + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "An indication of whether the service supports the EventType property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the EventType property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0", + "versionDeprecated": "v1_3_0" }, "MessageId": { - "description": "This indicates if the MessageId property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the MessageId property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the MessageId property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the MessageId property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "MetricReportDefinition": { - "description": "This indicates if the MetricReportDefinition property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the MetricReportDefinition property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the MetricReportDefinition property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the MetricReportDefinition property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "OriginResource": { - "description": "This indicates if the OriginResource property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the OriginResource property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the OriginResource property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the OriginResource property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "RegistryPrefix": { - "description": "This indicates if the RegistryPrefix property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the RegistryPrefix property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the RegistryPrefix property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the RegistryPrefix property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "ResourceType": { - "description": "This indicates if the ResourceType property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the ResourceType property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the ResourceType property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the ResourceType property in the $filter query parameter, as described by the Redfish Specification.", + "readonly": true, + "type": "boolean", + "versionAdded": "v1_2_0" + }, + "SubordinateResources": { + "description": "An indication of whether the service supports the SubordinateResources property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the SubordinateResources property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_4_0" } }, "type": "object" }, "SubmitTestEvent": { "additionalProperties": false, - "description": "This action is used to generate a test event.", - "longDescription": "This action shall add a test event to the event service with the event data specified in the action parameters. This message should then be sent to any appropriate ListenerDestination targets.", + "description": "This action generates a test event.", + "longDescription": "This action shall add a test event to the Event Service with the event data specified in the action parameters. Then, this message should be sent to any appropriate event destinations.", "parameters": { + "EventGroupId": { + "description": "The group ID for the event.", + "longDescription": "The parameter shall contain the group ID for the event. It has the same semantics as the EventGroupId property in the Event schema for Redfish.", + "type": "integer", + "versionAdded": "v1_3_0" + }, "EventId": { - "description": "This is the ID of event to be added.", - "longDescription": "This parameter shall have the same semantics as the EventId property in the Event schema for Redfish.", - "requiredParameter": true, + "description": "The ID for the event to add.", + "longDescription": "This parameter shall have the same semantics as the EventId property in the Event schema for Redfish. A service may ignore this value and replace it with its own.", "type": "string" }, "EventTimestamp": { - "description": "This is the time stamp of event to be added.", + "description": "The date and time stamp for the event to add.", "format": "date-time", - "longDescription": "This parameter shall have the same semantics as the EventTimestamp property in the Event schema for Redfish.", - "requiredParameter": true, + "longDescription": "This parameter shall contain the date and time stamp for the event to add and have the same semantics as the EventTimestamp property in the Event schema for Redfish.", "type": "string" }, "EventType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType", - "description": "This is the type of event to be added.", - "longDescription": "This parameter shall define the property name for which the following allowable values apply.", - "requiredParameter": true + "deprecated": "This parameter has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "The type for the event to add.", + "longDescription": "This parameter shall contain the property name for which the following allowable values apply.", + "versionDeprecated": "v1_3_0" }, "Message": { - "description": "This is the human readable message of event to be added.", + "description": "The human-readable message for the event to add.", "longDescription": "This parameter shall have the same semantics as the Message property in the Event schema for Redfish.", - "requiredParameter": true, "type": "string" }, "MessageArgs": { - "description": "This is the array of message arguments of the event to be added.", + "description": "An array of message arguments for the event to add.", "items": { "type": "string" }, "longDescription": "This parameter shall have the same semantics as the MessageArgs property in the Event schema for Redfish.", - "requiredParameter": true, "type": "array" }, "MessageId": { - "description": "This is the message ID of event to be added.", - "longDescription": "This parameter shall have the same semantics as the MessageId property in the Event schema for Redfish.", + "description": "The MessageId for the event to add.", + "longDescription": "This parameter shall contain the MessageId for the event to add and have the same semantics as the MessageId property in the Event schema for Redfish.", "requiredParameter": true, "type": "string" }, "OriginOfCondition": { - "description": "This is the string of the URL within the OriginOfCondition property of the event to be added. It is not a reference object.", - "format": "uri", + "description": "The URL in the OriginOfCondition property of the event to add. It is not a reference object.", + "format": "uri-reference", "longDescription": "This parameter shall be a string that represents the URL contained by the OriginOfCondition property in the Event schema for Redfish.", - "requiredParameter": true, "type": "string" }, "Severity": { - "description": "This is the Severity of event to be added.", - "longDescription": "This parameter shall have the same semantics as the Severity property in the Event schema for Redfish.", - "requiredParameter": true, + "description": "The severity for the event to add.", + "longDescription": "This parameter shall contain the severity for the event to add and have the same semantics as the Severity property in the Event schema for Redfish.", "type": "string" } }, "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", @@ -377,7 +403,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -389,5 +415,6 @@ } }, "owningEntity": "DMTF", - "title": "#EventService.v1_2_0.EventService" + "release": "2019.2", + "title": "#EventService.v1_4_0.EventService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ExternalAccountProvider/ExternalAccountProvider.json b/static/redfish/v1/JsonSchemas/ExternalAccountProvider/ExternalAccountProvider.json index dea1b95249..7e5ca20bd8 100644 --- a/static/redfish/v1/JsonSchemas/ExternalAccountProvider/ExternalAccountProvider.json +++ b/static/redfish/v1/JsonSchemas/ExternalAccountProvider/ExternalAccountProvider.json @@ -1,8 +1,8 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ExternalAccountProvider.v1_1_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ExternalAccountProvider.v1_1_2.json", "$ref": "#/definitions/ExternalAccountProvider", "$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": { "AccountProviderTypes": { "enum": [ @@ -12,24 +12,24 @@ "OEM" ], "enumDescriptions": { - "ActiveDirectoryService": "An external Active Directory Service.", - "LDAPService": "A generic external LDAP Service.", - "OEM": "An OEM specific external authentication or directory service.", + "ActiveDirectoryService": "An external Active Directory service.", + "LDAPService": "A generic external LDAP service.", + "OEM": "An OEM-specific external authentication or directory service.", "RedfishService": "An external Redfish Service." }, "enumLongDescriptions": { - "ActiveDirectoryService": "The external account provider shall be a service conforming to the Microsoft Active Directory Technical specification. The format of ServiceAddresses shall be a collection of FQDNs or Netbios names that references the set of domain servers for the Active Directory service.", - "LDAPService": "The external account provider shall be a service conforming to RFC4511. The format of ServiceAddresses shall be a collection of FQDNs that references the set of LDAP servers for the service.", - "RedfishService": "The external account provider shall be a service conforming to the DMTF Redfish specification. The format of ServiceAddresses shall be a collection of URIs which corresponds to a Redfish AccountService entity." + "ActiveDirectoryService": "The external account provider shall be a Microsoft Active Directory Technical Specification-comformant service. The ServiceAddresses format shall contain a collection of fully qualified domain names (FQDN) or NetBIOS names that links to the set of domain servers for the Active Directory service.", + "LDAPService": "The external account provider shall be an RFC4511-conformant service. The ServiceAddresses format shall contain a collection of fully qualified domain names (FQDN) that links to the set of LDAP servers for the Service.", + "RedfishService": "The external account provider shall be a DMTF Redfish Specification-comformant service. The ServiceAddresses format shall contain a collection of URIs that correspond to a Redfish Account Service entity." }, "type": "string" }, "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", @@ -45,18 +45,18 @@ "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." } }, "type": "object" }, "Authentication": { "additionalProperties": false, - "description": "Contains the authentication information for the external service.", - "longDescription": "This type shall contain all the required information to authenticate to the external service.", + "description": "The information required to authenticate to the external service.", + "longDescription": "This type shall contain the information required to authenticate to the external service.", "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", @@ -79,13 +79,13 @@ "type": "null" } ], - "description": "This property contains the type of authentication used to connect to the external account provider.", - "longDescription": "The value of this property shall be the type of authentication used to connect to the external account provider.", + "description": "The type of authentication used to connect to the external account provider.", + "longDescription": "This property shall contain the type of authentication used to connect to the external account provider.", "readonly": false }, "KerberosKeytab": { - "description": "This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET.", - "longDescription": "The value of this property shall be a base64 encoded version of the kerberos keytab for this account service. The value shall be null for GET requests.", + "description": "The Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. This property is `null` in responses.", + "longDescription": "This property shall contain a Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. The value shall be `null` in responses.", "readonly": false, "type": [ "string", @@ -94,12 +94,12 @@ }, "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." }, "Password": { - "description": "This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET.", - "longDescription": "The value of this property shall be the password for this account service. The value shall be null for GET requests.", + "description": "The password for this Service. A PATCH or PUT request writes the password. This property is `null` in responses.", + "longDescription": "This property shall contain the password for this Service. A PATCH or PUT operation writes the password. The value shall be `null` in responses.", "readonly": false, "type": [ "string", @@ -107,8 +107,8 @@ ] }, "Token": { - "description": "This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET.", - "longDescription": "The value of this property shall be the token for this account service. The value shall be null for GET requests.", + "description": "The token for this Service. A PATCH or PUT operation writes the token. This property is `null` in responses.", + "longDescription": "This property shall contain the token for this Service. A PATCH or PUT operation writes the token. The value shall be `null` in responses.", "readonly": false, "type": [ "string", @@ -116,8 +116,8 @@ ] }, "Username": { - "description": "This property contains the user name for the account service.", - "longDescription": "The value of this property shall be the user name for this account service.", + "description": "The user name for the Service.", + "longDescription": "This property shall contain the user name for this Service.", "readonly": false, "type": "string" } @@ -132,19 +132,19 @@ "OEM" ], "enumDescriptions": { - "KerberosKeytab": "A kerberos keytab.", - "OEM": "An OEM specific authentication mechanism.", + "KerberosKeytab": "A Kerberos keytab.", + "OEM": "An OEM-specific authentication mechanism.", "Token": "An opaque authentication token.", - "UsernameAndPassword": "Username and password combination." + "UsernameAndPassword": "A user name and password combination." }, "type": "string" }, "ExternalAccountProvider": { "additionalProperties": false, - "description": "A remote service that can provide accounts for this manager to utilize for authentication.", - "longDescription": "This resource shall be used to represent resources that represent external user account services for this manager.", + "description": "The remote service that provides accounts for this manager to use for authentication.", + "longDescription": "The ExternalAccountProvider Schema contains Resources that represent external user account services for this manager.", "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", @@ -159,16 +159,16 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AccountProviderType": { "anyOf": [ @@ -179,31 +179,24 @@ "type": "null" } ], - "description": "This property contains the type of external account provider this resource references.", - "longDescription": "The value of this property shall be the type of external account provider referenced by this resource.", + "description": "The type of external account provider to which this Service connects.", + "longDescription": "This property shall contain the type of external account provider to which this Service connects.", "readonly": true }, "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." }, "Authentication": { - "anyOf": [ - { - "$ref": "#/definitions/Authentication" - }, - { - "type": "null" - } - ], - "description": "This property contains the authentication information for the external account provider.", - "longDescription": "The value of this property shall contain the authentication information for the external account provider." + "$ref": "#/definitions/Authentication", + "description": "The authentication information for the external account provider.", + "longDescription": "This property shall contain the authentication information for the external account provider." }, "Certificates": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "This is a reference to a collection of certificates used for the external account provider.", - "longDescription": "The value of this property shall be a link to a collection of type CertificateCollection.", + "description": "The link to a collection of certificates that the external account provider uses.", + "longDescription": "This property shall contain a link to a Resource Collection of type CertificateCollection.", "readonly": true, "versionAdded": "v1_1_0" }, @@ -223,21 +216,14 @@ "readonly": true }, "LDAPService": { - "anyOf": [ - { - "$ref": "#/definitions/LDAPService" - }, - { - "type": "null" - } - ], - "description": "This property contains additional mapping information needed to parse a generic LDAP service.", - "longDescription": "The value of this property shall contain any additional mapping information needed to parse a generic LDAP service." + "$ref": "#/definitions/LDAPService", + "description": "The additional mapping information needed to parse a generic LDAP service.", + "longDescription": "This property shall contain any additional mapping information needed to parse a generic LDAP service. This property should only be present if AccountProviderType is LDAPService." }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-define Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -245,11 +231,11 @@ }, "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." }, "RemoteRoleMapping": { - "description": "This property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role.", + "description": "The mapping rules to convert the external account providers account information to the local Redfish Role.", "items": { "anyOf": [ { @@ -264,20 +250,20 @@ "type": "array" }, "ServiceAddresses": { - "description": "This property contains the addresses of the user account providers this resource references. The format of this field depends on the Type.", + "description": "The addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be the addresses of the account providers this resource references. The format of this field depends on the Type of the ExternalAccountProvider. Each item in the array shall contain a single address. Services may define their own behavior for managing multiple addresses.", + "longDescription": "This property shall contain the addresses of the account providers to which this external account provider links. The format of this field depends on the type of external account provider. Each item in the array shall contain a single address. Services may define their own behavior for managing multiple addresses.", "readonly": false, "type": "array" }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -298,10 +284,10 @@ }, "LDAPSearchSettings": { "additionalProperties": false, - "description": "Contains settings for searching a generic LDAP service.", - "longDescription": "This type shall contain all the required settings for searching a generic LDAP service.", + "description": "The settings to search a generic LDAP service.", + "longDescription": "This type shall contain all required settings to search a generic LDAP service.", "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", @@ -316,20 +302,20 @@ }, "properties": { "BaseDistinguishedNames": { - "description": "The base distinguished names to use when searching the LDAP service.", + "description": "The base distinguished names to search an external LDAP service.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be a collection of base distinguished names to use when searching the LDAP service.", + "longDescription": "This property shall contain a collection of base distinguished names to search an external LDAP service.", "readonly": false, "type": "array" }, "GroupNameAttribute": { - "description": "The attribute name that contains the name of the Group.", - "longDescription": "The value of this property shall be the attribute name that contains the name of the Group.", + "description": "The attribute name that contains the LDAP group name entry.", + "longDescription": "This property shall contain the attribute name that contains the LDAP group name.", "readonly": false, "type": [ "string", @@ -337,8 +323,8 @@ ] }, "GroupsAttribute": { - "description": "The attribute name that contains the Groups for a user.", - "longDescription": "The value of this property shall be the attribute name that contains the Groups for a user.", + "description": "The attribute name that contains the groups for a user on the LDAP user entry.", + "longDescription": "This property shall contain the attribute name that contains the groups for an LDAP user entry.", "readonly": false, "type": [ "string", @@ -346,8 +332,8 @@ ] }, "UsernameAttribute": { - "description": "The attribute name that contains the Username.", - "longDescription": "The value of this property shall be the attribute name that contains the Username.", + "description": "The attribute name that contains the LDAP user name entry.", + "longDescription": "This property shall contain the attribute name that contains the LDAP user name.", "readonly": false, "type": [ "string", @@ -359,10 +345,10 @@ }, "LDAPService": { "additionalProperties": false, - "description": "Contains settings for parsing a generic LDAP service.", - "longDescription": "This type shall contain all the required settings for parsing a generic LDAP service.", + "description": "The settings required to parse a generic LDAP service.", + "longDescription": "This type shall contain all required settings to parse a generic LDAP service.", "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", @@ -378,30 +364,23 @@ "properties": { "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." }, "SearchSettings": { - "anyOf": [ - { - "$ref": "#/definitions/LDAPSearchSettings" - }, - { - "type": "null" - } - ], - "description": "This property contains the settings needed to search an external LDAP service.", - "longDescription": "The value of this property shall contain the settings needed to search an external LDAP service." + "$ref": "#/definitions/LDAPSearchSettings", + "description": "The required settings to search an external LDAP service.", + "longDescription": "This property shall contain the required settings to search an external LDAP service." } }, "type": "object" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -417,18 +396,18 @@ "properties": { "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." } }, "type": "object" }, "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", @@ -446,10 +425,10 @@ }, "RoleMapping": { "additionalProperties": false, - "description": "Contains mapping rules to convert the external account providers account information to the local Redfish Role.", + "description": "The mapping rules to convert the external account providers account information to the local Redfish Role.", "longDescription": "This type shall contain mapping rules to convert the external account providers account information to the local Redfish Role.", "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", @@ -464,8 +443,8 @@ }, "properties": { "LocalRole": { - "description": "The name of the local role in which to map the remote user or group.", - "longDescription": "The value of this property shall contain the value of the RoleId property within a Role resource on this Redfish service in which to map the remote user or group.", + "description": "The name of the local Redfish Role to which to map the remote user or group.", + "longDescription": "This property shall contain the RoleId property value within a Role Resource on this Redfish Service to which to map the remote user or group.", "readonly": false, "type": [ "string", @@ -474,12 +453,12 @@ }, "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." }, "RemoteGroup": { - "description": "This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.", - "longDescription": "The value of this property shall contain the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.", + "description": "The name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.", + "longDescription": "This property shall contain the name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.", "readonly": false, "type": [ "string", @@ -487,8 +466,8 @@ ] }, "RemoteUser": { - "description": "This property is the name of the remote user that will be mapped to the local role referenced by this entity.", - "longDescription": "The value of this property shall contain the name of the remote user that will be mapped to the local role referenced by this entity.", + "description": "The name of the remote user that maps to the local Redfish Role to which this entity links.", + "longDescription": "This property shall contain the name of the remote user that maps to the local Redfish Role to which this entity links.", "readonly": false, "type": [ "string", @@ -501,5 +480,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#ExternalAccountProvider.v1_1_0.ExternalAccountProvider" + "title": "#ExternalAccountProvider.v1_1_2.ExternalAccountProvider" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Fabric/Fabric.json b/static/redfish/v1/JsonSchemas/Fabric/Fabric.json index 2ec87982fa..67ec5c2fa2 100644 --- a/static/redfish/v1/JsonSchemas/Fabric/Fabric.json +++ b/static/redfish/v1/JsonSchemas/Fabric/Fabric.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Fabric.v1_0_6.json", "$ref": "#/definitions/Fabric", "$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,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." } }, "type": "object" @@ -33,9 +34,9 @@ "Fabric": { "additionalProperties": false, "description": "The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.", - "longDescription": "This resource shall be used to represent a simple switchable fabric for a Redfish implementation.", + "longDescription": "This Resource shall represent a simple switchable fabric 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", @@ -50,21 +51,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -79,8 +80,8 @@ }, "Endpoints": { "$ref": "http://redfish.dmtf.org/schemas/v1/EndpointCollection.json#/definitions/EndpointCollection", - "description": "A collection of references to the endpoints contained in this fabric.", - "longDescription": "The value of this property shall be a reference to the resources that this fabric uses and shall reference a resource of type Endpoint.", + "description": "The collection of links to the endpoints that this fabric contains.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type that this fabric uses.", "readonly": true }, "FabricType": { @@ -93,7 +94,7 @@ } ], "description": "The protocol being sent over this fabric.", - "longDescription": "The value of this property shall contain the type of fabric being represented by this simple fabric.", + "longDescription": "This property shall contain the type of fabric being represented by this simple fabric.", "readonly": true }, "Id": { @@ -102,12 +103,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "MaxZones": { - "description": "The value of this property shall contain the maximum number of zones the switch can currently configure.", - "longDescription": "The value of this property shall contain the maximum number of zones the switch can currently configure. This value can change based on changes in the logical or physical configuration of the system.", + "description": "The maximum number of zones the switch can currently configure.", + "longDescription": "This property shall contain the maximum number of zones the switch can currently configure. This value may change based on changes in the logical or physical configuration of the system.", "readonly": true, "type": [ "integer", @@ -120,24 +121,24 @@ }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Switches": { "$ref": "http://redfish.dmtf.org/schemas/v1/SwitchCollection.json#/definitions/SwitchCollection", - "description": "A collection of references to the switches contained in this fabric.", - "longDescription": "The value of this property shall be a reference to the resources that this fabric uses and shall reference a resource of type Switch.", + "description": "The collection of links to the switches that this fabric contains.", + "longDescription": "This property shall contain a link to the Resources of the Switch type that this fabric uses.", "readonly": true }, "Zones": { "$ref": "http://redfish.dmtf.org/schemas/v1/ZoneCollection.json#/definitions/ZoneCollection", - "description": "A collection of references to the zones contained in this fabric.", - "longDescription": "The value of this property shall be a reference to the resources that this fabric uses and shall reference a resource of type Zone.", + "description": "The collection of links to the zones that this fabric contains.", + "longDescription": "This property shall contain a link to the Resources of the Zone type that this fabric uses.", "readonly": true } }, @@ -151,10 +152,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -170,18 +171,18 @@ "properties": { "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." } }, "type": "object" }, "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", @@ -199,5 +200,6 @@ } }, "owningEntity": "DMTF", - "title": "#Fabric.v1_0_4.Fabric" + "release": "2016.2", + "title": "#Fabric.v1_0_6.Fabric" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/HostInterface/HostInterface.json b/static/redfish/v1/JsonSchemas/HostInterface/HostInterface.json index 91fb3ffd20..c3cbe8b164 100644 --- a/static/redfish/v1/JsonSchemas/HostInterface/HostInterface.json +++ b/static/redfish/v1/JsonSchemas/HostInterface/HostInterface.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/HostInterface.v1_2_2.json", "$ref": "#/definitions/HostInterface", "$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" @@ -47,10 +49,10 @@ }, "HostInterface": { "additionalProperties": false, - "description": "This schema defines a single Host Interface resource.", - "longDescription": "This resource shall be used to represent Host Interface resources as part of the Redfish specification.", + "description": "The properties associated with a Host Interface. A Host Interface is a connection between host software and a Redfish Service.", + "longDescription": "This Resource shall represent a Host Interface as part of the Redfish Specification.", "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", @@ -65,34 +67,36 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AuthNoneRoleId": { - "description": "The Role used when no authentication on this interface is used.", - "longDescription": "The value of this property shall be the ID of the Role resource that is used when no authentication on this interface is performed. This property shall be absent if AuthNone is not supported by the service for the AuthenticationModes property.", + "description": "The role when no authentication on this interface is used.", + "longDescription": "This property shall contain the Id property of the Role Resource that is used when no authentication on this interface is performed. This property shall contain absent if AuthNone is not supported by the service for the AuthenticationModes property.", "readonly": false, - "type": "string" + "type": "string", + "versionAdded": "v1_2_0" }, "AuthenticationModes": { - "description": "Indicates the authentication modes available on this interface.", + "description": "The authentication modes available on this interface.", "items": { "$ref": "#/definitions/AuthenticationMode" }, - "longDescription": "The value of this property shall be an array consisting of the authentication modes allowed on this interface.", + "longDescription": "This property shall contain an array consisting of the authentication modes allowed on this interface.", "readonly": false, "type": "array" }, @@ -108,8 +112,8 @@ "readonly": true }, "ExternallyAccessible": { - "description": "Indicates whether this interface is accessible by external entities.", - "longDescription": "The value of this property shall be a boolean indicating whether this interface is accessible by external (non-host) entities. For example, if the host and manager are connected via a switch, and the switch also exposes an external port on the system, then the interface could also be used by external clients, and this property will have the value set to true.", + "description": "An indication of whether external entities can access this interface. External entities are non-host entities. For example, if the host and manager are connected through a switch and the switch also exposes an external port on the system, external clients can also use the interface, and this property value is `true`.", + "longDescription": "This property shall indicate whether external entities can access this interface. External entities are non-host entities. For example, if the host and manager are connected through a switch and the switch also exposes an external port on the system, external clients can also use the interface, and this property value is `true`.", "readonly": true, "type": [ "boolean", @@ -117,8 +121,8 @@ ] }, "FirmwareAuthEnabled": { - "description": "Indicates whether this firmware authentication is enabled for this interface.", - "longDescription": "The value of this property shall be a boolean indicating whether firmware authentication for this interface is enabled.", + "description": "An indication of whether this firmware authentication is enabled for this interface.", + "longDescription": "This property shall indicate whether firmware authentication is enabled for this interface.", "readonly": false, "type": [ "boolean", @@ -127,14 +131,14 @@ }, "FirmwareAuthRoleId": { "description": "The Role used for firmware authentication on this interface.", - "longDescription": "The value of this property shall be the ID of the Role resource that is configured for firmware authentication on this interface.", + "longDescription": "This property shall contain the Id property of the Role Resource that is configured for firmware authentication on this interface.", "readonly": false, "type": "string" }, "HostEthernetInterfaces": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection", - "description": "The Redfish link to the collection of network interface controllers or cards (NICs) that a Computer System uses to communicate with this Host Interface.", - "longDescription": "The value of this property shall be a link to a collection of type EthernetInterfaceCollection that Computer Systems use as the Host Interface to this Manager.", + "description": "A link to the collection of network interface controllers or cards (NICs) that a computer system uses to communicate with this Host Interface.", + "longDescription": "This property shall contain a link to a Resource Collection of type EthernetInterface that computer systems use as the Host Interface to this manager.", "readonly": true }, "HostInterfaceType": { @@ -146,8 +150,8 @@ "type": "null" } ], - "description": "Indicates the Host Interface type for this interface.", - "longDescription": "The value of this property shall be an enumeration describing type of the interface.", + "description": "The Host Interface type for this interface.", + "longDescription": "This property shall contain an enumeration that describes the type of the interface.", "readonly": true }, "Id": { @@ -155,8 +159,8 @@ "readonly": true }, "InterfaceEnabled": { - "description": "Indicates whether this interface is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled.", + "description": "An indication of whether this interface is enabled.", + "longDescription": "This property shall indicate whether this interface is enabled.", "readonly": false, "type": [ "boolean", @@ -164,8 +168,8 @@ ] }, "KernelAuthEnabled": { - "description": "Indicates whether this kernel authentication is enabled for this interface.", - "longDescription": "The value of this property shall be a boolean indicating whether kernel authentication for this interface is enabled.", + "description": "An indication of whether this kernel authentication is enabled for this interface.", + "longDescription": "This property shall indicate whether kernel authentication is enabled for this interface.", "readonly": false, "type": [ "boolean", @@ -174,19 +178,19 @@ }, "KernelAuthRoleId": { "description": "The Role used for kernel authentication on this interface.", - "longDescription": "The value of this property shall be the ID of the Role resource that is configured for kernel authentication on this interface.", + "longDescription": "This property shall contain the Id property of the Role Resource that is configured for kernel authentication on this interface.", "readonly": false, "type": "string" }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "ManagerEthernetInterface": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface", - "description": "The Redfish link to a single network interface controllers or cards (NIC) that this Manager uses for network communication with this Host Interface.", - "longDescription": "The value of this property shall be a link to a resource of type EthernetInterface which represents the network interface used by this Manager as the HostInterface.", + "description": "A link to a single network interface controllers or cards (NIC) that this manager uses for network communication with this Host Interface.", + "longDescription": "This property shall contain a link to a Resource of type EthernetInterface that represents the network interface that this manager uses as the Host Interface.", "readonly": true }, "Name": { @@ -195,19 +199,19 @@ }, "NetworkProtocol": { "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.json#/definitions/ManagerNetworkProtocol", - "description": "The Redfish link to the network services and their settings that the Manager controls. It is here that clients will find network configuration options as well as network services.", - "longDescription": "The value of this property shall contain a reference to a resource of type ManagerNetworkProtocol which represents the network services for this Manager.", + "description": "A link to the network services and their settings that the manager controls. In this property, clients find configuration options for the network and network services.", + "longDescription": "This property shall contain a link to a Resource of type ManagerNetworkProtocol that represents the network services for this manager.", "readonly": true }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -229,10 +233,10 @@ }, "Links": { "additionalProperties": false, - "description": "References to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "References to other Resources related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -248,48 +252,49 @@ "properties": { "AuthNoneRole": { "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", - "description": "A reference to the Role that contains the privileges on this Host Interface when no authentication is performed.", - "longDescription": "The value of this property shall be a link to a Role object instance, and should reference the object identified by property AuthNoneRoleId. This property shall be absent if AuthNone is not supported by the service for the AuthenticationModes property.", - "readonly": true + "description": "The link to the Redfish Role that contains the privileges on this Host Interface when no authentication is performed.", + "longDescription": "This property shall contain a link to a Resource of type Role, and should link to the Resource identified by property AuthNoneRoleId. This property shall be absent if AuthNone is not supported by the service for the AuthenticationModes property.", + "readonly": true, + "versionAdded": "v1_2_0" }, "ComputerSystems": { - "description": "An array of references to the Computer Systems connected to this Host Interface.", + "description": "An array of links to the computer systems connected to this Host Interface.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "The value of this property shall be an array of references to resources of type ComputerSystem that are connected to this HostInterface.", + "longDescription": "This property shall contain an array of links to Resources of the ComputerSystem type that are connected to this Host Interface.", "readonly": true, "type": "array" }, "ComputerSystems@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "FirmwareAuthRole": { "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", - "description": "A reference to the Role that has firmware authentication privileges on this Host Interface.", - "longDescription": "The value of this property shall be a link to a Role object instance, and should reference the object identified by property FirmwareAuthRoleId.", + "description": "The link to the Redfish Role that has firmware authentication privileges on this Host Interface.", + "longDescription": "This property shall contain a link to a Resource of type Role, and should link to the Resource identified by property FirmwareAuthRoleId.", "readonly": true }, "KernelAuthRole": { "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", - "description": "A reference to the Role object defining Privileges for this Host Interface when using kernel authentication.", - "longDescription": "The value of this property shall be a link to a Role object instance, and should reference the object identified by property KernelAuthRoleId.", + "description": "The link to the Redfish Role defining privileges for this Host Interface when using kernel authentication.", + "longDescription": "This property shall contain a link to a Resource of type Role, and should link to the Resource identified by property KernelAuthRoleId.", "readonly": true }, "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." } }, "type": "object" }, "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", @@ -307,5 +312,6 @@ } }, "owningEntity": "DMTF", - "title": "#HostInterface.v1_2_0.HostInterface" + "release": "2018.2", + "title": "#HostInterface.v1_2_2.HostInterface" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json b/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json index be79b1a30e..738ac27a9f 100644 --- a/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json +++ b/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json @@ -1,6 +1,7 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/IPAddresses.v1_1_1.json", "$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": { "AddressState": { "enum": [ @@ -10,19 +11,19 @@ "Failed" ], "enumDescriptions": { - "Deprecated": "This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862.", - "Failed": "This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use.", - "Preferred": "This address is currently within both it's valid and preferred lifetimes as defined in RFC 4862.", - "Tentative": "This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4." + "Deprecated": "This address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime.", + "Failed": "This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use.", + "Preferred": "This address is currently within both its RFC4862-defined valid and preferred lifetimes.", + "Tentative": "This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4." }, "type": "string" }, "IPv4Address": { "additionalProperties": false, - "description": "This type describes an IPv4 Address.", + "description": "This type describes an IPv4 address.", "longDescription": "This type shall describe an IPv4 address assigned to an interface.", "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", @@ -37,8 +38,8 @@ }, "properties": { "Address": { - "description": "This is the IPv4 Address.", - "longDescription": "The value of this property shall be an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.", + "description": "The IPv4 address.", + "longDescription": "This property shall contain an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.", "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", "readonly": false, "type": [ @@ -56,12 +57,12 @@ } ], "description": "This indicates how the address was determined.", - "longDescription": "The value of this property shall be the IP address origin for this network interface.", + "longDescription": "This property shall contain the IP address origin for this network interface.", "readonly": true }, "Gateway": { - "description": "This is the IPv4 gateway for this address.", - "longDescription": "The value of this property shall be the IPv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the IPv4 default gateway address, this property becomes read-only.", + "description": "The IPv4 gateway for this address.", + "longDescription": "This property shall contain the IPv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the IPv4 default gateway address, this property becomes read-only.", "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", "readonly": false, "type": [ @@ -71,8 +72,8 @@ }, "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." }, "SubnetMask": { "anyOf": [ @@ -83,8 +84,8 @@ "type": "null" } ], - "description": "This is the IPv4 Subnet mask.", - "longDescription": "The value of this property shall be the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.", + "description": "The IPv4 subnet mask.", + "longDescription": "This property shall contain the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.", "readonly": false } }, @@ -98,19 +99,19 @@ "IPv4LinkLocal" ], "enumDescriptions": { - "BOOTP": "Address is provided by a BOOTP service.", - "DHCP": "Address is provided by a DHCPv4 service.", - "IPv4LinkLocal": "Address is valid only for this network segment (link).", - "Static": "A static address as configured by the user." + "BOOTP": "A BOOTP service-provided address.", + "DHCP": "A DHCPv4 service-provided address.", + "IPv4LinkLocal": "The address is valid for only this network segment, or link.", + "Static": "A user-configured static address." }, "type": "string" }, "IPv6Address": { "additionalProperties": false, - "description": "This type describes an IPv6 Address.", + "description": "This type describes an IPv6 address.", "longDescription": "This type shall describe an IPv6 address assigned to an interface.", "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", @@ -125,7 +126,7 @@ }, "properties": { "Address": { - "description": "This is the IPv6 Address.", + "description": "The IPv6 address.", "longDescription": "This property lists an IPv6 address that is currently assigned on this interface.", "readonly": false, "type": [ @@ -143,7 +144,7 @@ } ], "description": "This indicates how the address was determined.", - "longDescription": "The value of this property shall be the IPv6 address origin for this interface.", + "longDescription": "This property shall contain the IPv6 address origin for this interface.", "readonly": true }, "AddressState": { @@ -155,14 +156,14 @@ "type": "null" } ], - "description": "The current state of this address as defined in RFC 4862.", - "longDescription": "Preferred and Deprecated states follow the definitions given RFC4862 Section 5.5.4. An address is in the Tentative state while undergoing Duplicate Address Detection (DAD) per RFC4862 Section 5.4. The Failed state indicates a Static addresses which did not pass DAD. A Static address in the Failed state is not in use on the network stack, and corrective action will be needed to remedy this condition.", + "description": "The current RFC4862-defined state of this address.", + "longDescription": "This property shall contain the current RFC4862-defined state of this address. Preferred and Deprecated states follow the definitions in RFC4862, section 5.5.4. The Tentative state indicates that the address is undergoing Duplicate Address Detection (DAD), as defined in RFC4862, section 5.4. The Failed state indicates a static address that did not pass DAD. A static address in the Failed state is not in use on the network stack, and corrective action is required to remedy this condition.", "readonly": true }, "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." }, "PrefixLength": { "anyOf": [ @@ -173,8 +174,8 @@ "type": "null" } ], - "description": "This is the IPv6 Address Prefix Length.", - "longDescription": "The value of this property shall be the IPv6 address prefix length for this interface.", + "description": "The IPv6 address prefix Length.", + "longDescription": "This property shall contain the IPv6 address prefix length for this interface.", "readonly": true } }, @@ -188,19 +189,19 @@ "SLAAC" ], "enumDescriptions": { - "DHCPv6": "Address is provided by a DHCPv6 service.", - "LinkLocal": "Address is valid only for this network segment (link).", - "SLAAC": "Address is provided by a Stateless Address AutoConfiguration (SLAAC) service.", - "Static": "A static address as configured by the user." + "DHCPv6": "A DHCPv6 service-provided address.", + "LinkLocal": "The address is valid for only this network segment, or link.", + "SLAAC": "A stateless autoconfiguration (SLAAC) service-provided address.", + "Static": "A static user-configured address." }, "type": "string" }, "IPv6GatewayStaticAddress": { "additionalProperties": false, - "description": "This object represents a single IPv6 static address to be assigned on a network interface.", + "description": "This type represents a single IPv6 static address to be assigned on a network interface.", "longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.", "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", @@ -221,12 +222,14 @@ "type": [ "string", "null" - ] + ], + "versionAdded": "v1_1_0" }, "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_1_0" }, "PrefixLength": { "anyOf": [ @@ -237,9 +240,10 @@ "type": "null" } ], - "description": "The Prefix Length of this IPv6 address.", - "longDescription": "Provides the IPv6 network prefix length in bits for this address.", - "readonly": false + "description": "The IPv6 network prefix length, in bits, for this address.", + "longDescription": "Provides the IPv6 network prefix length, in bits, for this address.", + "readonly": false, + "versionAdded": "v1_1_0" } }, "required": [ @@ -249,10 +253,10 @@ }, "IPv6StaticAddress": { "additionalProperties": false, - "description": "This object represents a single IPv6 static address to be assigned on a network interface.", + "description": "This type represents a single IPv6 static address to be assigned on a network interface.", "longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.", "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", @@ -277,8 +281,8 @@ }, "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." }, "PrefixLength": { "anyOf": [ @@ -289,8 +293,8 @@ "type": "null" } ], - "description": "The Prefix Length of this IPv6 address.", - "longDescription": "Provides the IPv6 network prefix length in bits for this address.", + "description": "The prefix length, in bits, of this IPv6 address.", + "longDescription": "This property shall contain the IPv6 network prefix length, in bits, for this address.", "readonly": false } }, @@ -311,5 +315,6 @@ } }, "owningEntity": "DMTF", - "title": "#IPAddresses.v1_1_0" + "release": "2018.2", + "title": "#IPAddresses.v1_1_1" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Job/Job.json b/static/redfish/v1/JsonSchemas/Job/Job.json index c38dc6f270..9e5ddbf6bb 100644 --- a/static/redfish/v1/JsonSchemas/Job/Job.json +++ b/static/redfish/v1/JsonSchemas/Job/Job.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Job.v1_0_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Job.v1_0_3.json", "$ref": "#/definitions/Job", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "Job": { "additionalProperties": false, - "description": "This resource contains information about a specific Job scheduled or being executed by a Redfish service's Job Service.", - "longDescription": "This resource shall be used to represent a job in a Redfish implementation.", + "description": "The Job schema contains information about a job that a a Redfish Job Service schedules or executes. Clients create jobs to describe a series of operations that occur at periodic intervals.", + "longDescription": "This Resource shall contain a job in 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,25 +51,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "CreatedBy": { "description": "The person or program that created this job entry.", - "longDescription": "The value of this property shall be the user name, software program name, or other identifier indicating the creator of this job.", + "longDescription": "This property shall contain the user name, software program name, or other identifier indicating the creator of this job.", "readonly": true, "type": "string" }, @@ -85,18 +85,15 @@ "readonly": true }, "EndTime": { - "description": "The date-time stamp that the job was completed.", + "description": "The date and time when the job was completed.", "format": "date-time", - "longDescription": "The value of this property shall indicate the time the job was completed. This property shall not appear if the job is running or has otherwise not been completed. This property shall appear only if the JobState is Completed, Cancelled, or Exception.", + "longDescription": "This property shall indicate the date and time when the job was completed. This property shall not appear if the job is running or was not completed. This property shall appear only if the JobState is Completed, Cancelled, or Exception.", "readonly": true, - "type": [ - "string", - "null" - ] + "type": "string" }, "HidePayload": { - "description": "Indicates that the contents of the Payload should be hidden from view after the Job has been created. When set to True, the Payload object will not be returned on GET.", - "longDescription": "This property shall be set to True if the Payload object shall not be returned on GET operations, and set to False if the contents can be returned normally. If this property is not specified when the Job is created, the default value shall be False.", + "description": "An indication of whether the contents of the payload should be hidden from view after the job has been created. If `true`, responses do not return the payload. If `false`, responses return the payload. If this property is not present when the job is created, the default is `false`.", + "longDescription": "This property shall indicate whether the contents of the payload should be hidden from view after the job has been created. If `true`, responses shall not return the Payload property. If `false`, responses shall return the Payload property. If this property is not present when the job is created, the default is `false`.", "readonly": true, "type": "boolean" }, @@ -107,13 +104,13 @@ "JobState": { "$ref": "#/definitions/JobState", "description": "The state of the job.", - "longDescription": "The value of this property shall indicate the state of the job.", + "longDescription": "This property shall indicate the state of the job.", "readonly": false }, "JobStatus": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health", "description": "The status of the job.", - "longDescription": "The value of this property shall indicate the health status of the job.", + "longDescription": "This property shall indicate the health status of the job.", "readonly": true }, "MaxExecutionTime": { @@ -126,11 +123,11 @@ ] }, "Messages": { - "description": "This is an array of messages associated with the job.", + "description": "An array of messages associated with the job.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message" }, - "longDescription": "The value of this property shall be an array of messages associated with the job.", + "longDescription": "This property shall contain an array of messages associated with the job.", "type": "array" }, "Name": { @@ -139,17 +136,17 @@ }, "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." }, "Payload": { "$ref": "#/definitions/Payload", "description": "The HTTP and JSON payload details for this job.", - "longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this job. This object shall not be included in the response if the HidePayload property is set to True." + "longDescription": "This property shall contain the HTTP and JSON payload information for executing this job. This property shall not be included in the response if the HidePayload property is `true`." }, "PercentComplete": { "description": "The completion percentage of this job.", - "longDescription": "The value of this property shall indicate the completion progress of the job, reported in percent of completion. If the job has not been started, the value shall be zero.", + "longDescription": "This property shall indicate the completion progress of the job, reported in percent of completion. If the job has not been started, the value shall be zero.", "readonly": true, "type": [ "integer", @@ -159,29 +156,29 @@ }, "Schedule": { "$ref": "http://redfish.dmtf.org/schemas/v1/Schedule.json#/definitions/Schedule", - "description": "The Schedule Settings for this Job.", - "longDescription": "This object shall contain information detailing the scheduling for this job and the re-occurrence frequency for future instances of this job." + "description": "The schedule settings for this job.", + "longDescription": "This object shall contain the scheduling details for this job and the recurrence frequency for future instances of this job." }, "StartTime": { - "description": "The date-time stamp that the job was started or is scheduled to start.", + "description": "The date and time when the job was started or is scheduled to start.", "format": "date-time", - "longDescription": "The value of this property shall indicate the time the job was last started or will start as scheduled.", + "longDescription": "This property shall indicate the date and time when the job was last started or is scheduled to start.", "readonly": true, "type": "string" }, "StepOrder": { - "description": "This represents the serialized execution order of the Job Steps.", + "description": "The serialized execution order of the job Steps.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be an array of Ids for the Job Steps in the order that they shall be executed. Each step shall be completed prior to the execution of the next step in array order. An incomplete list of steps shall be considered an invalid configuration. If this property is not present or contains an empty array it shall indicate that the step execution order is not specified and may occur in parallel or in series as determined by the service.", + "longDescription": "This property shall contain an array of IDs for the job steps in the order that they shall be executed. Each step shall be completed prior to the execution of the next step in array order. An incomplete list of steps shall be considered an invalid configuration. If this property is not present or contains an empty array it shall indicate that the step execution order is omitted and may occur in parallel or in series as determined by the service.", "readonly": true, "type": "array" }, "Steps": { "$ref": "http://redfish.dmtf.org/schemas/v1/JobCollection.json#/definitions/JobCollection", - "description": "A link to a collection of Steps for this Job.", - "longDescription": "This property shall contain the link to a collection of type Job.", + "description": "The link to a collection of steps for this job.", + "longDescription": "This property shall contain the link to a Resource Collection of type JobCollection.", "readonly": true } }, @@ -210,8 +207,8 @@ "Continue" ], "enumDescriptions": { - "Cancelled": "Job was cancelled..", - "Completed": "Job has completed.", + "Cancelled": "Job was cancelled.", + "Completed": "Job was completed.", "Continue": "Job is to resume operation.", "Exception": "Job has stopped due to an exception condition.", "Interrupted": "Job has been interrupted.", @@ -225,10 +222,10 @@ "UserIntervention": "Job is waiting for user intervention." }, "enumLongDescriptions": { - "Cancelled": "This value shall represent that the operation is complete because the job was cancelled by an operator.", - "Completed": "This value shall represent that the operation is complete and completed successfully or with warnings.", + "Cancelled": "This value shall represent that the operation completed because the job was cancelled by an operator.", + "Completed": "This value shall represent that the operation completed successfully or with warnings.", "Continue": "This value shall represent that the operation has been resumed from a paused condition and should return to a Running state.", - "Exception": "This value shall represent that the operation is complete and completed with errors.", + "Exception": "This value shall represent that the operation completed with errors.", "Interrupted": "This value shall represent that the operation has been interrupted but is expected to restart and is therefore not complete.", "New": "This value shall represent that this job is newly created but the operation has not yet started.", "Pending": "This value shall represent that the operation is pending some condition and has not yet begun to execute.", @@ -237,16 +234,16 @@ "Starting": "This value shall represent that the operation is starting.", "Stopping": "This value shall represent that the operation is stopping but is not yet complete.", "Suspended": "This value shall represent that the operation has been suspended but is expected to restart and is therefore not complete.", - "UserIntervention": "This value shall represent that the operation is waiting for a user to intervene and must be manually continued, stopped or cancelled." + "UserIntervention": "This value shall represent that the operation is waiting for a user to intervene and must be manually continued, stopped, or cancelled." }, "type": "string" }, "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", @@ -267,7 +264,7 @@ "description": "The HTTP and JSON payload details for this job.", "longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this job.", "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", @@ -282,30 +279,30 @@ }, "properties": { "HttpHeaders": { - "description": "This represents the HTTP headers used in the operation of this job.", + "description": "An array of HTTP headers in this job.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be an array of HTTP headers used in the execution of this job.", + "longDescription": "This property shall contain an array of HTTP headers in this job.", "readonly": true, "type": "array" }, "HttpOperation": { - "description": "The HTTP operation to perform to execute this job.", - "longDescription": "This property shall contain the HTTP operation to execute for this job.", + "description": "The HTTP operation that executes this job.", + "longDescription": "This property shall contain the HTTP operation that executes this job.", "readonly": true, "type": "string" }, "JsonBody": { - "description": "This property contains the JSON payload to use in the execution of this Job.", - "longDescription": "The value of this property shall be JSON formatted payload used for this job.", + "description": "The JSON payload to use in the execution of this job.", + "longDescription": "This property shall contain JSON-formatted payload for this job.", "readonly": true, "type": "string" }, "TargetUri": { - "description": "The URI of the target for this job.", - "format": "uri", - "longDescription": "This property shall contain a URI referencing a location to be used as the target for an HTTP operation.", + "description": "The link to the target for this job.", + "format": "uri-reference", + "longDescription": "This property shall contain link to a target location for an HTTP operation.", "readonly": true, "type": "string" } @@ -315,5 +312,5 @@ }, "owningEntity": "DMTF", "release": "2018.2", - "title": "#Job.v1_0_1.Job" + "title": "#Job.v1_0_3.Job" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/JobService/JobService.json b/static/redfish/v1/JsonSchemas/JobService/JobService.json index 3eff0f23d7..4e839e531e 100644 --- a/static/redfish/v1/JsonSchemas/JobService/JobService.json +++ b/static/redfish/v1/JsonSchemas/JobService/JobService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/JobService.v1_0_2.json", "$ref": "#/definitions/JobService", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "JobService": { "additionalProperties": false, - "description": "This is the schema definition for the Job Service. It represents the properties for the service itself and has links to the actual list of tasks.", - "longDescription": "This resource shall be used to represent a job service for a Redfish implementation.", + "description": "The Redfish Job Service enables the scheduling and execution of operations, represents the properties for the Job Service itself, and has links to the actual Resource Collection of Jobs.", + "longDescription": "This Resource shall represent a Job Service 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", @@ -50,26 +51,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "DateTime": { - "description": "The current DateTime (with offset) setting that the job service is using.", + "description": "The current date and time, with UTC offset, setting that the Job Service uses.", "format": "date-time", - "longDescription": "The value of this property shall represent the current DateTime value for the JobService, with offset from UTC, in Redfish Timestamp format.", + "longDescription": "This property shall represent the current DateTime value for the Job Service, with UTC offset, in Redfish Timestamp format.", "readonly": true, "type": [ "string", @@ -93,14 +94,14 @@ }, "Jobs": { "$ref": "http://redfish.dmtf.org/schemas/v1/JobCollection.json#/definitions/JobCollection", - "description": "References to the Jobs collection.", - "longDescription": "The value of this property shall be a link to a resource of type JobCollection.", + "description": "The links to the Jobs collection.", + "longDescription": "This property shall contain a link to a Resource of type JobCollection.", "readonly": true }, "Log": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService", - "description": "This is a reference to a Log Service used by the Job Service.", - "longDescription": "The value of this property shall contain a reference to a LogService for the use by this JobService.", + "description": "The link to a Log Service that the Job Service uses. This service may be a dedicated Log Service or a pointer a Log Service under another entity, such as Manager.", + "longDescription": "This property shall contain a link to a Log Service that this Job Service uses.", "readonly": true }, "Name": { @@ -109,17 +110,17 @@ }, "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." }, "ServiceCapabilities": { "$ref": "#/definitions/JobServiceCapabilities", - "description": "This object describes the supported capabilities of this Job Service implementation.", - "longDescription": "This type shall contain properties which describe the capabilities or supported features of this implementation of JobService." + "description": "The supported capabilities of this Job Service implementation.", + "longDescription": "This type shall contain properties that describe the capabilities or supported features of this implementation of a Job Service." }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -128,8 +129,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -142,10 +143,10 @@ }, "JobServiceCapabilities": { "additionalProperties": false, - "description": "This object describes the supported capabilities of this Job Service implementation.", - "longDescription": "This type shall contain properties which describe the capabilities or supported features of this implementation of JobService.", + "description": "The supported capabilities of this Job Service implementation.", + "longDescription": "This type shall contain properties that describe the capabilities or supported features of this implementation of a Job Service.", "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", @@ -160,8 +161,8 @@ }, "properties": { "MaxJobs": { - "description": "Maximum number of Jobs supported.", - "longDescription": "The value of this property shall be the maximum number of Job resources supported by the implementation.", + "description": "The maximum number of jobs supported.", + "longDescription": "This property shall contain the maximum number of jobs supported by the implementation.", "readonly": true, "type": [ "integer", @@ -169,8 +170,8 @@ ] }, "MaxSteps": { - "description": "Maximum number of Job Steps supported.", - "longDescription": "The value of this property shall be the maximum number of Step resources supported by a single Job instance.", + "description": "The maximum number of job steps supported.", + "longDescription": "This property shall contain the maximum number of steps supported by a single job instance.", "readonly": true, "type": [ "integer", @@ -178,8 +179,8 @@ ] }, "Scheduling": { - "description": "Indicates whether scheduling of Jobs is supported.", - "longDescription": "The value of this property shall indicate the support of scheduling of Jobs using the Schedule object within the Job resource.", + "description": "An indication of whether scheduling of jobs is supported.", + "longDescription": "This property shall indicate whether the Schedule property within the job supports scheduling of jobs.", "readonly": true, "type": [ "boolean", @@ -191,10 +192,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", @@ -212,5 +213,6 @@ } }, "owningEntity": "DMTF", - "title": "#JobService.v1_0_0.JobService" + "release": "2018.2", + "title": "#JobService.v1_0_2.JobService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/JsonSchemaFile/JsonSchemaFile.json b/static/redfish/v1/JsonSchemas/JsonSchemaFile/JsonSchemaFile.json index e5465ae27a..cb8c4e9c78 100644 --- a/static/redfish/v1/JsonSchemas/JsonSchemaFile/JsonSchemaFile.json +++ b/static/redfish/v1/JsonSchemas/JsonSchemaFile/JsonSchemaFile.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/JsonSchemaFile.v1_1_2.json", + "$id": "http://redfish.dmtf.org/schemas/v1/JsonSchemaFile.v1_1_4.json", "$ref": "#/definitions/JsonSchemaFile", "$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 @@ }, "JsonSchemaFile": { "additionalProperties": false, - "description": "This is the schema definition for the Schema File locator resource.", - "longDescription": "This resource shall be used to represent the Schema File locator resource for a Redfish implementation.", + "description": "The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.", + "longDescription": "This Resource shall represent the schema file locator Resource 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", @@ -52,21 +52,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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,11 +85,11 @@ "readonly": true }, "Languages": { - "description": "Language codes for the schemas available.", + "description": "The RFC5646-conformant language codes for the available schemas.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be a string consisting of an RFC 5646 language code.", + "longDescription": "This property contains a set of RFC5646-conformant language codes.", "readonly": true, "type": "array" }, @@ -107,12 +107,12 @@ }, "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." }, "Schema": { "description": "The @odata.type name this schema describes.", - "longDescription": "The value of this property shall be the value of the @odata.type property for that schema and shall conform to the syntax specified in the Redfish specification for the Type property.", + "longDescription": "This property shall contain the @odata.type property value for that schema and shall conform to the Redfish Specification-specified syntax for the Type property.", "readonly": true, "type": "string" } @@ -133,7 +133,7 @@ "description": "Location information for a schema file.", "longDescription": "This type shall describe location information for a schema file.", "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", @@ -148,35 +148,35 @@ }, "properties": { "ArchiveFile": { - "description": "If the schema is hosted on the service in an archive file, this is the name of the file within the archive.", - "longDescription": "The value of this property shall be the file name of the individual schema file within the archive file specified by the ArchiveUri property. The file name shall conform to the format specified in the Redfish specification.", + "description": "The name of the file in the archive, if the schema is hosted on the service in an archive file.", + "longDescription": "This property shall contain the file name of the individual schema file within the archive file that the ArchiveUri property specifies. The file name shall conform to the Redfish Specification-described format.", "readonly": true, "type": "string" }, "ArchiveUri": { - "description": "If the schema is hosted on the service in an archive file, this is the link to the archive file.", - "format": "uri", - "longDescription": "The value of this property shall be a URI co-located with the Redfish service that specifies the location of the schema file. This property shall only be used for archive files (zip or other formats). The value of ArchiveFile shall have the file name of the individual schema file within the archive file.", + "description": "The link to an archive file, if the schema is hosted on the service in an archive file.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI colocated with the Redfish Service that specifies the location of the schema file, which can be retrieved using the Redfish protocol and authentication methods. This property shall be used for only archive files, in zip or other formats. The ArchiveFile value shall be the individual schema file name within the archive file.", "readonly": true, "type": "string" }, "Language": { - "description": "The language code for the file the schema is in.", - "longDescription": "The value of this property shall be a string consisting of an RFC5646 language code or the string 'default'.", + "description": "The language code for the schema file.", + "longDescription": "This property shall contain an RFC5646-conformant language code or the `default` string.", "readonly": true, "type": "string" }, "PublicationUri": { - "description": "Link to publicly available (canonical) URI for schema.", - "format": "uri", - "longDescription": "The value of this property shall be a URI not co-located with the Redfish service that specifies the canonical location of the schema file. This property shall only be used for individual schema files.", + "description": "The link to publicly available (canonical) URI for schema.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI not colocated with the Redfish Service that specifies the canonical location of the schema file. This property shall be used for only individual schema files.", "readonly": true, "type": "string" }, "Uri": { - "description": "Link to locally available URI for schema.", - "format": "uri", - "longDescription": "The value of this property shall be a URI co-located with the Redfish service that specifies the location of the schema file. This property shall only be used for individual schema files. The file name portion of the URI shall conform to the format specified in the Redfish specification.", + "description": "The link to locally available URI for schema.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI colocated with the Redfish Service that specifies the location of the schema file, which can be retrieved using the Redfish protocol and authentication methods. This property shall be used for only individual schema files. The file name portion of the URI shall conform to the format specified in the Redfish Specification.", "readonly": true, "type": "string" } @@ -185,10 +185,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", @@ -207,5 +207,5 @@ }, "owningEntity": "DMTF", "release": "2017.1", - "title": "#JsonSchemaFile.v1_1_2.JsonSchemaFile" + "title": "#JsonSchemaFile.v1_1_4.JsonSchemaFile" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/LogEntry/LogEntry.json b/static/redfish/v1/JsonSchemas/LogEntry/LogEntry.json index 8b38c9dff2..a3686953da 100644 --- a/static/redfish/v1/JsonSchemas/LogEntry/LogEntry.json +++ b/static/redfish/v1/JsonSchemas/LogEntry/LogEntry.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/LogEntry.v1_4_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/LogEntry.v1_4_3.json", "$ref": "#/definitions/LogEntry", "$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_2_0" } }, @@ -39,18 +39,18 @@ "Critical" ], "enumDescriptions": { - "Critical": "A critical condition requiring immediate attention.", + "Critical": "A critical condition that requires immediate attention.", "OK": "Informational or operating normally.", - "Warning": "A condition requiring attention." + "Warning": "A condition that requires attention." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -66,13 +66,13 @@ "properties": { "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." }, "OriginOfCondition": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", - "description": "This is the URI of the resource that caused the log entry.", - "longDescription": "The value of this property shall be an href that references the resource for which the log is associated.", + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", + "description": "The URI of the Resource that caused the log entry.", + "longDescription": "This property shall contain a link to the Resource that caused the log entry.", "readonly": true } }, @@ -80,10 +80,10 @@ }, "LogEntry": { "additionalProperties": false, - "description": "This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.", - "longDescription": "This resource shall represent the log format for log services in a Redfish implementation.", + "description": "The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log and the Resource includes several additional properties dependent on the EntryType.", + "longDescription": "This Resource shall represent the log format for Log Services in 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", @@ -98,27 +98,27 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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_2_0" }, "Created": { - "description": "The time the log entry was created.", + "description": "The date and time when the log entry was created.", "format": "date-time", - "longDescription": "The value of this property shall be the time at which the log entry was created.", + "longDescription": "This property shall contain the date and time when the log entry was created.", "readonly": true, "type": "string" }, @@ -142,19 +142,19 @@ "type": "null" } ], - "description": "If the EntryType is SEL, this will have the entry code for the log entry.", - "longDescription": "This property shall be present if the EntryType value is SEL. These enumerations are the values from tables 42-1 and 42-2 of the IPMI specification.", + "description": "The entry code for the log entry if the entry type is `SEL`.", + "longDescription": "This property shall contain the entry code for the log entry if the EntryType is `SEL`. Tables 42-1 and 42-2 of the IPMI Specification describe these enumerations.", "readonly": true }, "EntryType": { "$ref": "#/definitions/LogEntryType", - "description": "This is the type of log entry.", - "longDescription": "This property shall represent the type of LogEntry. If the resource represents an IPMI SEL log entry, the value shall be SEL. If the resource represents an Event log, the value shall be Event. If the resource represents an OEM log format, the value shall be Oem.", + "description": "The type of log entry.", + "longDescription": "This property shall represent the type of log entry. If the Resource represents an IPMI SEL entry, the value shall contain `SEL`. If the Resource represents a Redfish event log entry, the value shall contain `Event`. If the Resource represents an OEM log entry format, the value shall contain `Oem`.", "readonly": true }, "EventGroupId": { - "description": "This value is the identifier used to correlate events that came from the same cause.", - "longDescription": "The value of this property shall indicate that events are related and shall have the same value in the case where multiple Event messages are produced by the same root cause. Implementations shall use separate values for events with separate root cause. There shall not be ordering of events implied by the value of this property.", + "description": "An identifier that correlates events with the same cause.", + "longDescription": "This property shall indicate that events are related and shall have the same value in the case where multiple event messages are produced by the same root cause. Implementations shall use separate values for events with separate root cause. There shall not be ordering of events implied by this property's value.", "readonly": true, "type": [ "integer", @@ -163,26 +163,28 @@ "versionAdded": "v1_4_0" }, "EventId": { - "description": "This is a unique instance identifier of an event.", + "description": "The unique instance identifier for an event.", "longDescription": "If present, this LogEntry records an Event and the value shall indicate a unique identifier for the event, the format of which is implementation dependent.", "readonly": true, "type": "string", "versionAdded": "v1_1_0" }, "EventTimestamp": { - "description": "This is time the event occurred.", + "description": "The date and time when the event occurred.", "format": "date-time", - "longDescription": "If present, this LogEntry records an Event and the value shall be the time the event occurred.", + "longDescription": "If present, this LogEntry records an event and the value shall contain the date and time when the event occurred.", "readonly": true, "type": "string", "versionAdded": "v1_1_0" }, "EventType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType", - "description": "This indicates the type of an event recorded in this log.", - "longDescription": "If present, this LogEntry records an Event and the value shall indicate the type of event.", + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "The type of event recorded in this log.", + "longDescription": "If present, this LogEntry records an event and the value shall indicate the type of event.", "readonly": true, - "versionAdded": "v1_1_0" + "versionAdded": "v1_1_0", + "versionDeprecated": "v1_4_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -190,12 +192,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Message": { - "description": "This property decodes from EntryType. If the EntryType is Event, then it is a message string. Otherwise, it is SEL or OEM specific. In most cases, this will be the actual Log Entry.", - "longDescription": "The value of this property shall be the Message property of the event if the EntryType is Event, the Description if the EntryType is SEL, and OEM Specific if the EntryType is Oem.", + "description": "The message of the log entry. This property decodes from the entry type. If the entry type is `Event`, this property contains a message. If the entry type is `SEL`, this property contains an SEL-specific message. Otherwise, this property contains an OEM-specific log entry. In most cases, this property contains the actual log entry.", + "longDescription": "This property shall contain the message of the log entry. This property decodes from the entry type. If the entry type is `Event`, this property contains a message. If the entry type is `SEL`, this property contains an SEL-specific. Otherwise, this property contains an OEM-specific log entry. In most cases, this property contains the actual log entry.", "readonly": true, "type": [ "string", @@ -203,17 +205,17 @@ ] }, "MessageArgs": { - "description": "The values of this property shall be any arguments for the message.", + "description": "The arguments for the message.", "items": { "type": "string" }, - "longDescription": "This contains message arguments to be substituted into the message included or in the message looked up via a registry.", + "longDescription": "This property shall contain message arguments to substitute into the included or looked-up message.", "readonly": true, "type": "array" }, "MessageId": { - "description": "This property decodes from EntryType. If the EntryType is Event, then it is a message id. If the EntryType is SEL, then it contains the Event Data. Otherwise, it is OEM specific. This value is only used for registries - for more information, see the specification.", - "longDescription": "The value of this property shall the MessageId property of the event if the EntryType is Event, the three IPMI Event Data bytes if the EntryType is SEL, and OEM Specific if the EntryType is Oem. The format of this property shall be as defined in the Redfish specification. If representing the three IPMI Event Data bytes, the format should follow the pattern '^0[xX](([a-fA-F]|[0-9]){2}){3}$', where Event Data 1 is the first byte in the string, Event Data 2 is the second byte in the string, and Event Data 3 is the third byte in the string.", + "description": "The MessageId, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is `Event`, this property contains a Redfish Specification-defined MessageId. If the entry type is `SEL`, this property contains the Event Data. Otherwise, this property contains OEM-specific information.", + "longDescription": "This property shall contain the MessageId, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is `Event`, this property contains a Redfish Specification-defined MessageId property of the event. If the entry type is `SEL`, this property contains the three IPMI Event Data bytes. In this case, the format should follow the `^0[xX](([a-fA-F]|[0-9]){2}){3}$` pattern, where Event Data 1 is the first byte in the string, Event Data 2 is the second byte in the string, and Event Data 3 is the third byte in the string. Otherwise, this property contains OEM-specific information.", "readonly": true, "type": "string" }, @@ -223,12 +225,12 @@ }, "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." }, "OemLogEntryCode": { - "description": "If the LogEntryCode type is OEM, this will contain the OEM-specific entry code.", - "longDescription": "The value of this property shall represent the OEM specific Log Entry Code type of the Entry. This property shall only be present if the value of EntryType is SEL and the value of LogEntryCode is OEM.", + "description": "The OEM-specific entry code, if the LogEntryCode type is `OEM`.", + "longDescription": "This property shall represent the OEM-specific Log Entry Code type of the Entry. This property shall only be present if EntryType is `SEL` and LogEntryCode is `OEM`.", "readonly": true, "type": [ "string", @@ -237,8 +239,8 @@ "versionAdded": "v1_3_0" }, "OemRecordFormat": { - "description": "If the EntryType is Oem, this will contain more information about the record format from the Oem.", - "longDescription": "The value of this property shall represent the OEM specific format of the Entry. This property shall be required if the value of EntryType is Oem.", + "description": "The OEM-specific format of the entry. If the entry type is `Oem`, this property contains more information about the record format from the OEM.", + "longDescription": "This property shall represent the OEM-specific format of the entry. This property shall be required if the EntryType value is `Oem`.", "readonly": true, "type": [ "string", @@ -246,8 +248,8 @@ ] }, "OemSensorType": { - "description": "If the Sensor Type is OEM, this will contain the OEM-specific sensor type.", - "longDescription": "The value of this property shall represent the OEM specific sensor type of the Entry. This property shall only be used if the value of EntryType is SEL and the value of SensorType is OEM.", + "description": "The OEM-specific sensor type if the sensor type is `OEM`.", + "longDescription": "This property shall represent the OEM-specific sensor type of the entry. This property shall only be used if EntryType is `SEL` and SensorType is `OEM`.", "readonly": true, "type": [ "string", @@ -256,8 +258,8 @@ "versionAdded": "v1_3_0" }, "SensorNumber": { - "description": "This property decodes from EntryType. If the EntryType is SEL, it is the sensor number. If the EntryType is Event, then the count of events. Otherwise, it is OEM specific.", - "longDescription": "The value of this property shall be the IPMI sensor number if the EntryType is SEL, the count of events if the EntryType is Event, and OEM Specific if EntryType is Oem.", + "description": "The sensor number, the count of events, or OEM-specific information. This property value is decoded from the entry type. If the entry type is `SEL`, this property contains the sensor number. If the entry type is `Event`, this property contains the count of events. Otherwise, this property contains OEM-specific information.", + "longDescription": "This property shall contain the sensor number, the count of events, or OEM-specific information. This property value is decoded from the entry type. If the entry type is `SEL`, this property contains the sensor number. If the entry type is `Event`, this property contains the count of events. Otherwise, this property contains OEM-specific information.", "readonly": true, "type": [ "integer", @@ -273,8 +275,8 @@ "type": "null" } ], - "description": "If the EntryType is SEL, this will have the sensor type that the log entry pertains to.", - "longDescription": "This property shall be present if the EntryType value is SEL. These enumerations are the values from table 42-3 of the IPMI specification.", + "description": "The sensor type to which the log entry pertains if the entry type is `SEL`.", + "longDescription": "This property shall contain the sensor type to which the log entry pertains if the entry type is `SEL`. Table 42-3 in the IPMI Specification describes these enumerations.", "readonly": true }, "Severity": { @@ -286,8 +288,8 @@ "type": "null" } ], - "description": "This is the severity of the log entry.", - "longDescription": "The value of this property shall be the severity of the condition resulting in the log entry, as defined in the Status section of the Redfish specificaiton.", + "description": "The severity of the log entry.", + "longDescription": "This property shall contain the severity of the condition that created the log entry, as defined in the Status section of the Redfish Specification.", "readonly": true } }, @@ -368,18 +370,18 @@ ], "enumDescriptions": { "Assert": "The condition has been asserted.", - "D0 Power State": "The ACPI defined D0 Power State.", - "D1 Power State": "The ACPI defined D1 Power State.", - "D2 Power State": "The ACPI defined D2 Power State.", - "D3 Power State": "The ACPI defined D3 Power State.", + "D0 Power State": "The ACPI-defined D0 power state.", + "D1 Power State": "The ACPI-defined D1 power state.", + "D2 Power State": "The ACPI-defined D2 power state.", + "D3 Power State": "The ACPI-defined D3 power state.", "Deassert": "The condition has been deasserted.", "Device Disabled": "A device has been disabled.", "Device Enabled": "A device has been enabled.", - "Device Inserted / Device Present": "A device has been inserted or is now present.", - "Device Removed / Device Absent": "A device has been removed or is now absent.", + "Device Inserted / Device Present": "A device has been inserted or is present.", + "Device Removed / Device Absent": "A device has been removed or is absent.", "Fully Redundant": "Indicates that full redundancy has been regained.", - "Informational": "An Informational event.", - "Install Error": "An Install Error has been detected.", + "Informational": "An informational event.", + "Install Error": "An install error has been detected.", "Limit Exceeded": "A limit has been exceeded.", "Limit Not Exceeded": "A limit has not been exceeded.", "Lower Critical - going high": "The reading crossed the Lower Critical threshold while going high.", @@ -388,11 +390,11 @@ "Lower Non-critical - going low": "The reading crossed the Lower Non-critical threshold while going low.", "Lower Non-recoverable - going high": "The reading crossed the Lower Non-recoverable threshold while going high.", "Lower Non-recoverable - going low": "The reading crossed the Lower Non-recoverable threshold while going low.", - "Monitor": "A Monitor event.", - "Non-redundant:Insufficient Resources": "Unit is non-redundant and has insufficient resource to maintain normal operation.", - "Non-redundant:Sufficient Resources from Insufficient Resources": "Unit has regianed minimum resources needed for normal operation.", + "Monitor": "A monitor event.", + "Non-redundant:Insufficient Resources": "Unit is non-redundant and has insufficient resources to maintain normal operation.", + "Non-redundant:Sufficient Resources from Insufficient Resources": "Unit has regained minimum resources needed for normal operation.", "Non-redundant:Sufficient Resources from Redundant": "Redundancy has been lost but unit is functioning with minimum resources needed for normal operation.", - "OEM": "An OEM defined event.", + "OEM": "An OEM-defined event.", "Performance Lags": "Performance does not meet expectations.", "Performance Met": "Performance meets expectations.", "Predictive Failure asserted": "A Predictive Failure has been detected.", @@ -440,18 +442,18 @@ "Oem" ], "enumDescriptions": { - "Event": "Contains a Redfish-defined message (event).", - "Oem": "Contains an entry in an OEM-defined format.", - "SEL": "Contains a legacy IPMI System Event Log (SEL) entry." + "Event": "A Redfish-defined message.", + "Oem": "An entry in an OEM-defined format.", + "SEL": "A legacy IPMI System Event Log (SEL) entry." }, "type": "string" }, "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", @@ -520,7 +522,7 @@ "Battery": "A sensor for a battery.", "Boot Error": "A sensor for a boot error event.", "Button/Switch": "A sensor for a button or switch.", - "Cable/Interconnect": "A sensor for a cable or interconnect type of device.", + "Cable/Interconnect": "A sensor for a cable or interconnect device type.", "Chassis": "A sensor for a chassis.", "ChipSet": "A sensor for a chipset.", "CoolingDevice": "A sensor for a cooling device.", @@ -537,9 +539,9 @@ "Microcontroller/Coprocessor": "A sensor for a microcontroller or coprocessor.", "Module/Board": "A sensor for a module or board.", "Monitor ASIC/IC": "A sensor for a monitor ASIC or IC.", - "OEM": "An OEM defined sensor.", + "OEM": "An OEM-defined sensor.", "OS Stop/Shutdown": "A sensor for an OS stop or shutdown event", - "Other FRU": "A sensor for an other type of FRU.", + "Other FRU": "A sensor for another type of FRU.", "Other Units-based Sensor": "A sensor for a miscellaneous analog sensor.", "POST Memory Resize": "A sensor for a POST memory resize event.", "Physical Chassis Security": "A physical security sensor.", @@ -568,5 +570,5 @@ }, "owningEntity": "DMTF", "release": "2018.2", - "title": "#LogEntry.v1_4_1.LogEntry" + "title": "#LogEntry.v1_4_3.LogEntry" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/LogService/LogService.json b/static/redfish/v1/JsonSchemas/LogService/LogService.json index 9699883c87..c933052b4c 100644 --- a/static/redfish/v1/JsonSchemas/LogService/LogService.json +++ b/static/redfish/v1/JsonSchemas/LogService/LogService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/LogService.v1_1_3.json", "$ref": "#/definitions/LogService", "$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", @@ -27,19 +28,19 @@ }, "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." } }, "type": "object" }, "ClearLog": { "additionalProperties": false, - "description": "This action is used to clear the log for this Log Service.", + "description": "The action to clear the log for this Log Service.", "longDescription": "This action shall delete all entries found in the Entries collection for this Log Service.", "parameters": {}, "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", @@ -55,7 +56,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -73,8 +74,8 @@ "OEM" ], "enumDescriptions": { - "Event": "The log contains Redfish-defined messages (events).", - "Multiple": "The log contains multiple Log Entry types or a single entry type cannot be guaranteed by the Log Service.", + "Event": "The log contains Redfish-defined messages.", + "Multiple": "The log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type.", "OEM": "The log contains entries in an OEM-defined format.", "SEL": "The log contains legacy IPMI System Event Log (SEL) entries." }, @@ -82,10 +83,10 @@ }, "LogService": { "additionalProperties": false, - "description": "This resource represents the log service for the resource or service to which it is associated.", - "longDescription": "This resource shall be used to represent a log service for a Redfish implementation.", + "description": "The LogService schema contains properties for monitoring and configuring a Log Service.", + "longDescription": "This Resource shall represent a Log Service 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", @@ -100,26 +101,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "DateTime": { - "description": "The current DateTime (with offset) for the log service, used to set or read time.", + "description": "The current date and time, with UTC offset, that the Log Service uses to set or read time.", "format": "date-time", - "longDescription": "The value of this property shall represent the current DateTime value that the log service is using, with offset from UTC, in Redfish Timestamp format.", + "longDescription": "This property shall represent the current DateTime value, with UTC offset, in Redfish Timestamp format that the Log Service uses to set or read time.", "readonly": false, "type": [ "string", @@ -127,9 +128,9 @@ ] }, "DateTimeLocalOffset": { - "description": "The time offset from UTC that the DateTime property is set to in format: +06:00 .", - "longDescription": "The value is property shall represent the offset from UTC time that the current value of DataTime property contains.", - "pattern": "([-+][0-1][0-9]:[0-5][0-9])", + "description": "The UTC offset that the current DateTime property value contains in the `+HH:MM` format.", + "longDescription": "This property shall represent the UTC offset that the current DateTime property value contains.", + "pattern": "^([-+][0-1][0-9]:[0-5][0-9])$", "readonly": false, "type": [ "string", @@ -149,8 +150,8 @@ }, "Entries": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogEntryCollection.json#/definitions/LogEntryCollection", - "description": "References to the log entry collection.", - "longDescription": "The value of this property shall reference a collection of resources of type LogEntry.", + "description": "The link to the log entry collection.", + "longDescription": "This property shall contain a link to a Resource Collection of type LogEntryCollection.", "readonly": true }, "Id": { @@ -166,13 +167,14 @@ "type": "null" } ], - "description": "The format of the Entries of this log.", - "longDescription": "The value of this property shall represent the EntryType of all LogEntry resources contained in the Entries collection. If a single EntryType for all LogEntry resources cannot be determined or guaranteed by the Service, the value of this property shall be 'Multiple'.", - "readonly": true + "description": "The format of the log entries.", + "longDescription": "This property shall represent the EntryType of all LogEntry Resources contained in the Entries collection. If the service cannot determine or guarantee a single EntryType for all LogEntry Resources, this property's value shall be `Multiple`.", + "readonly": true, + "versionAdded": "v1_1_0" }, "MaxNumberOfRecords": { - "description": "The maximum number of log entries this service can have.", - "longDescription": "The value of this property shall be the maximum numbers of LogEntry resources in the Entries collection for this service.", + "description": "The maximum number of log entries that this service can have.", + "longDescription": "This property shall contain the maximum number of LogEntry Resources in the Entries collection for this service.", "minimum": 0, "readonly": true, "type": "integer" @@ -183,18 +185,18 @@ }, "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." }, "OverWritePolicy": { "$ref": "#/definitions/OverWritePolicy", "description": "The overwrite policy for this service that takes place when the log is full.", - "longDescription": "The value of this property shall indicate the policy of the log service when the MaxNumberOfRecords has been reached. Unknown indicates the log overwrite policy is unknown. WrapsWhenFull indicates that the log overwrites its entries with new entries when the log has reached its maximum capacity. NeverOverwrites indicates that the log never overwrites its entries by the new entries and ceases logging when the limit has been reached.", + "longDescription": "This property shall indicate the policy of the Log Service when the MaxNumberOfRecords has been reached.", "readonly": true }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -203,8 +205,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -217,10 +219,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", @@ -243,13 +245,14 @@ "NeverOverWrites" ], "enumDescriptions": { - "NeverOverWrites": "When full, new entries to the Log will be discarded.", + "NeverOverWrites": "When full, new entries to the log are discarded.", "Unknown": "The overwrite policy is not known or is undefined.", - "WrapsWhenFull": "When full, new entries to the Log will overwrite previous entries." + "WrapsWhenFull": "When full, new entries to the log overwrite earlier entries." }, "type": "string" } }, "owningEntity": "DMTF", - "title": "#LogService.v1_1_1.LogService" + "release": "2017.3", + "title": "#LogService.v1_1_3.LogService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Manager/Manager.json b/static/redfish/v1/JsonSchemas/Manager/Manager.json index beae6fe409..bfc514f222 100644 --- a/static/redfish/v1/JsonSchemas/Manager/Manager.json +++ b/static/redfish/v1/JsonSchemas/Manager/Manager.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Manager.v1_5_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Manager.v1_6_0.json", "$ref": "#/definitions/Manager", "$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", @@ -34,8 +34,8 @@ }, "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." } }, "type": "object" @@ -48,19 +48,19 @@ "Oem" ], "enumDescriptions": { - "IPMI": "The controller supports a Command Shell connection using the IPMI Serial-over-LAN (SOL) protocol.", - "Oem": "The controller supports a Command Shell connection using an OEM-specific protocol.", - "SSH": "The controller supports a Command Shell connection using the SSH protocol.", - "Telnet": "The controller supports a Command Shell connection using the Telnet protocol." + "IPMI": "The controller supports a command shell connection through the IPMI Serial Over LAN (SOL) protocol.", + "Oem": "The controller supports a command shell connection through an OEM-specific protocol.", + "SSH": "The controller supports a command shell connection through the SSH protocol.", + "Telnet": "The controller supports a command shell connection through the Telnet protocol." }, "type": "string" }, "CommandShell": { "additionalProperties": false, - "description": "Information about a Command Shell service provided by a manager.", - "longDescription": "This type shall describe a Command Shell service of a manager.", + "description": "The information about a command shell service that this manager provides.", + "longDescription": "This type shall describe a command shell service for a manager.", "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", @@ -75,24 +75,24 @@ }, "properties": { "ConnectTypesSupported": { - "description": "This object is used to enumerate the Command Shell connection types allowed by the implementation.", + "description": "This property enumerates the command shell connection types that the implementation allows.", "items": { "$ref": "#/definitions/CommandConnectTypesSupported" }, - "longDescription": "The value of ConnectTypesSupported shall be an array of the enumerations provided here. SSH shall be included if the Secure Shell (SSH) protocol is supported. Telnet shall be included if the Telnet protocol is supported. IPMI shall be included if the IPMI (Serial-over-LAN) protocol is supported.", + "longDescription": "This property shall contain an array of the enumerations. SSH shall be included if the Secure Shell (SSH) protocol is supported. Telnet shall be included if the Telnet protocol is supported. IPMI shall be included if the IPMI Serial Over LAN (SOL) protocol is supported.", "readonly": true, "type": "array" }, "MaxConcurrentSessions": { - "description": "Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support.", - "longDescription": "The value of this property shall contain the maximum number of concurrent service sessions supported by the implementation.", + "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.", + "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.", "minimum": 0, "readonly": true, "type": "integer" }, "ServiceEnabled": { - "description": "Indicates if the service is enabled for this manager.", - "longDescription": "The value of this property shall contain the enabled status of the protocol used for the service. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the service is enabled for this manager.", + "longDescription": "This property shall indicate whether the protocol for the service is enabled.", "readonly": false, "type": "boolean" } @@ -106,13 +106,13 @@ "parameters": { "NewManager": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager", - "description": "This parameter specifies the Manager in which to fail over. In this case, a valid reference is supported.", - "longDescription": "This parameter shall contain a resource reference of the Manager in which to fail over.", + "description": "The manager to which to fail over.", + "longDescription": "This parameter shall contain the manager to which to fail over.", "requiredParameter": true } }, "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", @@ -128,7 +128,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -144,17 +144,17 @@ "Oem" ], "enumDescriptions": { - "KVMIP": "The controller supports a Graphical Console connection using a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol.", - "Oem": "The controller supports a Graphical Console connection using an OEM-specific protocol." + "KVMIP": "The controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol.", + "Oem": "The controller supports a graphical console connection through an OEM-specific protocol." }, "type": "string" }, "GraphicalConsole": { "additionalProperties": false, - "description": "Information about a Graphical Console service provided by a manager.", - "longDescription": "This type shall describe a Graphical Console service of a manager.", + "description": "The information about a graphical console service that this manager provides.", + "longDescription": "This type shall describe a graphical console service for a manager.", "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", @@ -169,24 +169,24 @@ }, "properties": { "ConnectTypesSupported": { - "description": "This object is used to enumerate the Graphical Console connection types allowed by the implementation.", + "description": "This property enumerates the graphical console connection types that the implementation allows.", "items": { "$ref": "#/definitions/GraphicalConnectTypesSupported" }, - "longDescription": "The value of ConnectTypesSupported shall be an array of the enumerations provided here. RDP shall be included if the Remote Desktop (RDP) protocol is supported. KVMIP shall be included if a vendor-define KVM-IP protocol is supported.", + "longDescription": "This property shall contain an array of the enumerations. RDP shall be included if the Remote Desktop (RDP) protocol is supported. KVMIP shall be included if a vendor-define KVM-IP protocol is supported.", "readonly": true, "type": "array" }, "MaxConcurrentSessions": { - "description": "Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support.", - "longDescription": "The value of this property shall contain the maximum number of concurrent service sessions supported by the implementation.", + "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.", + "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.", "minimum": 0, "readonly": true, "type": "integer" }, "ServiceEnabled": { - "description": "Indicates if the service is enabled for this manager.", - "longDescription": "The value of this property shall contain the enabled status of the protocol used for the service. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the service is enabled for this manager.", + "longDescription": "This property shall indicate whether the protocol for the service is enabled.", "readonly": false, "type": "boolean" } @@ -195,10 +195,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but not contained by or subordinate to 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", @@ -212,64 +212,84 @@ } }, "properties": { + "ActiveSoftwareImage": { + "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory", + "description": "The link to the SoftwareInventory Resource that represents the active firmware image for this manager.", + "longDescription": "This property shall contain a link to the SoftwareInventory Resource that represent the active firmware image for this manager.", + "readonly": false, + "versionAdded": "v1_6_0" + }, "ManagerForChassis": { - "description": "This property is an array of references to the chassis that this manager has control over.", + "description": "An array of links to the chassis this manager controls.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" }, - "longDescription": "This property shall contain an array of references to Chassis resources of which this Manager instance has control.", + "longDescription": "This property shall contain an array of links to chassis over which this manager instance has control.", "readonly": true, "type": "array" }, "ManagerForChassis@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ManagerForServers": { - "description": "This property is an array of references to the systems that this manager has control over.", + "description": "An array of links to the systems that this manager controls.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "This property shall contain an array of references to ComputerSystem resources of which this Manager instance has control.", + "longDescription": "This property shall contain an array of links to computer systems over which this manager instance has control.", "readonly": true, "type": "array" }, "ManagerForServers@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ManagerForSwitches": { - "description": "This property is an array of references to the switches that this manager has control over.", + "description": "An array of links to the switches that this manager controls.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Switch.json#/definitions/Switch" }, - "longDescription": "This property shall contain an array of references to Switch resources of which this Manager instance has control.", + "longDescription": "This property shall contain an array of links to switches that this manager instance controls.", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "ManagerForSwitches@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ManagerInChassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "This property is a reference to the chassis that this manager is located in.", - "longDescription": "This property shall contain a reference to the chassis that this manager is located in.", + "description": "The link to the chassis where this manager is located.", + "longDescription": "This property shall contain a link to the chassis where this manager is located.", "readonly": true, "versionAdded": "v1_1_0" }, "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." + }, + "SoftwareImages": { + "description": "The images that are associated with this manager.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory" + }, + "longDescription": "This property shall contain an array of links to the SoftwareInventory Resources that represent the firmware images that apply to this manager.", + "readonly": true, + "type": "array", + "versionAdded": "v1_6_0" + }, + "SoftwareImages@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "Manager": { "additionalProperties": false, - "description": "This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions.", - "longDescription": "This resource shall be used to represent a management subsystem for a Redfish implementation.", + "description": "In Redfish, a manager is a systems management entity that may implement or provide access to a Redfish Service. Examples of managers are BMCs, enclosure managers, management controllers, and other subsystems that are assigned managability functions. An implementation may have multiple managers, which may or may not be directly accessible through a Redfish-defined interface.", + "longDescription": "This Resource shall represent a management subsystem 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", @@ -284,38 +304,38 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": "The actions property shall contain the available actions for this Resource." }, "AutoDSTEnabled": { - "description": "Indicates whether the manager is configured for automatic DST adjustment.", - "longDescription": "The value of this property shall contain the enabled status of the automatic Daylight Saving Time (DST) adjustment of the manager's DateTime. It shall be true if Automatic DST adjustment is enabled and false if disabled.", + "description": "An indication of whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.", + "longDescription": "This property shall indicate whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.", "readonly": false, "type": "boolean", "versionAdded": "v1_4_0" }, "CommandShell": { "$ref": "#/definitions/CommandShell", - "description": "Information about the Command Shell service provided by this manager.", - "longDescription": "The value of this property shall contain information about the Command Shell service of this manager." + "description": "The command shell service that this manager provides.", + "longDescription": "This property shall contain information about the command shell service of this manager." }, "DateTime": { - "description": "The current DateTime (with offset) for the manager, used to set or read time.", + "description": "The current date and time with UTC offset that the manager uses to set or read time.", "format": "date-time", - "longDescription": "The value of this property shall represent the current DateTime value for the manager, with offset from UTC, in Redfish Timestamp format.", + "longDescription": "This property shall represent the current DateTime value for the manager, with UTC offset, in Redfish Timestamp format.", "readonly": false, "type": [ "string", @@ -323,9 +343,9 @@ ] }, "DateTimeLocalOffset": { - "description": "The time offset from UTC that the DateTime property is set to in format: +06:00 .", - "longDescription": "The value is property shall represent the offset from UTC time that the current value of DataTime property contains.", - "pattern": "([-+][0-1][0-9]:[0-5][0-9])", + "description": "The time offset from UTC that the DateTime property is in `+HH:MM` format.", + "longDescription": "This property shall represent the offset from UTC time that the current DataTime property contains.", + "pattern": "^([-+][0-1][0-9]:[0-5][0-9])$", "readonly": false, "type": [ "string", @@ -345,12 +365,12 @@ }, "EthernetInterfaces": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection", - "description": "This is a reference to a collection of NICs that this manager uses for network communication. It is here that clients will find NIC configuration options and settings.", - "longDescription": "The value of this property shall be a link to a collection of type EthernetInterfaceCollection.", + "description": "The link to a collection of NICs that this manager uses for network communication.", + "longDescription": "This property shall contain a link to a Resource Collection of type EthernetInterfaceCollection.", "readonly": true }, "FirmwareVersion": { - "description": "The firmware version of this Manager.", + "description": "The firmware version of this manager.", "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the associated manager.", "readonly": true, "type": [ @@ -360,13 +380,13 @@ }, "GraphicalConsole": { "$ref": "#/definitions/GraphicalConsole", - "description": "The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager.", - "longDescription": "The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager." + "description": "The information about the graphical console (KVM-IP) service of this manager.", + "longDescription": "This property shall contain the information about the graphical console (KVM-IP) service of this manager." }, "HostInterfaces": { "$ref": "http://redfish.dmtf.org/schemas/v1/HostInterfaceCollection.json#/definitions/HostInterfaceCollection", - "description": "This is a reference to a collection of Host Interfaces that this manager uses for local host communication. It is here that clients will find Host Interface configuration options and settings.", - "longDescription": "The value of this property shall be a link to a collection of type HostInterfaceCollection.", + "description": "The link to a collection of Host Interfaces that this manager uses for local host communication. Clients can find Host Interface configuration options and settings in this navigation property.", + "longDescription": "This property shall contain a link to a Resource Collection of type HostInterfaceCollection.", "readonly": true, "versionAdded": "v1_3_0" }, @@ -376,24 +396,24 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "LogServices": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection", - "description": "This is a reference to a collection of Logs used by the manager.", - "longDescription": "The value of this property shall contain a reference to a collection of type LogServiceCollection which are for the use of this manager.", + "description": "The link to a collection of logs that the manager uses.", + "longDescription": "This property shall contain a link to a Resource Collection of type LogServiceCollection that this manager uses.", "readonly": true }, "ManagerType": { "$ref": "#/definitions/ManagerType", - "description": "This property represents the type of manager that this resource represents.", - "longDescription": "The value of this property shall describe the function of this manager. The value EnclosureManager shall be used if this manager controls one or more services through aggregation. The value BMC shall be used if this manager represents a traditional server management controller. The value ManagementController shall be used if none of the other enumerations apply.", + "description": "The type of manager that this Resource represents.", + "longDescription": "This property shall describe the function of this manager. The `ManagementController` value shall be used if none of the other enumerations apply.", "readonly": true }, "Model": { - "description": "The model information of this Manager as defined by the manufacturer.", - "longDescription": "The value of this property shall contain the information about how the manufacturer references this manager.", + "description": "The model information of this manager, as defined by the manufacturer.", + "longDescription": "This property shall contain the information about how the manufacturer refers to this manager.", "readonly": true, "type": [ "string", @@ -406,14 +426,14 @@ }, "NetworkProtocol": { "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.json#/definitions/ManagerNetworkProtocol", - "description": "This is a reference to the network services and their settings that the manager controls. It is here that clients will find network configuration options as well as network services.", - "longDescription": "The value of this property shall contain a reference to a resource of type ManagerNetworkProtocol which represents the network services for this manager.", + "description": "The link to the network services and their settings that the manager controls.", + "longDescription": "This property shall contain a link to a Resource of the ManagerNetworkProtocol, which represents the network services for this manager.", "readonly": true }, "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." }, "PowerState": { "anyOf": [ @@ -424,34 +444,34 @@ "type": "null" } ], - "description": "This is the current power state of the Manager.", - "longDescription": "The value of this property shall contain the power state of the Manager.", + "description": "The current power state of the manager.", + "longDescription": "This property shall contain the power state of the manager.", "readonly": true, "versionAdded": "v1_2_0" }, "Redundancy": { "autoExpand": true, - "description": "Redundancy information for the managers of this system.", + "description": "The redundancy information for the managers of this system.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show how this manager is grouped with other managers for form redundancy sets.", + "longDescription": "The properties in this array shall show how this manager is grouped with other managers for form redundancy sets.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "RemoteAccountService": { "$ref": "http://redfish.dmtf.org/schemas/v1/AccountService.json#/definitions/AccountService", - "description": "This property contains a reference to the AccountService resource for the remote Manager represented by this resource.", - "longDescription": "This property shall contain a reference to the AccountService resource for the remote Manager represented by this resource. This property shall only be present when providing aggregation of Redfish services.", + "description": "The link to the AccountService Resource for the remote manager that this Resource represents.", + "longDescription": "This property shall contain a link to the AccountService Resource for the remote manager that this Resource represents. This property shall only be present when providing aggregation of Redfish Services.", "readonly": true, "versionAdded": "v1_5_0" }, "RemoteRedfishServiceUri": { - "description": "This property contains the URI of the Redfish Service Root for the remote Manager represented by this resource.", - "format": "uri", - "longDescription": "This property shall contain the URI of the Redfish Service Root for the remote Manager represented by this resource. This property shall only be present when providing aggregation of Redfish services.", + "description": "The URI of the Redfish Service Root for the remote manager that this Resource represents.", + "format": "uri-reference", + "longDescription": "This property shall contain the URI of the Redfish Service Root for the remote manager that this Resource represents. This property shall only be present when providing aggregation of Redfish Services.", "readonly": true, "type": [ "string", @@ -461,13 +481,13 @@ }, "SerialConsole": { "$ref": "#/definitions/SerialConsole", - "description": "Information about the Serial Console service provided by this manager.", - "longDescription": "The value of this property shall contain information about the Serial Console service of this manager." + "description": "The serial console service that this manager provides.", + "longDescription": "This property shall contain information about the serial console service of this manager." }, "SerialInterfaces": { "$ref": "http://redfish.dmtf.org/schemas/v1/SerialInterfaceCollection.json#/definitions/SerialInterfaceCollection", - "description": "This is a reference to a collection of serial interfaces that this manager uses for serial and console communication. It is here that clients will find serial configuration options and settings.", - "longDescription": "The value of this property shall be a link to a collection of type SerialInterfaceCollection which are for the use of this manager.", + "description": "The link to a collection of serial interfaces that this manager uses for serial and console communication.", + "longDescription": "This property shall contain a link to a Resource Collection of type SerialInterfaceCollection, which this manager uses.", "readonly": true }, "ServiceEntryPointUUID": { @@ -479,14 +499,14 @@ "type": "null" } ], - "description": "The UUID of the Redfish Service provided by this manager.", - "longDescription": "This property shall contain the UUID of the Redfish Service provided by this manager. Each Manager providing an Entry Point to the same Redfish Service shall report the same UUID value (even though the name of the property may imply otherwise). This property shall not be present if this manager does not provide a Redfish Service Entry Point.", + "description": "The UUID of the Redfish Service that is hosted by this manager.", + "longDescription": "This property shall contain the UUID of the Redfish Service that is hosted by this manager. Each manager providing an entry point to the same Redfish Service shall report the same UUID value, even though the name of the property may imply otherwise. This property shall not be present if this manager does not provide a Redfish Service entry point.", "readonly": true }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UUID": { "anyOf": [ @@ -497,14 +517,14 @@ "type": "null" } ], - "description": "The Universal Unique Identifier (UUID) for this Manager.", - "longDescription": "The value of this property shall contain the universal unique identifier number for the manager.", + "description": "The UUID for this manager.", + "longDescription": "This property shall contain the UUID for the manager.", "readonly": true }, "VirtualMedia": { "$ref": "http://redfish.dmtf.org/schemas/v1/VirtualMediaCollection.json#/definitions/VirtualMediaCollection", - "description": "This is a reference to the Virtual Media services for this particular manager.", - "longDescription": "The value of this property shall contain a reference to a collection of type VirtualMediaCollection which are for the use of this manager.", + "description": "The link to the Virtual Media services for this particular manager.", + "longDescription": "This property shall contain a link to a Resource Collection of type VirtualMediaCollection, which this manager uses.", "readonly": true } }, @@ -518,9 +538,9 @@ }, "ManagerService": { "additionalProperties": false, - "description": "Used for describing services like Serial Console, Command Shell or Graphical Console.", + "description": "The manager services, such as serial console, command shell, or graphical console service.", "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", @@ -535,15 +555,15 @@ }, "properties": { "MaxConcurrentSessions": { - "description": "Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support.", - "longDescription": "The value of this property shall contain the maximum number of concurrent service sessions supported by the implementation.", + "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.", + "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.", "minimum": 0, "readonly": true, "type": "integer" }, "ServiceEnabled": { - "description": "Indicates if the service is enabled for this manager.", - "longDescription": "The value of this property shall contain the enabled status of the protocol used for the service. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the service is enabled for this manager.", + "longDescription": "This property shall indicate whether the protocol for the service is enabled.", "readonly": false, "type": "boolean" } @@ -560,12 +580,12 @@ "Service" ], "enumDescriptions": { - "AuxiliaryController": "A controller which provides management functions for a particular subsystem or group of devices.", - "BMC": "A controller which provides management functions for a single computer system.", - "EnclosureManager": "A controller which provides management functions for a chassis or group of devices or systems.", - "ManagementController": "A controller used primarily to monitor or manage the operation of a device or system.", - "RackManager": "A controller which provides management functions for a whole or part of a rack.", - "Service": "A software-based service which provides management functions." + "AuxiliaryController": "A controller that provides management functions for a particular subsystem or group of devices.", + "BMC": "A controller that provides management functions for a single computer system.", + "EnclosureManager": "A controller that provides management functions for a chassis or group of devices or systems.", + "ManagementController": "A controller that primarily monitors or manages the operation of a device or system.", + "RackManager": "A controller that provides management functions for a whole or part of a rack.", + "Service": "A software-based service that provides management functions." }, "enumVersionAdded": { "Service": "v1_4_0" @@ -574,28 +594,28 @@ }, "ModifyRedundancySet": { "additionalProperties": false, - "description": "The ModifyRedundancySet operation is used to add or remove members to a redundant group of manager.", - "longDescription": "The ModifyRedundancySet operation shall be used to add or remove members to a redundant group of manager.", + "description": "The ModifyRedundancySet operation adds members to or removes members from a redundant group of managers.", + "longDescription": "The ModifyRedundancySet operation shall add members to or remove members from a redundant group of managers.", "parameters": { "Add": { - "description": "This array defines the Managers to add to the redundancy set. In this case, a valid reference is supported.", + "description": "An array of managers to add to the redundancy set.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "This parameter shall contain an array of resource references of the Managers to add to the redundancy set.", + "longDescription": "This parameter shall contain an array of managers to add to the redundancy set.", "type": "array" }, "Remove": { - "description": "This array defines the Managers to remove from the redundancy set. In this case, a valid reference is supported.", + "description": "An array of managers to remove from the redundancy set.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "This parameter shall contain an array of resource references of the Managers to remove from the redundancy set.", + "longDescription": "This parameter shall contain an array of managers to remove from the redundancy set.", "type": "array" } }, "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", @@ -611,7 +631,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -623,10 +643,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", @@ -645,16 +665,16 @@ "Reset": { "additionalProperties": false, "description": "The reset action resets/reboots the manager.", - "longDescription": "This action shall perform a reset of the manager.", + "longDescription": "This action shall reset the manager.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", - "description": "This is the type of reset to be performed.", - "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset." + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation specific default reset." } }, "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", @@ -670,7 +690,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -688,19 +708,19 @@ "Oem" ], "enumDescriptions": { - "IPMI": "The controller supports a Serial Console connection using the IPMI Serial-over-LAN (SOL) protocol.", - "Oem": "The controller supports a Serial Console connection using an OEM-specific protocol.", - "SSH": "The controller supports a Serial Console connection using the SSH protocol.", - "Telnet": "The controller supports a Serial Console connection using the Telnet protocol." + "IPMI": "The controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol.", + "Oem": "The controller supports a serial console connection through an OEM-specific protocol.", + "SSH": "The controller supports a serial console connection through the SSH protocol.", + "Telnet": "The controller supports a serial console connection through the Telnet protocol." }, "type": "string" }, "SerialConsole": { "additionalProperties": false, - "description": "Information about a Serial Console service provided by a manager.", - "longDescription": "This type shall describe a Serial Console service of a manager.", + "description": "The information about a serial console service that this manager provides.", + "longDescription": "This type shall describe a serial console service for a manager.", "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", @@ -715,24 +735,24 @@ }, "properties": { "ConnectTypesSupported": { - "description": "This object is used to enumerate the Serial Console connection types allowed by the implementation.", + "description": "This property enumerates the serial console connection types that the implementation allows.", "items": { "$ref": "#/definitions/SerialConnectTypesSupported" }, - "longDescription": "The value of ConnectTypesSupported shall be an array of the enumerations provided here. SSH shall be included if the Secure Shell (SSH) protocol is supported. Telnet shall be included if the Telnet protocol is supported. IPMI shall be included if the IPMI (Serial-over-LAN) protocol is supported.", + "longDescription": "This property shall contain an array of the enumerations. SSH shall be included if the Secure Shell (SSH) protocol is supported. Telnet shall be included if the Telnet protocol is supported. IPMI shall be included if the IPMI Serial Over LAN (SOL) protocol is supported.", "readonly": true, "type": "array" }, "MaxConcurrentSessions": { - "description": "Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support.", - "longDescription": "The value of this property shall contain the maximum number of concurrent service sessions supported by the implementation.", + "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.", + "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.", "minimum": 0, "readonly": true, "type": "integer" }, "ServiceEnabled": { - "description": "Indicates if the service is enabled for this manager.", - "longDescription": "The value of this property shall contain the enabled status of the protocol used for the service. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the service is enabled for this manager.", + "longDescription": "This property shall indicate whether the protocol for the service is enabled.", "readonly": false, "type": "boolean" } @@ -741,6 +761,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.2", - "title": "#Manager.v1_5_1.Manager" + "release": "2019.2", + "title": "#Manager.v1_6_0.Manager" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json b/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json index 6aa4ecf364..aa893772ab 100644 --- a/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json +++ b/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ManagerAccount.v1_2_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ManagerAccount.v1_3_1.json", "$ref": "#/definitions/ManagerAccount", "$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 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -53,13 +53,13 @@ "properties": { "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." }, "Role": { "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", - "description": "A reference to the Role object defining Privileges for this account--returned when the resource is read. The ID of the role is the same as property RoleId.", - "longDescription": "The value of this property shall be a link to a Role object instance, and should reference the object identified by property RoleId.", + "description": "The link to the Redfish Role that defines the privileges for this account.", + "longDescription": "This property shall contain a link to a Role Resource instance, and should link to the Resource identified by the RoleId property.", "readonly": true } }, @@ -67,10 +67,10 @@ }, "ManagerAccount": { "additionalProperties": false, - "description": "The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.", - "longDescription": "This resource shall be used to represent resources that represent the user accounts for the manager.", + "description": "The user accounts, owned by a manager, are defined in this Resource. Changes to a manager account may affect the current Redfish Service connection if this manager is responsible for the Redfish Service.", + "longDescription": "This Resource shall represent Resources that represent the user accounts for the manager.", "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", @@ -85,27 +85,27 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": "The actions property shall contain the available actions for this Resource.", "versionAdded": "v1_1_0" }, "Certificates": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "This is a reference to a collection of certificates used for this account.", - "longDescription": "The value of this property shall be a link to a collection of type CertificateCollection.", + "description": "The link to a collection of certificates used for this account.", + "longDescription": "This property shall contain a link to a Resource Collection of type CertificateCollection.", "readonly": true, "versionAdded": "v1_2_0" }, @@ -121,8 +121,8 @@ "readonly": true }, "Enabled": { - "description": "This property is used by a User Administrator to disable an account w/o having to delet the user information. When set to true, the user can login. When set to false, the account is administratively disabled and the user cannot login.", - "longDescription": "This property shall enable (if set to true) or disable (if set to false) the account for future logins. The value of Enable over-rides the locked property.", + "description": "An indication of whether an account is enabled. An administrator can disable it without deleting the user information. If `true`, the account is enabled and the user can log in. If `false`, the account is disabled and, in the future, the user cannot log in. This property overrides the Locked property.", + "longDescription": "This property shall indicate whether an account is enabled. If `true`, the account is enabled and the user can log in. If `false`, the account is disabled and, in the future, the user cannot log in. This property overrides the Locked property.", "readonly": false, "type": "boolean" }, @@ -132,12 +132,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Locked": { - "description": "This property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. When set to true, the account is locked. A user admin can write the property to false to manually unlock, or the account service will unlock it once the lockout duration period has passed.", - "longDescription": "This property (when set to true) shall indicate that the account service has automatically locked the account due to the accountLockoutThreshold having been exceeded. If set to true, the account is locked. If set to false, the account is not locked. A user admin shall be able to write a false to the property to clear the lockout condition, prior to the lockout duration period.", + "description": "An indication of whether the Account Service automatically locked the account because the lockout threshold was exceeded. To manually unlock the account before the lockout duration period, an administrator can change the property to `false` to clear the lockout condition.", + "longDescription": "This property shall indicate whether the Account Service automatically locked the account because the AccountLockoutThreshold was exceeded. To manually unlock the account before the lockout duration period, an administrator shall be able to change the property to `false` to clear the lockout condition.", "readonly": false, "type": "boolean" }, @@ -147,27 +147,37 @@ }, "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." }, "Password": { - "description": "This property is used with a PATCH or PUT to write the password for the account. This property is null on a GET.", - "longDescription": "The value of this property shall be the password for this account. The value shall be null for GET requests.", + "description": "The password. Use this property with a PATCH or PUT to write the password for the account. This property is `null` in responses.", + "longDescription": "This property shall contain the password for this account. The value shall be `null` in responses.", "readonly": false, "type": [ "string", "null" ] }, + "PasswordChangeRequired": { + "description": "An indication of whether the service requires that the password for this account be changed before further access to the account is allowed.", + "longDescription": "This property shall indicate whether the service requires that the password for this account be changed before further access to the account is allowed. The implementation may deny access to the service if the password has not been changed. A manager account created with an initial PasswordChangeRequired value of `true` may force a password change before first access of the account. When the Password property for this account is updated, the service shall set this property to `false`.", + "readonly": false, + "type": [ + "boolean", + "null" + ], + "versionAdded": "v1_3_0" + }, "RoleId": { - "description": "This property contains the Role for this account.", - "longDescription": "The value of this property shall be the ID (the RoleId) of the Role resource that configured for this account. The service shall reject POST, PATCH, or PUT operations that provide a RoleId that does not exist by returning HTTP 400 (Bad Request).", + "description": "The Role for this account.", + "longDescription": "This property shall contain the RoleId of the Role Resource configured for this account. The Service shall reject POST, PATCH, or PUT operations that provide a RoleId that does not exist by returning the HTTP 400 (Bad Request) status code.", "readonly": false, "type": "string" }, "UserName": { - "description": "This property contains the user name for the account.", - "longDescription": "The value of this property shall be the user name for this account.", + "description": "The user name for the account.", + "longDescription": "This property shall contain the user name for this account.", "readonly": false, "type": "string" } @@ -187,10 +197,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", @@ -208,6 +218,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#ManagerAccount.v1_2_0.ManagerAccount" + "release": "2019.1", + "title": "#ManagerAccount.v1_3_1.ManagerAccount" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json b/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json index 938a7c5b72..d3f6771b7b 100644 --- a/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json +++ b/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.v1_4_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.v1_4_2.json", "$ref": "#/definitions/ManagerNetworkProtocol", "$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_2_0" } }, @@ -34,10 +34,10 @@ }, "HTTPSProtocol": { "additionalProperties": false, - "description": "Settings for a network protocol associated with a manager.", + "description": "The settings for a network protocol associated with a manager.", "longDescription": "This type shall describe information about a protocol setting for a manager.", "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", @@ -53,14 +53,14 @@ "properties": { "Certificates": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "This is a reference to a collection of certificates used for HTTPS by this manager.", - "longDescription": "The value of this property shall be a link to a collection of type CertificateCollection.", + "description": "The link to a collection of certificates used for HTTPS by this manager.", + "longDescription": "This property shall contain a link to a Resource Collection of type CertificateCollection.", "readonly": true, "versionAdded": "v1_4_0" }, "Port": { - "description": "Indicates the protocol port.", - "longDescription": "The value of this property shall contain the port assigned for the protocol.", + "description": "The protocol port.", + "longDescription": "This property shall contain the port assigned to the protocol.", "minimum": 0, "readonly": false, "type": [ @@ -69,8 +69,8 @@ ] }, "ProtocolEnabled": { - "description": "Indicates if the protocol is enabled or disabled.", - "longDescription": "The value of this property shall contain the enabled status of the protocol. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the protocol is enabled.", + "longDescription": "This property shall indicate whether the protocol is enabled.", "readonly": false, "type": [ "boolean", @@ -82,10 +82,10 @@ }, "ManagerNetworkProtocol": { "additionalProperties": false, - "description": "This resource is used to obtain or modify the network services managed by a given manager.", - "longDescription": "This object shall be used to represent the network service settings for the manager.", + "description": "The network service settings for the manager.", + "longDescription": "This Resource shall represent the network service settings for the manager.", "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", @@ -100,33 +100,33 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": "The actions property shall contain the available actions for this Resource.", "versionAdded": "v1_2_0" }, "DHCP": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's DHCPv4 protocol support.", - "longDescription": "This object shall contain information for the DHCPv4 protocol settings for the manager.", + "description": "The settings for this manager's DHCPv4 protocol support.", + "longDescription": "This object shall contain the DHCPv4 protocol settings for the manager.", "versionAdded": "v1_1_0" }, "DHCPv6": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's DHCPv6 protocol support.", - "longDescription": "This object shall contain information for the DHCPv6 protocol settings for the manager.", + "description": "The settings for this manager's DHCPv6 protocol support.", + "longDescription": "This object shall contain the DHCPv6 protocol settings for the manager.", "versionAdded": "v1_3_0" }, "Description": { @@ -141,8 +141,8 @@ "readonly": true }, "FQDN": { - "description": "This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name.", - "longDescription": "The value of this property shall contain the fully qualified domain name for the manager.", + "description": "The fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name.", + "longDescription": "This property shall contain the fully qualified domain name for the manager.", "readonly": true, "type": [ "string", @@ -151,17 +151,17 @@ }, "HTTP": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's HTTP protocol support.", - "longDescription": "This object shall contain information for the HTTP protocol settings for the manager. The default value of the Port property should be 80 for compatibility with established client implementations." + "description": "The settings for this manager's HTTP protocol support.", + "longDescription": "This object shall contain the HTTP protocol settings for the manager. The default Port property value should be `80` for compatibility with established client implementations." }, "HTTPS": { "$ref": "#/definitions/HTTPSProtocol", - "description": "Settings for this Manager's HTTPS protocol support.", - "longDescription": "This object shall contain information for the HTTPS/SSL protocol settings for this manager. The default value of the Port property should be 443 for compatibility with established client implementations." + "description": "The settings for this manager's HTTPS protocol support.", + "longDescription": "This object shall contain the HTTPS/SSL protocol settings for this manager. The default Port property value should be `443` for compatibility with established client implementations." }, "HostName": { - "description": "The DNS Host Name of this manager, without any domain information.", - "longDescription": "The value of this property shall contain the host name without any domain information.", + "description": "The DNS host name of this manager, without any domain information.", + "longDescription": "This property shall contain the host name without any domain information.", "readonly": true, "type": [ "string", @@ -170,8 +170,8 @@ }, "IPMI": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's IPMI-over-LAN protocol support.", - "longDescription": "This object shall contain information for the IPMI over LAN protocol settings for the manager. The default value of the Port property should be 623 for compatibility with established client implementations." + "description": "The settings for this manager's IPMI-over-LAN protocol support.", + "longDescription": "This object shall contain the IPMI over LAN protocol settings for the manager. The default Port property value should be `623` for compatibility with established client implementations." }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -179,13 +179,13 @@ }, "KVMIP": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's KVM-IP protocol support.", - "longDescription": "This object shall contain information for the KVM-IP (Keyboard, Video, Mouse) protocol settings for the manager." + "description": "The settings for this manager's KVM-IP protocol support.", + "longDescription": "This object shall contain the KVM-IP (Keyboard, Video, Mouse over IP) protocol settings for the manager." }, "NTP": { "$ref": "#/definitions/NTPProtocol", - "description": "Settings for this Manager's NTP protocol support.", - "longDescription": "This object shall contain information for the NTP protocol settings for the manager.", + "description": "The settings for this manager's NTP protocol support.", + "longDescription": "This object shall contain the NTP protocol settings for the manager.", "versionAdded": "v1_2_0" }, "Name": { @@ -194,50 +194,50 @@ }, "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." }, "RDP": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's Remote Desktop Protocol support.", - "longDescription": "This object shall contain information for the Remote Desktop Protocol settings for the manager.", + "description": "The settings for this manager's Remote Desktop Protocol support.", + "longDescription": "This object shall contain the Remote Desktop Protocol settings for the manager.", "versionAdded": "v1_3_0" }, "RFB": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's Remote Frame Buffer protocol support, which can be used to support VNC.", - "longDescription": "This object shall contain information for the Remote Frame Buffer protocol settings for the manager.", + "description": "The settings for this manager's Remote Frame Buffer protocol support, which can support VNC.", + "longDescription": "This object shall contain the Remote Frame Buffer protocol settings for the manager.", "versionAdded": "v1_3_0" }, "SNMP": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's SNMP support.", - "longDescription": "This object shall contain information for the SNMP protocol settings for this manager. The default value of the Port property should be 161 for compatibility with established client implementations." + "description": "The settings for this manager's SNMP support.", + "longDescription": "This object shall contain the SNMP protocol settings for this manager. The default Port property value should be `161` for compatibility with established client implementations." }, "SSDP": { "$ref": "#/definitions/SSDProtocol", - "description": "Settings for this Manager's SSDP support.", - "longDescription": "This object shall contain information for the SSDP protocol settings for this manager. Simple Service Discovery Protocol (SSDP) is for network discovery of devices supporting the Redfish service. The default value of the Port property should be 1900 for compatibility with established client implementations." + "description": "The settings for this manager's SSDP support.", + "longDescription": "This object shall contain the SSDP protocol settings for this manager. Simple Service Discovery Protocol (SSDP) is for network discovery of devices supporting the Redfish Service. The default Port property value should be `1900` for compatibility with established client implementations." }, "SSH": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's SSH (Secure Shell) protocol support.", - "longDescription": "This object shall contain information for the SSH protocol settings for the manager. The default value of the Port property should be 22 for compatibility with established client implementations." + "description": "The settings for this manager's Secure Shell (SSH) protocol support.", + "longDescription": "This object shall contain the Secure Shell (SSH) protocol settings for the manager. The default value should be 22 for compatibility with established client implementations." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Telnet": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's Telnet protocol support.", - "longDescription": "This object shall contain information for the Telnet protocol settings for this manager. The default value of the Port property should be 23 for compatibility with established client implementations." + "description": "The settings for this manager's Telnet protocol support.", + "longDescription": "This object shall contain the Telnet protocol settings for this manager. The default Port property value should be `23` for compatibility with established client implementations." }, "VirtualMedia": { "$ref": "#/definitions/Protocol", - "description": "Settings for this Manager's Virtual Media support.", - "longDescription": "This object shall contain information for the Virtual Media protocol settings for this manager. The value of the Port property shall contain the TCP port assigned for Virtual Media usage." + "description": "The settings for this manager's virtual media support.", + "longDescription": "This object shall contain the virtual media protocol settings for this manager. The Port property shall contain the TCP port assigned for Virtual Media usage." } }, "required": [ @@ -250,10 +250,10 @@ }, "NTPProtocol": { "additionalProperties": false, - "description": "Settings for a network protocol associated with a manager.", + "description": "The settings for a network protocol associated with a manager.", "longDescription": "This type shall describe information about a protocol setting for a manager.", "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", @@ -275,14 +275,14 @@ "null" ] }, - "longDescription": "The value of this property shall contain all the NTP servers for which this manager is using to obtain time.", + "longDescription": "This property shall contain all the NTP servers for which this manager is using to obtain time.", "readonly": false, "type": "array", "versionAdded": "v1_2_0" }, "Port": { - "description": "Indicates the protocol port.", - "longDescription": "The value of this property shall contain the port assigned for the protocol.", + "description": "The protocol port.", + "longDescription": "This property shall contain the port assigned to the protocol.", "minimum": 0, "readonly": false, "type": [ @@ -291,8 +291,8 @@ ] }, "ProtocolEnabled": { - "description": "Indicates if the protocol is enabled or disabled.", - "longDescription": "The value of this property shall contain the enabled status of the protocol. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the protocol is enabled.", + "longDescription": "This property shall indicate whether the protocol is enabled.", "readonly": false, "type": [ "boolean", @@ -309,18 +309,18 @@ "Organization" ], "enumDescriptions": { - "Link": "SSDP Notify messages are sent to addresses in the IPv6 Local Link scope.", - "Organization": "SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope.", - "Site": "SSDP Notify messages are sent to addresses in the IPv6 Local Site scope." + "Link": "SSDP NOTIFY messages are sent to addresses in the IPv6 local link scope.", + "Organization": "SSDP NOTIFY messages are sent to addresses in the IPv6 local organization scope.", + "Site": "SSDP NOTIFY messages are sent to addresses in the IPv6 local site scope." }, "type": "string" }, "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", @@ -338,10 +338,10 @@ }, "Protocol": { "additionalProperties": false, - "description": "Settings for a network protocol associated with a manager.", + "description": "The settings for a network protocol associated with a manager.", "longDescription": "This type shall describe information about a protocol setting for a manager.", "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", @@ -356,8 +356,8 @@ }, "properties": { "Port": { - "description": "Indicates the protocol port.", - "longDescription": "The value of this property shall contain the port assigned for the protocol.", + "description": "The protocol port.", + "longDescription": "This property shall contain the port assigned to the protocol.", "minimum": 0, "readonly": false, "type": [ @@ -366,8 +366,8 @@ ] }, "ProtocolEnabled": { - "description": "Indicates if the protocol is enabled or disabled.", - "longDescription": "The value of this property shall contain the enabled status of the protocol. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the protocol is enabled.", + "longDescription": "This property shall indicate whether the protocol is enabled.", "readonly": false, "type": [ "boolean", @@ -379,10 +379,10 @@ }, "SSDProtocol": { "additionalProperties": false, - "description": "Settings for a network protocol associated with a manager.", + "description": "The settings for a network protocol associated with a manager.", "longDescription": "This type shall describe information about a protocol setting for a manager.", "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", @@ -405,13 +405,13 @@ "type": "null" } ], - "description": "Indicates the scope for the IPv6 Notify messages for SSDP.", - "longDescription": "The value of this property shall contain the IPv6 scope used for multicast NOTIFY messages. The valid enumerations are a subset of the available IPv6 Scope types.", + "description": "The IPv6 scope for multicast NOTIFY messages for SSDP.", + "longDescription": "This property shall contain the IPv6 scope for multicast NOTIFY messages. The valid enumerations are a subset of the available IPv6 scope types.", "readonly": false }, "NotifyMulticastIntervalSeconds": { - "description": "Indicates how often the Multicast is done from this service for SSDP.", - "longDescription": "The value of this property shall contain the time interval, in seconds, between transmissions of the multicast NOTIFY ALIVE message. A setting of 0 seconds shall disable this functionality. The recommended value is 600 seconds.", + "description": "The time interval, in seconds, between transmissions of the multicast NOTIFY ALIVE message from this service for SSDP.", + "longDescription": "This property shall contain the time interval, in seconds, between transmissions of the multicast NOTIFY ALIVE message. A setting of 0 seconds shall disable this functionality. The recommended value is 600 seconds.", "minimum": 0, "readonly": false, "type": [ @@ -421,8 +421,8 @@ "units": "s" }, "NotifyTTL": { - "description": "Indicates the time to live hop count for SSDPs Notify messages.", - "longDescription": "The value of this property shall contain the Time-To-Live hop count used for multicast NOTIFY messages. The recommended value is 2.", + "description": "The time-to-live hop count for SSDP multicast NOTIFY messages.", + "longDescription": "This property shall contain the time-to-live hop count used for multicast NOTIFY messages. The recommended value is 2.", "minimum": 1, "readonly": false, "type": [ @@ -431,8 +431,8 @@ ] }, "Port": { - "description": "Indicates the protocol port.", - "longDescription": "The value of this property shall contain the port assigned for the protocol.", + "description": "The protocol port.", + "longDescription": "This property shall contain the port assigned to the protocol.", "minimum": 0, "readonly": false, "type": [ @@ -441,8 +441,8 @@ ] }, "ProtocolEnabled": { - "description": "Indicates if the protocol is enabled or disabled.", - "longDescription": "The value of this property shall contain the enabled status of the protocol. The value shall be true if enabled and false if disabled.", + "description": "An indication of whether the protocol is enabled.", + "longDescription": "This property shall indicate whether the protocol is enabled.", "readonly": false, "type": [ "boolean", @@ -455,5 +455,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#ManagerNetworkProtocol.v1_4_0.ManagerNetworkProtocol" + "title": "#ManagerNetworkProtocol.v1_4_2.ManagerNetworkProtocol" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Memory/Memory.json b/static/redfish/v1/JsonSchemas/Memory/Memory.json index a794c5d8fa..f8fa07dbf2 100644 --- a/static/redfish/v1/JsonSchemas/Memory/Memory.json +++ b/static/redfish/v1/JsonSchemas/Memory/Memory.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Memory.v1_7_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Memory.v1_8_0.json", "$ref": "#/definitions/Memory", "$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", @@ -29,6 +29,9 @@ "#Memory.OverwriteUnit": { "$ref": "#/definitions/OverwriteUnit" }, + "#Memory.Reset": { + "$ref": "#/definitions/Reset" + }, "#Memory.SecureEraseUnit": { "$ref": "#/definitions/SecureEraseUnit" }, @@ -40,8 +43,8 @@ }, "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." } }, "type": "object" @@ -85,19 +88,19 @@ "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", - "longDescription": "The value of this property shall be the passphrase used in this action.", + "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { - "description": "Memory region ID for which this action to be applied.", - "longDescription": "The value of this property shall be the Memory region ID for which this action to be applied.", + "description": "The memory region ID to which to apply this action.", + "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "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", @@ -113,7 +116,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -131,19 +134,19 @@ "AddressParity" ], "enumDescriptions": { - "AddressParity": "Address Parity errors can be corrected.", - "MultiBitECC": "Multi-bit Data errors can be corrected by ECC.", + "AddressParity": "Address parity errors can be corrected.", + "MultiBitECC": "Multibit data errors can be corrected by ECC.", "NoECC": "No ECC available.", - "SingleBitECC": "Single bit Data error can be corrected by ECC." + "SingleBitECC": "Single bit data errors can be corrected by ECC." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -159,25 +162,25 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the Chassis which contains this Memory.", - "longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Memory.", + "description": "The link to the chassis that contains this memory.", + "longDescription": "This property shall contain a link to a Resource of type Chassis that represent the physical container associated with this memory.", "readonly": true, "versionAdded": "v1_2_0" }, "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." } }, "type": "object" }, "Memory": { "additionalProperties": false, - "description": "This is the schema definition for definition of a Memory and its configuration.", - "longDescription": "This resource shall be used to represent the Memory in a Redfish implementation.", + "description": "The schema for definition of a memory and its configuration.", + "longDescription": "This Resource contains the memory in 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", @@ -192,25 +195,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AllocationAlignmentMiB": { - "description": "The boundary which memory regions are allocated on, measured in mebibytes (MiB).", - "longDescription": "The value of this property shall be thealignment boundary on which memory regions are allocated, measured in MiB.", + "description": "The boundary that memory regions are allocated on, measured in mebibytes (MiB).", + "longDescription": "This property shall contain the alignment boundary on which memory regions are allocated, measured in MiB.", "readonly": true, "type": [ "integer", @@ -221,7 +224,7 @@ }, "AllocationIncrementMiB": { "description": "The size of the smallest unit of allocation for a memory region in mebibytes (MiB).", - "longDescription": "The value of this property shall be the allocation increment for regions, measured in MiB.", + "longDescription": "This property shall contain the allocation increment for regions, measured in MiB.", "readonly": true, "type": [ "integer", @@ -231,19 +234,19 @@ "versionAdded": "v1_2_0" }, "AllowedSpeedsMHz": { - "description": "Speed bins supported by this Memory.", + "description": "Speeds supported by this memory.", "items": { "type": "integer" }, - "longDescription": "The value of this property shall be the speed supported by this Memory.", + "longDescription": "This property shall contain the speed supported by this memory.", "readonly": true, "type": "array", "units": "MHz" }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this memory.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to the assembly Resource associated with this memory.", + "longDescription": "This property shall contain a link to a Resource of type assembly.", "readonly": true, "versionAdded": "v1_4_0" }, @@ -256,13 +259,13 @@ "type": "null" } ], - "description": "The base module type of Memory.", - "longDescription": "The value of this property shall be the base module type of Memory.", + "description": "The base module type of the memory.", + "longDescription": "This property shall contain the base module type of the memory.", "readonly": true }, "BusWidthBits": { - "description": "Bus Width in bits.", - "longDescription": "The value of this property shall be the bus width in bits.", + "description": "The bus width, in bits.", + "longDescription": "This property shall contain the bus width, in bits.", "readonly": true, "type": [ "integer", @@ -271,7 +274,7 @@ }, "CacheSizeMiB": { "description": "Total size of the cache portion memory in MiB.", - "longDescription": "The value of this property shall be the total size of the cache portion memory in MiB.", + "longDescription": "This property shall contain the total size of the cache portion memory in MiB.", "readonly": true, "type": [ "integer", @@ -281,8 +284,8 @@ "versionAdded": "v1_4_0" }, "CapacityMiB": { - "description": "Memory Capacity in mebibytes (MiB).", - "longDescription": "The value of this property shall be the Memory capacity in MiB.", + "description": "Memory capacity in mebibytes (MiB).", + "longDescription": "This property shall contain the memory capacity in MiB.", "readonly": true, "type": [ "integer", @@ -291,8 +294,8 @@ "units": "MiBy" }, "ConfigurationLocked": { - "description": "Indicates that the configuration of this memory has been locked.", - "longDescription": "The value of this property shall be the current configuration lock state of this memory. True shall indicate that the configuration is locked and cannot be altered. False shall indicate that the configuration is not locked and may be altered.", + "description": "An indication of whether the configuration of this memory is locked and cannot be altered.", + "longDescription": "This property shall indicate whether the configuration of this memory is locked and cannot be altered.", "readonly": true, "type": [ "boolean", @@ -301,8 +304,8 @@ "versionAdded": "v1_7_0" }, "DataWidthBits": { - "description": "Data Width in bits.", - "longDescription": "The value of this property shall be the data width in bits.", + "description": "Data width in bits.", + "longDescription": "This property shall contain the data width in bits.", "readonly": true, "type": [ "integer", @@ -321,17 +324,19 @@ "readonly": true }, "DeviceID": { + "deprecated": "This property has been deprecated in favor of ModuleProductID.", "description": "Device ID.", - "longDescription": "The value of this property shall be the device ID of the Memory.", + "longDescription": "This property shall contain the device ID of the memory.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionDeprecated": "v1_3_0" }, "DeviceLocator": { - "description": "Location of the Memory in the platform.", - "longDescription": "The value of this property shall be location of the Memory in the platform, typically marked in the silk screen.", + "description": "Location of the memory in the platform.", + "longDescription": "This property shall contain location of the memory in the platform, typically marked in the silk screen.", "readonly": true, "type": [ "string", @@ -348,12 +353,12 @@ } ], "description": "Error correction scheme supported for this memory.", - "longDescription": "The value of this property shall be the error correction scheme supported for this memory.", + "longDescription": "This property shall contain the error correction scheme supported for this memory.", "readonly": true }, "FirmwareApiVersion": { "description": "Version of API supported by the firmware.", - "longDescription": "The value of this property shall be the version of API supported by the firmware.", + "longDescription": "This property shall contain the version of API supported by the firmware.", "readonly": true, "type": [ "string", @@ -361,8 +366,8 @@ ] }, "FirmwareRevision": { - "description": "Revision of firmware on the Memory controller.", - "longDescription": "The value of this property shall be the revision of firmware on the Memory controller.", + "description": "Revision of firmware on the memory controller.", + "longDescription": "This property shall contain the revision of firmware on the memory controller.", "readonly": true, "type": [ "string", @@ -370,21 +375,23 @@ ] }, "FunctionClasses": { - "description": "Function Classes by the Memory.", + "deprecated": "This property has been deprecated in favor of OperatingMemoryModes at the root of the Resource, or MemoryClassification found within RegionSet.", + "description": "Function classes by the memory.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be the function classes by the Memory.", + "longDescription": "This property shall contain the function classes by the memory.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_3_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "IsRankSpareEnabled": { - "description": "Rank spare enabled status.", - "longDescription": "The value of this property shall be true if a rank spare is enabled for this Memory.", + "description": "An indication of whether rank spare is enabled for this memory.", + "longDescription": "This property shall indicate whether rank spare is enabled for this memory.", "readonly": true, "type": [ "boolean", @@ -392,8 +399,8 @@ ] }, "IsSpareDeviceEnabled": { - "description": "Spare device enabled status.", - "longDescription": "The value of this property shall be true if a spare device is enabled for this Memory.", + "description": "An indication of whether a spare device is enabled for this memory.", + "longDescription": "This property shall indicate whether the spare device is enabled.", "readonly": true, "type": [ "boolean", @@ -402,19 +409,19 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", "versionAdded": "v1_2_0" }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the memory.", + "description": "The location of the memory.", "longDescription": "This property shall contain location information of the associated memory.", "versionAdded": "v1_4_0" }, "LogicalSizeMiB": { "description": "Total size of the logical memory in MiB.", - "longDescription": "The value of this property shall be the total size of the logical memory in MiB.", + "longDescription": "This property shall contain the total size of the logical memory in MiB.", "readonly": true, "type": [ "integer", @@ -424,8 +431,8 @@ "versionAdded": "v1_4_0" }, "Manufacturer": { - "description": "The Memory manufacturer.", - "longDescription": "This property shall contain a string which identifies the manufacturer of the Memory.", + "description": "The memory manufacturer.", + "longDescription": "This property shall contain the manufacturer of the memory.", "readonly": true, "type": [ "string", @@ -433,11 +440,11 @@ ] }, "MaxTDPMilliWatts": { - "description": "Maximum TDPs in milli Watts.", + "description": "Set of maximum power budgets supported by the memory in milliwatts.", "items": { "type": "integer" }, - "longDescription": "The value of this property shall be the maximum power budgets supported by the Memory in milli Watts.", + "longDescription": "This property shall contain an array of maximum power budgets supported by the memory in milliwatts.", "readonly": true, "type": "array", "units": "mW" @@ -451,27 +458,27 @@ "type": "null" } ], - "description": "Type details of the Memory.", - "longDescription": "The value of this property shall be the Memory Device Type as defined by SMBIOS.", + "description": "Type details of the memory.", + "longDescription": "This property shall contain the Memory Device Type as defined by SMBIOS.", "readonly": true }, "MemoryLocation": { "$ref": "#/definitions/MemoryLocation", "description": "Memory connection information to sockets and memory controllers.", - "longDescription": "This object shall contain properties which describe the Memory connection information to sockets and memory controllers." + "longDescription": "This object shall contain properties that describe the memory connection information to sockets and memory controllers." }, "MemoryMedia": { - "description": "Media of this Memory.", + "description": "Media of this memory.", "items": { "$ref": "#/definitions/MemoryMedia" }, - "longDescription": "The value of this property shall be the media types of this Memory.", + "longDescription": "This property shall contain the media types of this memory.", "readonly": true, "type": "array" }, "MemorySubsystemControllerManufacturerID": { "description": "The manufacturer ID of the memory subsystem controller of this memory module.", - "longDescription": "The value of this property shall be the two byte manufacturer ID of the memory subsystem controller of this memory module as defined by JEDEC in JEP-106.", + "longDescription": "This property shall contain the two byte manufacturer ID of the memory subsystem controller of this memory module as defined by JEDEC in JEP-106.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -482,7 +489,7 @@ }, "MemorySubsystemControllerProductID": { "description": "The product ID of the memory subsystem controller of this memory module.", - "longDescription": "The value of this property shall be the two byte product ID of the memory subsystem controller of this memory module as defined by the manufacturer.", + "longDescription": "This property shall contain the two byte product ID of the memory subsystem controller of this memory module as defined by the manufacturer.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -500,19 +507,19 @@ "type": "null" } ], - "description": "The type of Memory.", - "longDescription": "The value of this property shall be the type of Memory represented by this resource.", + "description": "The type of memory.", + "longDescription": "This property shall contain the type of memory that this Resource represents.", "readonly": true }, "Metrics": { "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.json#/definitions/MemoryMetrics", - "description": "A reference to the Metrics associated with this Memory.", - "longDescription": "A reference to the Metrics associated with this Memory.", + "description": "The link to the Metrics associated with this memory.", + "longDescription": "The link to the metrics associated with this memory.", "readonly": true }, "ModuleManufacturerID": { "description": "The manufacturer ID of this memory module.", - "longDescription": "The value of this property shall be the two byte manufacturer ID of this memory module as defined by JEDEC in JEP-106.", + "longDescription": "This property shall contain the two byte manufacturer ID of this memory module as defined by JEDEC in JEP-106.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -523,7 +530,7 @@ }, "ModuleProductID": { "description": "The product ID of this memory module.", - "longDescription": "The value of this property shall be the two byte product ID of this memory module as defined by the manufacturer.", + "longDescription": "This property shall contain the two byte product ID of this memory module as defined by the manufacturer.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -538,7 +545,7 @@ }, "NonVolatileSizeMiB": { "description": "Total size of the non-volatile portion memory in MiB.", - "longDescription": "The value of this property shall be the total size of the non-volatile portion memory in MiB.", + "longDescription": "This property shall contain the total size of the non-volatile portion memory in MiB.", "readonly": true, "type": [ "integer", @@ -549,21 +556,21 @@ }, "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." }, "OperatingMemoryModes": { - "description": "Memory modes supported by the Memory.", + "description": "Memory modes supported by the memory.", "items": { "$ref": "#/definitions/OperatingMemoryModes" }, - "longDescription": "The value of this property shall be the memory modes supported by the Memory.", + "longDescription": "This property shall contain the memory modes supported by the memory.", "readonly": true, "type": "array" }, "OperatingSpeedMhz": { - "description": "Operating speed of Memory in MHz or MT/s as appropriate.", - "longDescription": "The value of this property shall be the operating speed of Memory in MHz or MT/s (mega-transfers per second) as reported by the memory device. Memory devices which operate at their bus speed shall report the operating speed in MHz (bus speed), while memory device which transfer data faster than their bus speed (e.g. DDR memory) shall report the operating speed in MT/s (mega-transfers/second). In any case, the reported value shall match the conventionally reported values for the technology utilized by the memory device.", + "description": "Operating speed of memory in MHz or MT/s as appropriate.", + "longDescription": "This property shall contain the operating speed of memory in MHz or MT/s (mega-transfers per second) as reported by the memory device. memory devices that operate at their bus speed shall report the operating speed in MHz (bus speed), while memory devices that transfer data faster than their bus speed, such as DDR memory, shall report the operating speed in MT/s (mega-transfers/second). In any case, the reported value shall match the conventionally reported values for the technology used by the memory device.", "readonly": true, "type": [ "integer", @@ -573,7 +580,7 @@ }, "PartNumber": { "description": "The product part number of this device.", - "longDescription": "This property shall indicate the part number as provided by the manufacturer of this Memory.", + "longDescription": "This property shall indicate the part number as provided by the manufacturer of this memory.", "readonly": true, "type": [ "string", @@ -581,8 +588,8 @@ ] }, "PersistentRegionNumberLimit": { - "description": "Total number of persistent regions this Memory can support.", - "longDescription": "The value of this property shall be the total number of persistent regions this Memory can support.", + "description": "Total number of persistent regions this memory can support.", + "longDescription": "This property shall contain the total number of persistent regions this memory can support.", "readonly": true, "type": [ "integer", @@ -592,7 +599,7 @@ }, "PersistentRegionSizeLimitMiB": { "description": "Total size of persistent regions in mebibytes (MiB).", - "longDescription": "The value of this property shall be the total size of persistent regions in MiB.", + "longDescription": "This property shall contain the total size of persistent regions in MiB.", "readonly": true, "type": [ "integer", @@ -602,7 +609,7 @@ }, "PersistentRegionSizeMaxMiB": { "description": "Maximum size of a single persistent region in mebibytes (MiB).", - "longDescription": "The value of this property shall be the maximum size of a single persistent regions in MiB.", + "longDescription": "This property shall contain the maximum size of a single persistent regions in MiB.", "readonly": true, "type": [ "integer", @@ -614,11 +621,11 @@ "PowerManagementPolicy": { "$ref": "#/definitions/PowerManagementPolicy", "description": "Power management policy information.", - "longDescription": "This object shall contain properties which describe the power management policy for the current resource." + "longDescription": "This object shall contain properties that describe the power management policy for this Resource." }, "RankCount": { - "description": "Number of ranks available in the Memory.", - "longDescription": "The value of this property shall be number of ranks available in the Memory. The ranks could be used for spare or interleave.", + "description": "Number of ranks available in the memory.", + "longDescription": "This property shall contain the number of ranks available in the memory. The ranks could be used for spare or interleave.", "readonly": true, "type": [ "integer", @@ -626,17 +633,17 @@ ] }, "Regions": { - "description": "Memory regions information within the Memory.", + "description": "Memory regions information within the memory.", "items": { "$ref": "#/definitions/RegionSet" }, - "longDescription": "The value of this property shall be the memory region information within the Memory.", + "longDescription": "This property shall contain the memory region information within the memory.", "type": "array" }, "SecurityCapabilities": { "$ref": "#/definitions/SecurityCapabilities", - "description": "This object contains security capabilities of the Memory.", - "longDescription": "This object shall contain properties which describe the security capabilities of the Memory." + "description": "Security capabilities of the memory.", + "longDescription": "This property shall contain properties that describe the security capabilities of the memory." }, "SecurityState": { "anyOf": [ @@ -647,14 +654,14 @@ "type": "null" } ], - "description": "The current security state of this Memory.", - "longDescription": "The value of this property shall be the current security state of this memory.", + "description": "The current security state of this memory.", + "longDescription": "This property shall contain the current security state of this memory.", "readonly": false, "versionAdded": "v1_7_0" }, "SerialNumber": { "description": "The product serial number of this device.", - "longDescription": "This property shall indicate the serial number as provided by the manufacturer of this Memory.", + "longDescription": "This property shall indicate the serial number as provided by the manufacturer of this memory.", "readonly": true, "type": [ "string", @@ -662,8 +669,8 @@ ] }, "SpareDeviceCount": { - "description": "Number of unused spare devices available in the Memory.", - "longDescription": "The value of this property shall be the number of unused spare devices available in the Memory. If memory devices fails, the spare device could be used.", + "description": "Number of unused spare devices available in the memory.", + "longDescription": "This property shall contain the number of unused spare devices available in the memory. If memory devices fails, the spare device could be used.", "readonly": true, "type": [ "integer", @@ -672,40 +679,46 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource.", "versionAdded": "v1_1_0" }, "SubsystemDeviceID": { - "description": "Subsystem Device ID.", - "longDescription": "The value of this property shall be the subsystem Device ID of the Memory.", + "deprecated": "This property has been deprecated in favor of MemorySubsystemControllerProductID.", + "description": "Subsystem device ID.", + "longDescription": "This property shall contain the subsystem device ID of the memory.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionDeprecated": "v1_3_0" }, "SubsystemVendorID": { - "description": "SubSystem Vendor ID.", - "longDescription": "The value of this property shall be the subsystem Vendor ID of the Memory.", + "deprecated": "This property has been deprecated in favor of MemorySubsystemControllerManufacturerID.", + "description": "SubSystem vendor ID.", + "longDescription": "This property shall contain the subsystem vendor ID of the memory.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionDeprecated": "v1_3_0" }, "VendorID": { + "deprecated": "This property has been deprecated in favor of ModuleManufacturerID.", "description": "Vendor ID.", - "longDescription": "The value of this property shall be the vendor ID of the Memory.", + "longDescription": "This property shall contain the vendor ID of the memory.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionDeprecated": "v1_3_0" }, "VolatileRegionNumberLimit": { - "description": "Total number of volatile regions this Memory can support.", - "longDescription": "The value of this property shall be the total number of volatile regions this Memory can support.", + "description": "Total number of volatile regions this memory can support.", + "longDescription": "This property shall contain the total number of volatile regions this memory can support.", "readonly": true, "type": [ "integer", @@ -715,7 +728,7 @@ }, "VolatileRegionSizeLimitMiB": { "description": "Total size of volatile regions in mebibytes (MiB).", - "longDescription": "The value of this property shall be the total size of volatile regions in MiB.", + "longDescription": "This property shall contain the total size of volatile regions in MiB.", "readonly": true, "type": [ "integer", @@ -725,7 +738,7 @@ }, "VolatileRegionSizeMaxMiB": { "description": "Maximum size of a single volatile region in mebibytes (MiB).", - "longDescription": "The value of this property shall be the maximum size of a single volatile regions in MiB.", + "longDescription": "This property shall contain the maximum size of a single volatile regions in MiB.", "readonly": true, "type": [ "integer", @@ -736,7 +749,7 @@ }, "VolatileSizeMiB": { "description": "Total size of the volitile portion memory in MiB.", - "longDescription": "The value of this property shall be the total size of the volatile portion memory in MiB.", + "longDescription": "This property shall contain the total size of the volatile portion memory in MiB.", "readonly": true, "type": [ "integer", @@ -761,8 +774,8 @@ "Block" ], "enumDescriptions": { - "Block": "Block accesible memory.", - "ByteAccessiblePersistent": "Byte accessible persistent memory.", + "Block": "Block-accesible memory.", + "ByteAccessiblePersistent": "Byte-accessible persistent memory.", "Volatile": "Volatile memory." }, "type": "string" @@ -826,9 +839,9 @@ "MemoryLocation": { "additionalProperties": false, "description": "Memory connection information to sockets and memory controllers.", - "longDescription": "This type shall contain properties which describe the Memory connection information to sockets and memory controllers.", + "longDescription": "This type shall contain properties that describe the memory connection information to sockets and memory controllers.", "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", @@ -843,8 +856,8 @@ }, "properties": { "Channel": { - "description": "Channel number in which Memory is connected.", - "longDescription": "Channel number in which Memory is connected.", + "description": "The channel number to which the memory is connected.", + "longDescription": "This property shall contain the channel number to which the memory is connected.", "readonly": true, "type": [ "integer", @@ -852,8 +865,8 @@ ] }, "MemoryController": { - "description": "Memory controller number in which Memory is connected.", - "longDescription": "Memory controller number in which Memory is connected.", + "description": "The memory controller number to which the memory is connected.", + "longDescription": "This property shall contain the memory controller number to which the memory is connected.", "readonly": true, "type": [ "integer", @@ -861,8 +874,8 @@ ] }, "Slot": { - "description": "Slot number in which Memory is connected.", - "longDescription": "Slot number in which Memory is connected.", + "description": "The slot number to which the memory is connected.", + "longDescription": "This property shall contain the slot number to which the memory is connected.", "readonly": true, "type": [ "integer", @@ -870,8 +883,8 @@ ] }, "Socket": { - "description": "Socket number in which Memory is connected.", - "longDescription": "Socket number in which Memory is connected.", + "description": "The socket number to which the memory is connected.", + "longDescription": "This property shall contain the socket number to which the memory is connected.", "readonly": true, "type": [ "integer", @@ -908,15 +921,15 @@ "IntelOptane" ], "enumDescriptions": { - "DRAM": "The memory module is composed of volatile memory.", - "IntelOptane": "The memory module is Intel Optane DC Persistent Memory and composed of a combination of non-volatile and volatile memory.", - "NVDIMM_F": "The memory module is composed of non-volatile memory.", - "NVDIMM_N": "The memory module is composed of volatile memory backed by non-volatile memory.", - "NVDIMM_P": "The memory module is composed of a combination of non-volatile and volatile memory." + "DRAM": "The memory module is comprised of volatile memory.", + "IntelOptane": "The memory module is an Intel Optane DC Persistent Memory Module.", + "NVDIMM_F": "The memory module is comprised of non-volatile memory.", + "NVDIMM_N": "The memory module is comprised of volatile memory backed by non-volatile memory.", + "NVDIMM_P": "The memory module is comprised of a combination of non-volatile and volatile memory." }, "enumLongDescriptions": { "DRAM": "This memory type shall represent volatile DRAM.", - "IntelOptane": "This memory type shall represent Intel Optane DC Persistent Memory.", + "IntelOptane": "This memory type shall represent an Intel Optane DC Persistent Memory Module.", "NVDIMM_F": "This memory type shall represent NVDIMM_F as defined by JEDEC.", "NVDIMM_N": "This memory type shall represent NVDIMM_N as defined by JEDEC.", "NVDIMM_P": "This memory type shall represent NVDIMM_P as defined by JEDEC." @@ -928,10 +941,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", @@ -954,32 +967,32 @@ "Block" ], "enumDescriptions": { - "Block": "Block accessible system memory.", - "PMEM": "Persistent memory, byte accesible through system address space.", + "Block": "Block-accessible system memory.", + "PMEM": "Persistent memory, byte-accesible through system address space.", "Volatile": "Volatile memory." }, "type": "string" }, "OverwriteUnit": { "additionalProperties": false, - "description": "This defines the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite.", - "longDescription": "This action shall securely erase the supplied region provided the supplied passphrase matches that of the given region using the NIST SP800-88 Purge: Overwrite. Use the SecureEraseUnit method to perform NIST SP800-88 Purge: Cryptographic Erase.", + "description": "This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite.", + "longDescription": "This action shall securely erase the supplied region provided the supplied passphrase matches that of the given region using the NIST SP800-88 Purge: Overwrite. Use the SecureEraseUnit method to perform NIST SP800-88 Purge: Cryptographic Erase.", "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", - "longDescription": "The value of this property shall be the passphrase used in this action.", + "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { - "description": "Memory region ID for which this action to be applied.", - "longDescription": "The value of this property shall be the Memory region ID for which this action to be applied.", + "description": "The memory region ID to which to apply this action.", + "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "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", @@ -995,7 +1008,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1009,9 +1022,9 @@ "PowerManagementPolicy": { "additionalProperties": false, "description": "Power management policy information.", - "longDescription": "This type shall contain properties which describe the power management policy for the current resource.", + "longDescription": "This type shall contain properties that describe the power management policy 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", @@ -1026,8 +1039,8 @@ }, "properties": { "AveragePowerBudgetMilliWatts": { - "description": "Average power budget in milli watts.", - "longDescription": "Average power budget in milli watts.", + "description": "Average power budget, in milliwatts.", + "longDescription": "This property shall contain the average power budget, in milliwatts.", "readonly": true, "type": [ "integer", @@ -1036,8 +1049,8 @@ "units": "mW" }, "MaxTDPMilliWatts": { - "description": "Maximum TDP in milli watts.", - "longDescription": "Maximum TDP in milli watts.", + "description": "Maximum TDP in milliwatts.", + "longDescription": "This property shall contain the maximum TDP in milliwatts.", "readonly": true, "type": [ "integer", @@ -1046,8 +1059,8 @@ "units": "mW" }, "PeakPowerBudgetMilliWatts": { - "description": "Peak power budget in milli watts.", - "longDescription": "Peak power budget in milli watts.", + "description": "Peak power budget, in milliwatts.", + "longDescription": "This property shall contain the peak power budget, in milliwatts.", "readonly": true, "type": [ "integer", @@ -1056,8 +1069,8 @@ "units": "mW" }, "PolicyEnabled": { - "description": "Power management policy enabled status.", - "longDescription": "Power management policy enabled status.", + "description": "An indication of whether the power management policy is enabled.", + "longDescription": "This property shall indicate whether the power management policy is enabled.", "readonly": true, "type": [ "boolean", @@ -1069,10 +1082,10 @@ }, "RegionSet": { "additionalProperties": false, - "description": "Memory region information within a Memory entity.", - "longDescription": "This type shall describe the memory region information within a Memory entity.", + "description": "Memory region information within a memory device.", + "longDescription": "This type shall describe the memory region information within a memory device.", "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", @@ -1095,13 +1108,13 @@ "type": "null" } ], - "description": "Classification of memory occupied by the given memory region.", - "longDescription": "Classification of memory occupied by the given memory region.", + "description": "The classification of memory that the memory region occupies.", + "longDescription": "This property shall contain the classification of memory that the memory region occupies.", "readonly": true }, "OffsetMiB": { - "description": "Offset with in the Memory that corresponds to the starting of this memory region in mebibytes (MiB).", - "longDescription": "Offset with in the Memory that corresponds to the starting of this memory region in MiB.", + "description": "Offset within the memory that corresponds to the start of this memory region in mebibytes (MiB).", + "longDescription": "This property shall contain the offset within the memory that corresponds to the start of this memory region in MiB.", "readonly": true, "type": [ "integer", @@ -1110,8 +1123,8 @@ "units": "MiBy" }, "PassphraseEnabled": { - "description": "Indicates if the passphrase is enabled for this region.", - "longDescription": "The value of this property shall be a boolean indicating if the passphrase is enabled for this region.", + "description": "An indication of whether the passphrase is enabled for this region.", + "longDescription": "This property shall indicate whether the passphrase is enabled for this region.", "readonly": true, "type": [ "boolean", @@ -1120,17 +1133,19 @@ "versionAdded": "v1_5_0" }, "PassphraseState": { - "description": "State of the passphrase for this region.", - "longDescription": "State of the passphrase for this region.", + "deprecated": "This property has been deprecated in favor of PassphraseEnabled found within RegionSet.", + "description": "An indication of whether the state of the passphrase for this region is enabled.", + "longDescription": "This property shall indicate whether the state of the passphrase for this region is enabled.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionDeprecated": "v1_5_0" }, "RegionId": { - "description": "Unique region ID representing a specific region within the Memory.", - "longDescription": "Unique region ID representing a specific region within the Memory.", + "description": "Unique region ID representing a specific region within the memory.", + "longDescription": "This property shall contain the unique region ID representing a specific region within the memory.", "readonly": true, "type": [ "string", @@ -1139,7 +1154,7 @@ }, "SizeMiB": { "description": "Size of this memory region in mebibytes (MiB).", - "longDescription": "Size of this memory region in MiB.", + "longDescription": "This property shall contain the size of this memory region in MiB.", "readonly": true, "type": [ "integer", @@ -1150,26 +1165,65 @@ }, "type": "object" }, + "Reset": { + "additionalProperties": false, + "description": "This action resets this memory.", + "longDescription": "This action shall reset this memory.", + "parameters": { + "ResetType": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation specific default reset." + } + }, + "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": { + "target": { + "description": "Link to invoke action", + "format": "uri-reference", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object", + "versionAdded": "v1_8_0" + }, "SecureEraseUnit": { "additionalProperties": false, - "description": "This defines the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptograhic Erase.", - "longDescription": "This action shall securely erase the supplied region provided the supplied passphrase matches that of the given region using the NIST SP800-88 Purge: Cryptographic Erase. Use the OverwriteUnit method to perform NIST SP800-88 Purge: Overwrite.", + "description": "This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptograhic Erase.", + "longDescription": "This action shall securely erase the supplied region provided the supplied passphrase matches that of the given region using the NIST SP800-88 Purge: Cryptographic Erase. Use the OverwriteUnit method to perform NIST SP800-88 Purge: Overwrite.", "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", - "longDescription": "The value of this property shall be the passphrase used in this action.", + "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { - "description": "Memory region ID for which this action to be applied.", - "longDescription": "The value of this property shall be the Memory region ID for which this action to be applied.", + "description": "The memory region ID to which to apply this action.", + "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "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", @@ -1185,7 +1239,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1197,10 +1251,10 @@ }, "SecurityCapabilities": { "additionalProperties": false, - "description": "This type contains security capabilities of a Memory entity.", - "longDescription": "This type shall contain properties which describe the security capabilities of a Memory entity.", + "description": "This type contains security capabilities of a memory device.", + "longDescription": "This type shall contain properties that describe the security capabilities of a memory device.", "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", @@ -1215,8 +1269,8 @@ }, "properties": { "ConfigurationLockCapable": { - "description": "Support for locking the configuration.", - "longDescription": "The value of this property shall indicate whether this memory supports the locking (freezing) of the configuration.", + "description": "An indication of whether this memory supports the locking, or freezing, of the configuration.", + "longDescription": "This property shall indicate whether this memory supports the locking, or freezing, of the configuration.", "readonly": true, "type": [ "boolean", @@ -1225,8 +1279,8 @@ "versionAdded": "v1_7_0" }, "DataLockCapable": { - "description": "Support for data locking.", - "longDescription": "The value of this property shall indicate whether this memory supports the locking of data access.", + "description": "An indication of whether this memory supports data locking.", + "longDescription": "This property shall indicate whether this memory supports the locking of data access.", "readonly": true, "type": [ "boolean", @@ -1235,8 +1289,8 @@ "versionAdded": "v1_7_0" }, "MaxPassphraseCount": { - "description": "Maximum number of passphrases supported for this Memory.", - "longDescription": "Maximum number of passphrases supported for this Memory.", + "description": "Maximum number of passphrases supported for this memory.", + "longDescription": "This property shall contain the maximum number of passphrases supported for this memory.", "readonly": true, "type": [ "integer", @@ -1244,8 +1298,8 @@ ] }, "PassphraseCapable": { - "description": "Memory passphrase set capability.", - "longDescription": "Memory passphrase set capability.", + "description": "An indication of whether the memory is passphrase capable.", + "longDescription": "This property shall indicate whether the memory is passphrase capable.", "readonly": true, "type": [ "boolean", @@ -1253,8 +1307,8 @@ ] }, "PassphraseLockLimit": { - "description": "Maximum number of incorrect passphrase attempts allowed before memory is locked.", - "longDescription": "The value of this property shall be the maximum number of incorrect passphase access attempts allowed before access to data is locked. A value of zero shall indicate that there is no limit to the number of attempts.", + "description": "The maximum number of incorrect passphrase attempts allowed before memory is locked.", + "longDescription": "This property shall contain the maximum number of incorrect passphase access attempts allowed before access to data is locked. If 0, the number of attempts is infinite.", "readonly": true, "type": [ "integer", @@ -1263,13 +1317,15 @@ "versionAdded": "v1_7_0" }, "SecurityStates": { - "description": "Security states supported by the Memory.", + "deprecated": "This property has been deprecated in favor of using the individual PassphraseCapable, DataLockCapable and ConfigurationLockCapable properties.", + "description": "Security states supported by the memory.", "items": { "$ref": "#/definitions/SecurityStates" }, - "longDescription": "Security states supported by the Memory.", + "longDescription": "This property shall contain the security states supported by the memory.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_7_0" } }, "type": "object" @@ -1290,9 +1346,9 @@ "enumDescriptions": { "Disabled": "Secure mode is disabled.", "Enabled": "Secure mode is enabled and access to the data is allowed.", - "Frozen": "Secure state is frozen and can not be modified until reset.", + "Frozen": "Secure state is frozen and cannot be modified until reset.", "Locked": "Secure mode is enabled and access to the data is locked.", - "Passphraselimit": "Number of attempts to unlock the Memory exceeded limit.", + "Passphraselimit": "Number of attempts to unlock the memory exceeded limit.", "Unlocked": "Secure mode is enabled and access to the data is unlocked." }, "enumVersionDeprecated": { @@ -1308,19 +1364,19 @@ "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", - "longDescription": "The value of this property shall be the passphrase used in this action.", + "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { - "description": "Memory region ID for which this action to be applied.", - "longDescription": "The value of this property shall be the Memory region ID for which this action to be applied.", + "description": "The memory region ID to which to apply this action.", + "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "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", @@ -1336,7 +1392,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1348,24 +1404,24 @@ }, "UnlockUnit": { "additionalProperties": false, - "description": "This defines the action for unlocking given regions.", + "description": "This contains the action for unlocking given regions.", "longDescription": "This action shall apply the supplied passphrase to the supplied region for the purpose of unlocking the given regions.", "parameters": { "Passphrase": { - "description": "Passphrase for doing the operation.", - "longDescription": "The value of this property shall be the passphrase used in this actionn.", + "description": "The passphrase required to complete the operation.", + "longDescription": "This property shall contain the passphrase required to complete this actionn.", "requiredParameter": true, "type": "string" }, "RegionId": { - "description": "Memory region ID for which this action to be applied.", - "longDescription": "The value of this property shall be the Memory region ID for which this action to be applied.", + "description": "The memory region ID to which to apply this action.", + "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "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", @@ -1381,7 +1437,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -1393,6 +1449,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#Memory.v1_7_0.Memory" + "release": "2019.2", + "title": "#Memory.v1_8_0.Memory" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/MemoryChunks/MemoryChunks.json b/static/redfish/v1/JsonSchemas/MemoryChunks/MemoryChunks.json index ec12299c2e..b40f6e8066 100644 --- a/static/redfish/v1/JsonSchemas/MemoryChunks/MemoryChunks.json +++ b/static/redfish/v1/JsonSchemas/MemoryChunks/MemoryChunks.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/MemoryChunks.v1_2_4.json", "$ref": "#/definitions/MemoryChunks", "$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" @@ -48,7 +50,7 @@ "description": "This an interleave set for a memory chunk.", "longDescription": "This type shall describe an interleave set of which the memory chunk is a part.", "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", @@ -63,14 +65,14 @@ }, "properties": { "Memory": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", "description": "Describes a memory device of the interleave set.", - "longDescription": "The value of this property shall be the memory device to which these settings apply.", + "longDescription": "This property shall contain the memory device to which these settings apply.", "readonly": true }, "MemoryLevel": { "description": "Level of the interleave set for multi-level tiered memory.", - "longDescription": "The value of this property shall be the level of this interleave set for multi-level tiered memory.", + "longDescription": "This property shall contain the level of this interleave set for multi-level tiered memory.", "readonly": true, "type": [ "integer", @@ -79,7 +81,7 @@ }, "OffsetMiB": { "description": "Offset within the DIMM that corresponds to the start of this memory region, measured in mebibytes (MiB).", - "longDescription": "The value of this property shall be the offset within the DIMM that corresponds to the start of this memory region, with units in MiB.", + "longDescription": "This property shall contain the offset within the DIMM that corresponds to the start of this memory region, with units in MiB.", "readonly": true, "type": [ "integer", @@ -89,7 +91,7 @@ }, "RegionId": { "description": "DIMM region identifier.", - "longDescription": "The value of this property shall be the DIMM region identifier.", + "longDescription": "This property shall contain the DIMM region identifier.", "readonly": true, "type": [ "string", @@ -98,7 +100,7 @@ }, "SizeMiB": { "description": "Size of this memory region measured in mebibytes (MiB).", - "longDescription": "The value of this property shall be the size of this memory region, with units in MiB.", + "longDescription": "This property shall contain the size of this memory region, with units in MiB.", "readonly": true, "type": [ "integer", @@ -111,10 +113,10 @@ }, "MemoryChunks": { "additionalProperties": false, - "description": "This is the schema definition of a Memory Chunk and its configuration.", - "longDescription": "This resource shall be used to represent Memory Chunks and Interleave Sets in a Redfish implementation.", + "description": "The schema definition of a memory chunk and its configuration.", + "longDescription": "This Resource shall represent memory chunks and interleave sets in 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", @@ -129,21 +131,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AddressRangeType": { "anyOf": [ @@ -155,7 +158,7 @@ } ], "description": "Memory type of this memory chunk.", - "longDescription": "The value of this property shall be the type of memory chunk.", + "longDescription": "This property shall contain the type of memory chunk.", "readonly": true }, "Description": { @@ -174,23 +177,16 @@ "readonly": true }, "InterleaveSets": { - "description": "This is the interleave sets for the memory chunk.", + "description": "The interleave sets for the memory chunk.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/InterleaveSet" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/InterleaveSet" }, "longDescription": "These properties shall represent the interleave sets for the memory chunk.", "type": "array" }, "IsMirrorEnabled": { - "description": "Mirror Enabled status.", - "longDescription": "The value of this property shall indicate if memory mirroring is enabled for this MemoryChunk.", + "description": "An indication of whether memory mirroring is enabled for this memory chunk.", + "longDescription": "This property shall indicate whether memory mirroring is enabled for this memory chunk.", "readonly": true, "type": [ "boolean", @@ -198,8 +194,8 @@ ] }, "IsSpare": { - "description": "Spare enabled status.", - "longDescription": "The value of this property shall indicate if sparing is enabled for this MemoryChunk.", + "description": "An indication of whether sparing is enabled for this memory chunk.", + "longDescription": "This property shall indicate whether sparing is enabled for this memory chunk.", "readonly": true, "type": [ "boolean", @@ -208,7 +204,7 @@ }, "MemoryChunkSizeMiB": { "description": "Size of the memory chunk measured in mebibytes (MiB).", - "longDescription": "The value of this property shall be the size of the memory chunk in MiB.", + "longDescription": "This property shall contain the size of the memory chunk in MiB.", "readonly": true, "type": [ "integer", @@ -222,13 +218,14 @@ }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource.", + "versionAdded": "v1_2_0" } }, "required": [ @@ -241,10 +238,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", @@ -262,5 +259,6 @@ } }, "owningEntity": "DMTF", - "title": "#MemoryChunks.v1_2_2.MemoryChunks" + "release": "2017.3", + "title": "#MemoryChunks.v1_2_4.MemoryChunks" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/MemoryDomain/MemoryDomain.json b/static/redfish/v1/JsonSchemas/MemoryDomain/MemoryDomain.json index 1babb2ff72..5c3f7f8b7f 100644 --- a/static/redfish/v1/JsonSchemas/MemoryDomain/MemoryDomain.json +++ b/static/redfish/v1/JsonSchemas/MemoryDomain/MemoryDomain.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/MemoryDomain.v1_2_3.json", "$ref": "#/definitions/MemoryDomain", "$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,18 +25,19 @@ "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_2_0" } }, "type": "object" }, "MemoryDomain": { "additionalProperties": false, - "description": "This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.", - "longDescription": "This resource shall be used to represent Memory Domains in a Redfish implementation.", + "description": "The MemoryDomain schema describes a memory domain and its configuration. Memory domains indicate to the client which memory, or DIMMs, can be grouped together in memory chunks to represent addressable memory.", + "longDescription": "This Resource shall represent memory domains in 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", @@ -50,25 +52,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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_2_0" }, "AllowsBlockProvisioning": { - "description": "Indicates if this Memory Domain supports the provisioning of blocks of memory.", - "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Blocks of memory.", + "description": "An indication of whether this memory domain supports the provisioning of blocks of memory.", + "longDescription": "This property shall indicate whether this memory domain supports the creation of blocks of memory.", "readonly": true, "type": [ "boolean", @@ -76,8 +79,8 @@ ] }, "AllowsMemoryChunkCreation": { - "description": "Indicates if this Memory Domain supports the creation of Memory Chunks.", - "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Memory Chunks.", + "description": "An indication of whether this memory domain supports the creation of memory chunks.", + "longDescription": "This property shall indicate whether this memory domain supports the creation of memory chunks.", "readonly": true, "type": [ "boolean", @@ -85,22 +88,24 @@ ] }, "AllowsMirroring": { - "description": "Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled.", - "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Memory Chunks with mirroring enabled.", + "description": "An indication of whether this memory domain supports the creation of memory chunks with mirroring enabled.", + "longDescription": "This property shall indicate whether this memory domain supports the creation of memory chunks with mirroring enabled.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_1_0" }, "AllowsSparing": { - "description": "Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled.", - "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Memory Chunks with sparing enabled.", + "description": "An indication of whether this memory domain supports the creation of memory chunks with sparing enabled.", + "longDescription": "This property shall indicate whether this memory domain supports the creation of memory chunks with sparing enabled.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_1_0" }, "Description": { "anyOf": [ @@ -118,31 +123,17 @@ "readonly": true }, "InterleavableMemorySets": { - "description": "This is the interleave sets for the memory chunk.", + "description": "The interleave sets for the memory chunk.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/MemorySet" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/MemorySet" }, - "longDescription": "These properties shall represent the interleave sets for the memory chunk.", + "longDescription": "This property shall represent the interleave sets for the memory chunk.", "type": "array" }, "MemoryChunks": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryChunksCollection.json#/definitions/MemoryChunksCollection" - }, - { - "type": "null" - } - ], - "description": "A reference to the collection of Memory Chunks associated with this Memory Domain.", - "longDescription": "The value of this property shall be a link to a collection of type MemoryChunkCollection.", + "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryChunksCollection.json#/definitions/MemoryChunksCollection", + "description": "The link to the collection of memory chunks associated with this memory domain.", + "longDescription": "This property shall contain a link to a Resource Collection of type MemoryChunkCollection.", "readonly": true }, "Name": { @@ -151,8 +142,8 @@ }, "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." } }, "required": [ @@ -165,10 +156,10 @@ }, "MemorySet": { "additionalProperties": false, - "description": "This is the interleave sets for a memory chunk.", + "description": "The interleave sets for a memory chunk.", "longDescription": "This type shall represent the interleave sets for a memory chunk.", "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", @@ -183,26 +174,26 @@ }, "properties": { "MemorySet": { - "description": "This is the collection of memory for a particular interleave set.", + "description": "The set of memory for a particular interleave set.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Memory.json#/definitions/Memory" }, - "longDescription": "The values in this collection shall be links to objects of type Memory.", + "longDescription": "The values in this array shall be links to Resources of the Memory type.", "readonly": true, "type": "array" }, "MemorySet@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -220,5 +211,6 @@ } }, "owningEntity": "DMTF", - "title": "#MemoryDomain.v1_2_1.MemoryDomain" + "release": "2017.1", + "title": "#MemoryDomain.v1_2_3.MemoryDomain" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json b/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json index 7b10854904..b0fcfbda34 100644 --- a/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json +++ b/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.v1_2_0.json", "$ref": "#/definitions/MemoryMetrics", "$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", @@ -27,18 +28,18 @@ }, "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." } }, "type": "object" }, "AlarmTrips": { "additionalProperties": false, - "description": "Alarm trip information about the memory. These alarms are reset when the system resets. Note that if they are re-discovered they can be reasserted.", - "longDescription": "This type shall contain properties describing the types of alarms that have been raised by the memory. These alarams shall be reset when the system resets. Note that if they are re-discovered they can be reasserted.", + "description": "The alarm trip information about the memory. These alarms are reset when the system resets. Note that if they are re-discovered they can be reasserted.", + "longDescription": "This type shall contain properties that describe the types of alarms that have been raised by the memory. These alarms shall be reset when the system resets. Note that if they are re-discovered they can be reasserted.", "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", @@ -53,8 +54,8 @@ }, "properties": { "AddressParityError": { - "description": "Address parity error detected status.", - "longDescription": "The value of this property shall be true if an Address Parity Error was detected which could not be corrected by retry.", + "description": "An indication of whether an address parity error was detected that a retry could not correct.", + "longDescription": "This property shall indicate whether an address parity error was detected that a retry could not correct.", "readonly": true, "type": [ "boolean", @@ -62,8 +63,8 @@ ] }, "CorrectableECCError": { - "description": "Correctable data error threshold crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if the correctable error threshold crossing alarm trip was detected.", + "description": "An indication of whether the correctable error threshold crossing alarm trip was detected.", + "longDescription": "This property shall indicate whether the correctable error threshold crossing alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -71,8 +72,8 @@ ] }, "SpareBlock": { - "description": "Spare block capacity crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if the spare block capacity crossing alarm trip was detected.", + "description": "An indication of whether the spare block capacity crossing alarm trip was detected.", + "longDescription": "This property shall indicate whether the spare block capacity crossing alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -80,8 +81,8 @@ ] }, "Temperature": { - "description": "Temperature threshold crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if a temperature threshold alarm trip was detected.", + "description": "An indication of whether a temperature threshold alarm trip was detected.", + "longDescription": "This property shall indicates whether a temperature threshold alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -89,8 +90,8 @@ ] }, "UncorrectableECCError": { - "description": "Uncorrectable data error threshold crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if the uncorrectable error threshold alarm trip was detected.", + "description": "An indication of whether the uncorrectable error threshold alarm trip was detected.", + "longDescription": "This property shall indicate whether the uncorrectable error threshold alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -102,11 +103,11 @@ }, "ClearCurrentPeriod": { "additionalProperties": false, - "description": "This sets the CurrentPeriod object values to zero.", - "longDescription": "This action shall set the CurrentPeriod object property values to zero.", + "description": "This action sets the CurrentPeriod property's values to 0.", + "longDescription": "This action shall set the CurrentPeriod property's values to 0.", "parameters": {}, "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", @@ -122,7 +123,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -134,10 +135,10 @@ }, "CurrentPeriod": { "additionalProperties": false, - "description": "This object contains the Memory metrics since last reset or ClearCurrentPeriod action.", - "longDescription": "This type shall describe the metrics of the memory since last time the ClearCurrentPeriod Action was performed or the system reset.", + "description": "The memory metrics since the last system reset or ClearCurrentPeriod action.", + "longDescription": "This type shall describe the memory metrics since last system reset or ClearCurrentPeriod action.", "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", @@ -152,8 +153,8 @@ }, "properties": { "BlocksRead": { - "description": "Number of blocks read since reset.", - "longDescription": "The value of this property shall be number of blocks read since reset.", + "description": "The number of blocks read since reset.", + "longDescription": "This property shall contain the number of blocks read since reset. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.", "readonly": true, "type": [ "integer", @@ -161,8 +162,8 @@ ] }, "BlocksWritten": { - "description": "Number of blocks written since reset.", - "longDescription": "The value of this property shall be mumber of blocks written since reset.", + "description": "The number of blocks written since reset.", + "longDescription": "This property shall contain the number of blocks written since reset. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.", "readonly": true, "type": [ "integer", @@ -174,10 +175,10 @@ }, "HealthData": { "additionalProperties": false, - "description": "This type describes the health information of the memory.", - "longDescription": "This type shall contain properties which describe the HealthData metrics for the current resource.", + "description": "The health information of the memory.", + "longDescription": "This type shall contain properties that describe the HealthData metrics 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", @@ -194,11 +195,11 @@ "AlarmTrips": { "$ref": "#/definitions/AlarmTrips", "description": "Alarm trip information about the memory.", - "longDescription": "This object shall contain properties describe the types of alarms that have been raised by the memory." + "longDescription": "This object shall contain properties describe the types of alarms that have been raised by the memory. When this Resource is subordinate to the MemorySummary object, this property shall indicate whether an alarm of a given type have been raised by any area of memory." }, "DataLossDetected": { - "description": "Data loss detection status.", - "longDescription": "The value of this property shall be data loss detection status, with true indicating data loss detected.", + "description": "An indication of whether data loss was detected.", + "longDescription": "This property shall indicate whether data loss was detected. When this Resource is subordinate to the MemorySummary object, this property shall indicate whether any data loss was detected in any area of memory.", "readonly": true, "type": [ "boolean", @@ -206,8 +207,8 @@ ] }, "LastShutdownSuccess": { - "description": "Status of last shutdown.", - "longDescription": "The value of this property shall be the status ofthe last shutdown, with true indicating success.", + "description": "An indication of whether the last shutdown succeeded.", + "longDescription": "This property shall indicate whether the last shutdown succeeded.", "readonly": true, "type": [ "boolean", @@ -215,8 +216,8 @@ ] }, "PerformanceDegraded": { - "description": "Performance degraded mode status.", - "longDescription": "The value of this property shall be performance degraded mode status, with true indicating perfomance degraded.", + "description": "An indication of whether performance has degraded.", + "longDescription": "This property shall indicate whether performance has degraded. When this Resource is subordinate to the MemorySummary object, this property shall indicate whether degraded performance mode status is detected in any area of memory.", "readonly": true, "type": [ "boolean", @@ -231,11 +232,12 @@ "number", "null" ], - "units": "%" + "units": "%", + "versionAdded": "v1_1_0" }, "RemainingSpareBlockPercentage": { - "description": "Remaining spare blocks in percentage.", - "longDescription": "The value of this property shall be the remaining spare blocks in percentage.", + "description": "The remaining spare blocks, as a percentage.", + "longDescription": "This property shall contain the remaining spare blocks as a percentage. When this Resource is subordinate to the MemorySummary object, this property shall be the RemainingSpareBlockPercentage over all memory.", "readonly": true, "type": [ "number", @@ -248,10 +250,10 @@ }, "LifeTime": { "additionalProperties": false, - "description": "This object contains the Memory metrics for the lifetime of the Memory.", - "longDescription": "This type shall describe the metrics of the memory since manufacturing.", + "description": "The memory metrics for the lifetime of the memory.", + "longDescription": "This type shall describe the memory metrics since manufacturing.", "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", @@ -266,8 +268,8 @@ }, "properties": { "BlocksRead": { - "description": "Number of blocks read for the lifetime of the Memory.", - "longDescription": "The value of this property shall be number of blocks read for the lifetime of the Memory.", + "description": "The number of blocks read for the lifetime of the memory.", + "longDescription": "This property shall contain the number of blocks read for the lifetime of the Memory. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.", "readonly": true, "type": [ "integer", @@ -275,8 +277,8 @@ ] }, "BlocksWritten": { - "description": "Number of blocks written for the lifetime of the Memory.", - "longDescription": "The value of this property shall be number of blocks written for the lifetime of the Memory.", + "description": "The number of blocks written for the lifetime of the memory.", + "longDescription": "This property shall contain the number of blocks written for the lifetime of the Memory. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.", "readonly": true, "type": [ "integer", @@ -288,10 +290,10 @@ }, "MemoryMetrics": { "additionalProperties": false, - "description": "MemoryMetrics contains usage and health statistics for a single Memory module or device instance.", - "longDescription": "This resource shall be used to represent the Memory Metrics for a single Memory device in a Redfish implementation.", + "description": "The usage and health statistics for a memory device or system memory summary.", + "longDescription": "The MemoryMetrics Schema shall contain the memory metrics for a memory device or system memory summary in 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", @@ -306,25 +308,37 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." + }, + "BandwidthPercent": { + "description": "The memory bandwidth utilization as a percentage.", + "longDescription": "This property shall contain memory bandwidth utilization as a percentage. When this Resource is subordinate to the MemorySummary object, this property shall be the memory bandwidth utilization over all memory as a percentage.", + "minimum": 0, + "readonly": true, + "type": [ + "number", + "null" + ], + "units": "%", + "versionAdded": "v1_2_0" }, "BlockSizeBytes": { - "description": "Block size in bytes.", - "longDescription": "The value of this property shall be the block size in bytes of all stucture elements.", + "description": "The block size, in bytes.", + "longDescription": "This property shall contain the block size, in bytes, of all stucture elements. When this Resource is subordinate to the MemorySummary object, this property is not applicable.", "readonly": true, "type": [ "integer", @@ -334,8 +348,8 @@ }, "CurrentPeriod": { "$ref": "#/definitions/CurrentPeriod", - "description": "This object contains the Memory metrics since last reset or ClearCurrentPeriod action.", - "longDescription": "This object shall contain properties which describe the CurrentPeriod metrics for the current resource." + "description": "The memory metrics since the last reset or ClearCurrentPeriod action.", + "longDescription": "This property shall contain properties that describe the memory metrics for the current period." }, "Description": { "anyOf": [ @@ -350,8 +364,8 @@ }, "HealthData": { "$ref": "#/definitions/HealthData", - "description": "This object describes the health information of the memory.", - "longDescription": "This object shall contain properties which describe the HealthData metrics for the current resource." + "description": "The health information of the memory.", + "longDescription": "This property shall contain properties that describe the health data memory metrics for the memory. When this Resource is subordinate to the MemorySummary object, this property is not applicable." }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -359,8 +373,8 @@ }, "LifeTime": { "$ref": "#/definitions/LifeTime", - "description": "This object contains the Memory metrics for the lifetime of the Memory.", - "longDescription": "This object shall contain properties which describe the LifeTime metrics for the current resource." + "description": "The memory metrics for the lifetime of the memory.", + "longDescription": "This property shall contain properties that describe the memory metrics for the lifetime of the memory." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -368,8 +382,8 @@ }, "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." } }, "required": [ @@ -382,10 +396,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", @@ -403,5 +417,6 @@ } }, "owningEntity": "DMTF", - "title": "#MemoryMetrics.v1_1_4.MemoryMetrics" + "release": "2019.2", + "title": "#MemoryMetrics.v1_2_0.MemoryMetrics" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Message/Message.json b/static/redfish/v1/JsonSchemas/Message/Message.json index b26884fa4d..5c392caeb7 100644 --- a/static/redfish/v1/JsonSchemas/Message/Message.json +++ b/static/redfish/v1/JsonSchemas/Message/Message.json @@ -1,13 +1,14 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Message.v1_0_8.json", "$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": { "Message": { "additionalProperties": false, - "description": "This type describes a Message returned by the Redfish service.", - "longDescription": "This type shall define a Message as described in the Redfish specification.", + "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_.]+$": { + "^([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", @@ -22,8 +23,8 @@ }, "properties": { "Message": { - "description": "This is the human readable message, if provided.", - "longDescription": "This property shall contain an optional human readable message.", + "description": "The human-readable message, if provided.", + "longDescription": "This property shall contain an optional human-readable message.", "readonly": true, "type": [ "string", @@ -31,27 +32,27 @@ ] }, "MessageArgs": { - "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.", + "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 referenced by the MessageId and shall only be included if the MessageId is present.", + "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": "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.", + "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" }, "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." }, "RelatedProperties": { - "description": "This is an array of properties described by the message.", + "description": "A set of properties described by the message.", "items": { "type": "string" }, @@ -61,7 +62,7 @@ }, "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", @@ -69,8 +70,8 @@ ] }, "Severity": { - "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.", + "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.", "readonly": true, "type": [ "string", @@ -85,5 +86,6 @@ } }, "owningEntity": "DMTF", - "title": "#Message.v1_0_6" + "release": "1.0", + "title": "#Message.v1_0_8" }
\ No newline at end of file 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 diff --git a/static/redfish/v1/JsonSchemas/MessageRegistryFile/MessageRegistryFile.json b/static/redfish/v1/JsonSchemas/MessageRegistryFile/MessageRegistryFile.json index 6f8a9fa8b9..25cfaec38a 100644 --- a/static/redfish/v1/JsonSchemas/MessageRegistryFile/MessageRegistryFile.json +++ b/static/redfish/v1/JsonSchemas/MessageRegistryFile/MessageRegistryFile.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/MessageRegistryFile.v1_1_3.json", "$ref": "#/definitions/MessageRegistryFile", "$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,18 +25,19 @@ "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" }, "Location": { "additionalProperties": false, - "description": "Location information for a schema file.", - "longDescription": "This type shall define Location information for a schema file.", + "description": "The location information for a Message Registry file.", + "longDescription": "This type shall contain the location information for a Message Registry file.", "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,35 +52,35 @@ }, "properties": { "ArchiveFile": { - "description": "If the schema is hosted on the service in an archive file, this is the name of the file within the archive.", - "longDescription": "The value of this property shall be the file name of the individual schema file within the archive file specified by the ArchiveUri property. The file name shall conform to the syntax specified in the Redfish specification.", + "description": "If the service hosts the Message Registry in an archive file, the name of the file within the archive.", + "longDescription": "This property shall contain the file name of the individual Message Registry file within the archive file specified by the ArchiveUri property. The file name shall conform to the Redfish Specification-specified syntax.", "readonly": true, "type": "string" }, "ArchiveUri": { - "description": "If the schema is hosted on the service in an archive file, this is the link to the archive file.", - "format": "uri", - "longDescription": "The value of this property shall be a URI co-located with the Redfish service that specifies the location of the schema file. This property shall only be used for archive files (zip or other formats). The value of ArchiveFile shall have the file name of the individual schema file within the archive file.", + "description": "If the Message Registry is hosted on the service in an archive file, the link to the archive file.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI that is colocated with the Redfish Service that specifies the location of the Message Registry file, which can be retrieved using the Redfish protocol and authentication methods. This property shall be used for only ZIP or other archive files. The ArchiveFile property shall contain the file name of the individual Message Registry file within the archive file.", "readonly": true, "type": "string" }, "Language": { - "description": "The language code for the file the schema is in.", - "longDescription": "The value of this property shall be a string consisting of an RFC5646 language code or the string 'default'.", + "description": "The language code for the Message Registry file.", + "longDescription": "This property shall contain an RFC5646-conformant language code or `default`.", "readonly": true, "type": "string" }, "PublicationUri": { - "description": "Link to publicly available (canonical) URI for schema.", - "format": "uri", - "longDescription": "The value of this property shall be a URI not co-located with the Redfish service that specifies the canonical location of the schema file. This property shall only be used for individual schema files.", + "description": "The link to publicly available (canonical) URI for the Message Registry.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI not colocated with the Redfish Service that specifies the canonical location of the Message Registry file. This property shall be used for only individual Message Registry files.", "readonly": true, "type": "string" }, "Uri": { - "description": "Link to locally available URI for schema.", - "format": "uri", - "longDescription": "The value of this property shall be a URI co-located with the Redfish service that specifies the location of the schema file. This property shall only be used for individual schema files. The file name portion of the URI shall conform to the syntax specified in the Redfish specification.", + "description": "The link to locally available URI for the Message Registry.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI colocated with the Redfish Service that specifies the location of the Message Registry file, which can be retrieved using the Redfish protocol and authentication methods. This property shall be used for only individual Message Registry files. The file name portion of the URI shall conform to Redfish Specification-specified syntax.", "readonly": true, "type": "string" } @@ -87,10 +89,10 @@ }, "MessageRegistryFile": { "additionalProperties": false, - "description": "This is the schema definition for the Schema File locator resource.", - "longDescription": "This resource shall be used to represent the Schema File locator resource for a Redfish implementation.", + "description": "The MessageRegistryFile schema describes the Message Registry file locator Resource.", + "longDescription": "This Resource shall represent the Message Registry file locator 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", @@ -105,21 +107,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": "The actions property shall contain the available actions for this Resource.", + "versionAdded": "v1_1_0" }, "Description": { "anyOf": [ @@ -137,20 +140,20 @@ "readonly": true }, "Languages": { - "description": "Language codes for the schemas available.", + "description": "The RFC5646-conformant language codes for the available Message Registries.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be a string consisting of an RFC 5646 language code.", + "longDescription": "This property contains a set of RFC5646-conformant language codes.", "readonly": true, "type": "array" }, "Location": { - "description": "Location information for this registry file.", + "description": "The location information for this Message Registry file.", "items": { "$ref": "#/definitions/Location" }, - "longDescription": "This property shall contain the location information for this registry file.", + "longDescription": "This property shall contain the location information for this Message Registry file.", "type": "array" }, "Name": { @@ -159,12 +162,12 @@ }, "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." }, "Registry": { - "description": "The Registry Name, Major, and Minor version. This Registry can reference any type of Registry, such as a Message Registry, Privilege Registry, or Attribute Registry.", - "longDescription": "The value of this property shall be the value of the Registry Name, Major, and Minor version. This Registry may reference any type of Registry, such as a Message Registry, Privilege Registry, or Attribute Registry.", + "description": "The registry name and its major and minor versions. This registry can be any type of registry, such as a Message Registry, Privilege Registry, or Attribute Registry.", + "longDescription": "This property shall contain the Message Registry name and it major and minor versions, as defined by the Redfish Specification. This registry can be any type of registry, such as Message Registry, Privilege Registry, or Attribute Registry.", "readonly": true, "type": "string" } @@ -182,10 +185,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", @@ -203,5 +206,6 @@ } }, "owningEntity": "DMTF", - "title": "#MessageRegistryFile.v1_1_1.MessageRegistryFile" + "release": "2017.1", + "title": "#MessageRegistryFile.v1_1_3.MessageRegistryFile" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/MetricDefinition/MetricDefinition.json b/static/redfish/v1/JsonSchemas/MetricDefinition/MetricDefinition.json index 8bfd3b983f..1a979a8d32 100644 --- a/static/redfish/v1/JsonSchemas/MetricDefinition/MetricDefinition.json +++ b/static/redfish/v1/JsonSchemas/MetricDefinition/MetricDefinition.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.v1_0_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.v1_0_3.json", "$ref": "#/definitions/MetricDefinition", "$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,14 +25,14 @@ "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." } }, "type": "object" }, "Calculable": { - "description": "The types of calculations which can be applied to the metric reading. This property provides information to the client on the suitability of calculatiion using the metric reading.", + "description": "The types of calculations that can be applied to the metric reading. Provides information to the client on the suitability of calculation using the metric reading.", "enum": [ "NonCalculatable", "Summable", @@ -43,7 +43,7 @@ "NonSummable": "The sum of the metric reading across multiple instances is not meaningful.", "Summable": "The sum of the metric reading across multiple instances is meaningful." }, - "longDescription": "The value shall indicate the types of calculations which can applied to the metric reading.", + "longDescription": "The type shall describe the types of calculations that can be applied to the metric reading.", "type": "string" }, "CalculationAlgorithmEnum": { @@ -53,23 +53,23 @@ "Minimum" ], "enumDescriptions": { - "Average": "The metric is calculated as the average of a metric reading over a sliding time interval.", - "Maximum": "The metric is calculated as the maximum value of a metric reading over during a time interval.", - "Minimum": "The metric is calculated as the minimum value of a metric reading over a sliding time interval." + "Average": "The metric is calculated as the average metric reading over a sliding time interval.", + "Maximum": "The metric is calculated as the maximum metric reading over during a time interval.", + "Minimum": "The metric is calculated as the minimum metric reading over a sliding time interval." }, "enumLongDescriptions": { - "Average": "The metric shall be calculated as the average of a metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property.", - "Maximum": "The metric shall be calculated as the maximum of a metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property.", - "Minimum": "The metric shall be calculated as the minimum of a metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property." + "Average": "The metric shall be calculated as the average metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value.", + "Maximum": "The metric shall be calculated as the maximum metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value.", + "Minimum": "The metric shall be calculated as the minimum metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value." }, "type": "string" }, "CalculationParamsType": { "additionalProperties": false, - "description": "Specifies the usage of the parameter in the calculation.", - "longDescription": "The value of the list element shall be the usage of the parameter in the calculation. This property is present when the MetricType property has the value 'Synthesized'.", + "description": "The usage of the parameter in the calculation.", + "longDescription": "The list element shall contain the usage of the parameter in the calculation. This property is present when the MetricType property is `Synthesized`.", "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", @@ -84,8 +84,8 @@ }, "properties": { "ResultMetric": { - "description": "The metric property used to store the results of the calculation.", - "longDescription": "This property shall contain a reference to a metric property wsed to place the result of the calcuation.", + "description": "The link to a metric property that stores the result of the calculation.", + "longDescription": "This property shall contain a link to a metric property that stores the result of the calcuation.", "readonly": true, "type": [ "string", @@ -94,7 +94,7 @@ }, "SourceMetric": { "description": "The metric property used as the input into the calculation.", - "longDescription": "This property shall contain a reference to a metric property used in a calcuation.", + "longDescription": "This property shall contain a link to a metric property used in a calcuation.", "readonly": true, "type": [ "string", @@ -115,12 +115,12 @@ "Calculated": "The metric is implemented by applying a calculation on another metric property. The calculation is specified in the CalculationAlgorithm property.", "DigitalMeter": "The metric is implemented as digital meter.", "PhysicalSensor": "The metric is implemented as a physical sensor.", - "Synthesized": "The metric is implemented by applying a calculation on one or more metric properties. (The calculation is not specified. For expressing generalized formula, see MathSON)." + "Synthesized": "The metric is implemented by applying a calculation on one or more metric properties. The calculation is not provided." }, "type": "string" }, "MetricDataType": { - "description": "The data type of the related metric values. The property provides information to the client on the nature of the metric reading.", + "description": "The data type of the related metric values. Provides information to the client on the nature of the metric reading.", "enum": [ "Boolean", "DateTime", @@ -130,22 +130,22 @@ "Enumeration" ], "enumDescriptions": { - "Boolean": "The data type follows the JSON Boolean definition.", - "DateTime": "The data type follows the JSON String definition with the Date-Time format applied.", - "Decimal": "The data type follows the JSON Decimal definition.", - "Enumeration": "The data type follows the JSON String definition with a set of enumerations defined.", - "Integer": "The data type follows the JSON Integer definition.", - "String": "The data type follows the JSON String definition." + "Boolean": "The JSON boolean definition.", + "DateTime": "The JSON string definition with the 'date-time' format.", + "Decimal": "The JSON decimal definition.", + "Enumeration": "The JSON string definition with a set of defined enumerations.", + "Integer": "The JSON integer definition.", + "String": "The JSON string definition." }, - "longDescription": "The value shall be the data type of the related metric values as defined by JSON data types.", + "longDescription": "This type shall describe the data type of the related metric values as defined by JSON data types.", "type": "string" }, "MetricDefinition": { "additionalProperties": false, - "description": "The metadata information about a metric.", - "longDescription": "Shall define the metadata information about a metric.", + "description": "The MetricDefinition schema describes the metadata information for a metric.", + "longDescription": "This Resource shall contain the metadata information for a metric.", "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", @@ -160,20 +160,20 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "Accuracy": { - "description": "Estimated percent error of measured vs. actual values.", - "longDescription": "The value of the property shall be the percent error +/- of the measured vs. actual values. The property is not meaningful, when the MetricType property has the value 'Discrete'.", + "description": "The estimated percent error of measured versus actual values.", + "longDescription": "This property shall contain the percent error +/- of the measured versus actual values. The property is not meaningful when the MetricType property is `Discrete`.", "readonly": true, "type": [ "number", @@ -182,8 +182,8 @@ }, "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." }, "Calculable": { "anyOf": [ @@ -194,8 +194,8 @@ "type": "null" } ], - "description": "Indicates whether the metric can be used in a calculation.", - "longDescription": "The value shall specify whether the metric can be used in a calculation.", + "description": "An indication of whether the metric can be used in a calculation.", + "longDescription": "This property shall specify whether the metric can be used in a calculation.", "readonly": false }, "CalculationAlgorithm": { @@ -207,12 +207,12 @@ "type": "null" } ], - "description": "The calculation which is performed on a source metric to obtain the metric being defined.", - "longDescription": "The value of this property shall specify the calculation performed to obtain the metric.", + "description": "The calculation that is performed on a source metric to obtain the metric being defined.", + "longDescription": "This property shall contain the calculation performed to obtain the metric.", "readonly": true }, "CalculationParameters": { - "description": "Specifies the metric properties which are part of the synthesis calculation. This property is present when the MetricType property has the value 'Synthesized'.", + "description": "The metric properties that are part of the synthesis calculation. This property is present when the MetricType property is `Synthesized`.", "items": { "anyOf": [ { @@ -223,12 +223,12 @@ } ] }, - "longDescription": "Shall list the metric properties which are part of the synthesis calculation. When MetricType=Synthesis, this property may be present.", + "longDescription": "This property shall list the metric properties that are part of the synthesis calculation. When MetricType=Synthesis, this property may be present.", "type": "array" }, "CalculationTimeInterval": { "description": "The time interval over which the metric calculation is performed.", - "longDescription": "The value shall specify the time interval over the metric calculation is performed. The format of the value shall conform to the Duration format.", + "longDescription": "This property shall specify the time interval over the metric calculation is performed. The format of the value shall conform to the Duration format.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -237,8 +237,8 @@ ] }, "Calibration": { - "description": "Specifies the calibration offset added to the metric reading.", - "longDescription": "The value shall be the calibration offset added to the metric reading. The value shall have the units specified in the property Units. The property is not meaningful, when the MetricType property has the value 'Discrete'.", + "description": "The calibration offset added to the metric reading.", + "longDescription": "This property shall contain the calibration offset added to the metric reading. The value shall have the units specified in the Units property. The property is not meaningful when the MetricType property is `Discrete`.", "readonly": true, "type": [ "number", @@ -282,12 +282,12 @@ } ], "description": "The implementation of the metric.", - "longDescription": "The value shall specify the implementation of the metric.", + "longDescription": "This property shall specify the implementation of the metric.", "readonly": true }, "IsLinear": { - "description": "Indicates whether the metric values are linear (vs non-linear).", - "longDescription": "The value shall specify that the corresponding metric values shall be linear or non-linear. Linear metrics may be compared using a greater than relation. An example of linear metrics include performance metrics. Examples of non-linear metrics include error codes.", + "description": "An indication of whether the metric values are linear versus non-linear.", + "longDescription": "This property shall indicate whether the metric values are linear versus non-linear. Linear metrics may use a greater than relation to compared them. An example of linear metrics include performance metrics. Examples of non-linear metrics include error codes.", "readonly": false, "type": [ "boolean", @@ -313,19 +313,19 @@ } ], "description": "The data type of the metric.", - "longDescription": "The value shall specify the data-type of the metric.", + "longDescription": "This property shall specify the data-type of the metric.", "readonly": false }, "MetricProperties": { - "description": "A list of URIs with wildcards and property identifiers for which this metric definition is defined. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.", - "format": "uri", + "description": "The list of URIs with wildcards and property identifiers that this metric definition defines. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.", + "format": "uri-reference", "items": { "type": [ "string", "null" ] }, - "longDescription": "This array property shall contain a list of URIs with wildcards and property identifiers for which this metric definition is defined. Each wildcard in the URI shall be delimited by a set of curly braces. Each wildcard shall be substituted as specified by the corresponding entry in the Wildcard array property. Once an URI with wildcards has had its wildcards fully substituted, it shall reference a resource property for which the metric definition applies. The property identifiers portion of the URI shall follow JSON fragment notation rules defined by RFC6901.", + "longDescription": "This array property shall list the URIs with wildcards and property identifiers that this metric defines. A set of curly braces shall delimit each wildcard in the URI. The corresponding entry in the Wildcard property shall replace each wildcard. After a URI with wildcards replaces its wildcards, it shall identify a Resource property to which the metric definition applies. The property identifiers portion of the URI shall follow RFC6901-defined JSON fragment notation rules.", "readonly": false, "type": "array" }, @@ -339,12 +339,12 @@ } ], "description": "The type of metric.", - "longDescription": "The value shall specify the type of metric.", + "longDescription": "This property shall specify the type of metric.", "readonly": false }, "MinReadingRange": { "description": "Minimum value for metric reading.", - "longDescription": "The value shall be the lowest possible value for the metric reading. The value shall have the units specified in the property Units. The property is not meaningful, when the MetricType property has the value 'Discrete'.", + "longDescription": "This property shall contain the lowest possible value for the metric reading. The value shall have the units specified in the property Units. The property is not meaningful, when the MetricType property has the value 'Discrete'.", "readonly": true, "type": [ "number", @@ -357,8 +357,8 @@ }, "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." }, "PhysicalContext": { "anyOf": [ @@ -369,13 +369,13 @@ "type": "null" } ], - "description": "Specifies the physical context of the metric.", - "longDescription": "The value of this property shall specify the physical context of the metric.", + "description": "The physical context of the metric.", + "longDescription": "This property shall contain the physical context of the metric.", "readonly": true }, "Precision": { "description": "Number of significant digits in the metric reading.", - "longDescription": "The value of the property shall specify the number of significant digits in the metric reading. The property is not meaningful, when the MetricType property has the value 'Discrete'.", + "longDescription": "This property shall specify the number of significant digits in the metric reading. The property is not meaningful, when the MetricType property has the value 'Discrete'.", "readonly": true, "type": [ "integer", @@ -384,7 +384,7 @@ }, "SensingInterval": { "description": "The time interval between when a metric is updated.", - "longDescription": "The value shall specify the time interval between when a metric is updated. The format of the value shall conform to the Duration format.", + "longDescription": "This property shall specify the time interval between when a metric is updated. The format of the value shall conform to the Duration format.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -393,8 +393,8 @@ ] }, "TimestampAccuracy": { - "description": "Accuracy of the timestamp.", - "longDescription": "The value shall specify the expected + or - variability of the timestamp. The format of the value shall conform to the Duration format.", + "description": "The accuracy of the timestamp.", + "longDescription": "This property shall specify the expected + or - variability of the timestamp. The format of the value shall conform to the Duration format.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": true, "type": [ @@ -404,7 +404,7 @@ }, "Units": { "description": "The units of measure for this metric.", - "longDescription": "The value shall specify the units of the metric. shall be consistent with the case sensitive Unified Code for Units of Measure as defined at http://unitsofmeasure.org/ucum.html. Note: the units of measure is not covered in UCUM.", + "longDescription": "This property shall specify the units of the metric. This property shall be consistent with the case-sensitive ('C/s' column) Unified Code for Units of Measure. Note: Not all units of measured are covered by UCUM.", "readonly": false, "type": [ "string", @@ -412,18 +412,11 @@ ] }, "Wildcards": { - "description": "A list of wildcards and their substitution values to be applied to the entries in the MetricProperties array property.", + "description": "The wildcards and their substitution values for the entries in the MetricProperties array property.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Wildcard" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Wildcard" }, - "longDescription": "The property shall contain a list of wildcards and their replacement strings, which are applied to the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property.", + "longDescription": "The property shall contain a list of wildcards and their replacement strings, which are applied to the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property.", "type": "array" } }, @@ -436,7 +429,7 @@ "type": "object" }, "MetricType": { - "description": "Specifies the type of metric provided. The property provides information to the client on how the metric can be handled.", + "description": "The type of metric. Provides information to the client on how the metric can be handled.", "enum": [ "Numeric", "Discrete", @@ -445,8 +438,8 @@ "Countdown" ], "enumDescriptions": { - "Countdown": "The metric is a countdown metric. The metric reading is a non-negative integer which decreases monotonically. When a counter reaches its minimum, the value resets to preset value and resumes counting down.", - "Counter": "The metric is a counter metric. The metric reading is a non-negative integer which increases monotonically. When a counter reaches its maximum, the value resets to 0 and resumes counting.", + "Countdown": "The metric is a countdown metric. The metric reading is a non-negative integer that decreases monotonically. When a counter reaches its minimum, the value resets to preset value and resumes counting down.", + "Counter": "The metric is a counter metric. The metric reading is a non-negative integer that increases monotonically. When a counter reaches its maximum, the value resets to 0 and resumes counting.", "Discrete": "The metric is a discrete metric. The metric value is discrete. The possible values are listed in the DiscreteValues property.", "Gauge": "The metric is a gauge metric. The metric value is a real number. When the metric value reaches the gauges extrema, it stays at that value, until the reading falls within the extrema.", "Numeric": "The metric is a numeric metric. The metric value is any real number." @@ -454,15 +447,15 @@ "enumLongDescriptions": { "Discrete": "The metric values shall indicate discrete states." }, - "longDescription": "The value of this property shall specify the type of metric.", + "longDescription": "This property shall contain the type of metric.", "type": "string" }, "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", @@ -480,10 +473,10 @@ }, "Wildcard": { "additionalProperties": false, - "description": "Contains a wildcard and its substitution values.", + "description": "The wildcard and its substitution values.", "longDescription": "This property shall contain a wildcard and its substitution values.", "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", @@ -524,5 +517,5 @@ }, "owningEntity": "DMTF", "release": "2018.2", - "title": "#MetricDefinition.v1_0_1.MetricDefinition" + "title": "#MetricDefinition.v1_0_3.MetricDefinition" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/MetricReport/MetricReport.json b/static/redfish/v1/JsonSchemas/MetricReport/MetricReport.json index ef528950bd..fd1443a07e 100644 --- a/static/redfish/v1/JsonSchemas/MetricReport/MetricReport.json +++ b/static/redfish/v1/JsonSchemas/MetricReport/MetricReport.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/MetricReport.v1_1_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/MetricReport.v1_2_0.json", "$ref": "#/definitions/MetricReport", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "MetricReport": { "additionalProperties": false, - "description": "The metric definitions used to create a metric report.", - "longDescription": "The value shall be reference to the definition for this metric report.", + "description": "The metric definitions that create a metric report.", + "longDescription": "The definition for this metric report.", "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,21 +51,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -84,21 +84,14 @@ }, "MetricReportDefinition": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinition.json#/definitions/MetricReportDefinition", - "description": "The metric definitions used to create a metric report.", - "longDescription": "The value shall be reference to the definition for this metric report.", + "description": "The definitions in the metric report.", + "longDescription": "The definitions in this metric report.", "readonly": true }, "MetricValues": { "description": "An array of metric values for the metered items of this Metric.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/MetricValue" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/MetricValue" }, "longDescription": "The values shall be metric values for this MetricReport.", "type": "array" @@ -109,19 +102,19 @@ }, "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." }, "ReportSequence": { "description": "The current sequence identifier for this metric report.", - "longDescription": "The value shall be the current sequence identifier for this metric report.", + "longDescription": "This property shall contain the current sequence identifier for this metric report.", "readonly": true, "type": "string" }, "Timestamp": { "description": "The time associated with the metric report in its entirety. The time of the metric report may be relevant when the time of individual metrics are minimally different.", "format": "date-time", - "longDescription": "The value shall be the time when the metric report was generated.", + "longDescription": "This property shall contain the time when the metric report was generated.", "readonly": true, "type": [ "string", @@ -144,7 +137,7 @@ "description": "A metric Value.", "longDescription": "A metric value in the context of a Metric.", "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", @@ -160,13 +153,13 @@ "properties": { "MetricDefinition": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition", - "description": "A link to the Metric Definition.", - "longDescription": "The value shall be reference to the Metric Definition resource that describes what this Metric Report is capturing.", + "description": "The link to the metric.", + "longDescription": "The Metric Definition Resource that describes what this Metric Report captures.", "readonly": true }, "MetricId": { "description": "The metric definitions identifier for this metric.", - "longDescription": "The value shall be the same as the Id property of the source metric within the associated MetricDefinition.", + "longDescription": "This property shall contain the same as the Id property of the source metric within the associated MetricDefinition.", "readonly": true, "type": [ "string", @@ -175,8 +168,8 @@ }, "MetricProperty": { "description": "The URI for the property from which this metric is derived.", - "format": "uri", - "longDescription": "The value shall be URI to the a property following the JSON fragment notation, as defined by RFC6901, to identify an individual property in a Redfish resource.", + "format": "uri-reference", + "longDescription": "The value shall be URI to the property following the JSON fragment notation, as defined by RFC6901, to identify an individual property in a Redfish Resource.", "readonly": true, "type": [ "string", @@ -184,16 +177,22 @@ ] }, "MetricValue": { - "description": "The value identifies this resource.", - "longDescription": "The value of the metric represented as a string.", + "description": "The metric value, as a string.", + "longDescription": "This property shall contain the metric value, as a string.", "readonly": true, "type": [ "string", "null" ] }, + "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.", + "versionAdded": "v1_2_0" + }, "Timestamp": { - "description": "The time when the value of the metric is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.", + "description": "The time when the metric is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.", "format": "date-time", "longDescription": "The value shall time when the metric value was obtained. Note that this may be different from the time when this instance is created.", "readonly": true, @@ -207,10 +206,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", @@ -228,6 +227,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#MetricReport.v1_1_0.MetricReport" + "release": "2019.2", + "title": "#MetricReport.v1_2_0.MetricReport" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/MetricReportDefinition/MetricReportDefinition.json b/static/redfish/v1/JsonSchemas/MetricReportDefinition/MetricReportDefinition.json index bced5dcc74..17b7314129 100644 --- a/static/redfish/v1/JsonSchemas/MetricReportDefinition/MetricReportDefinition.json +++ b/static/redfish/v1/JsonSchemas/MetricReportDefinition/MetricReportDefinition.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinition.v1_1_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinition.v1_3_0.json", "$ref": "#/definitions/MetricReportDefinition", "$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,14 +25,14 @@ "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." } }, "type": "object" }, "CalculationAlgorithmEnum": { - "description": "Specifies the function to apply to the list of metric properties.", + "description": "The function to apply to the list of metric properties.", "enum": [ "Average", "Maximum", @@ -40,18 +40,18 @@ "Summation" ], "enumDescriptions": { - "Average": "The metric is calculated as the average of a metric reading over a sliding time interval.", - "Maximum": "The metric is calculated as the maximum value of a metric reading over during a time interval.", - "Minimum": "The metric is calculated as the minimum value of a metric reading over a sliding time interval.", - "Summation": "The metric is calculated as the sum of the values over a sliding time interval." + "Average": "The metric is calculated as the average metric reading over a duration.", + "Maximum": "The metric is calculated as the maximum metric reading over a duration.", + "Minimum": "The metric is calculated as the minimum metric reading over a duration.", + "Summation": "The metric is calculated as the sum of the values over a duration." }, "enumLongDescriptions": { - "Average": "The metric shall be calculated as the average of a metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property.", - "Maximum": "The metric shall be calculated as the maximum of a metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property.", - "Minimum": "The metric shall be calculated as the minimum of a metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property.", - "Summation": "The metric shall be calculated as the sum of the the specified metric reading over a sliding time interval. The time interval shall be the value of the CalculationTimeInterval property." + "Average": "The metric shall be calculated as the average metric reading over a duration. The duration shall be the CollectionDuration property value.", + "Maximum": "The metric shall be calculated as the maximum metric reading over a duration. The duration shall be the CollectionDuration property value.", + "Minimum": "The metric shall be calculated as the minimum of a metric reading over a duration. The duration shall be the CollectionDuration property value.", + "Summation": "The metric shall be calculated as the sum of the specified metric reading over a duration. The duration shall be the CollectionDuration property value." }, - "longDescription": "The value shall specify the function to apply to the list of metric properties.", + "longDescription": "This type shall specify the function to apply to the list of metric properties.", "type": "string" }, "CollectionTimeScope": { @@ -62,19 +62,59 @@ "StartupInterval" ], "enumDescriptions": { - "Interval": "The corresponding metric values apply to a time interval. On the corresponding metric value instances, the value of Timestamp shall specify the end of the time interval and Duration shall specify its duration.", - "Point": "The corresponding metric values apply to a point in time. On the corresponding metric value instances, the value of Timestamp shall specify the point in time.", - "StartupInterval": "The corresponding metric values apply to a time interval that began at the startup of the measured resource (i.e. the Resources associated by Links.MetricDefinitionForResources). On the corresponding metric value instances, the value of Timestamp shall specify the end of the time interval. The value of Duration shall specifies the duration between startup of the resource and TimeStamp." + "Interval": "The corresponding metric values apply to a time interval. On the corresponding metric value instances, the Timestamp property value shall specify the end of the time interval and Duration shall specify its duration.", + "Point": "The corresponding metric values apply to a point in time. On the corresponding metric value instances, the Timestamp property value shall specify the point in time.", + "StartupInterval": "The corresponding metric values apply to a time interval that began at the startup of the measured Resource, such as the Resources that Links.MetricDefinitionForResources associates. On the corresponding metric value instances, the Timestamp value shall specify the end of the time interval. The Duration value shall specify the duration between the startup of Resource and Timestamp." }, - "longDescription": "The value of the property shall specify the time scope of the corresponding metric values.", + "longDescription": "This type shall specify the time scope of the corresponding metric values.", "type": "string" }, + "Links": { + "additionalProperties": false, + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource.", + "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": { + "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." + }, + "Triggers": { + "description": "The triggers that cause this metric report definition to generate a new metric report upon a trigger occurrence when the TriggerActions property contains `RedfishMetricReport`.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Triggers.json#/definitions/Triggers" + }, + "longDescription": "This property shall contain a set of triggers that cause this metric report to generate a new metric report upon a trigger occurrence when the TriggerActions property contains `RedfishMetricReport`.", + "readonly": true, + "type": "array", + "versionAdded": "v1_2_0" + }, + "Triggers@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" + } + }, + "type": "object" + }, "Metric": { "additionalProperties": false, - "description": "Specifies a metric to include in the metric report. The metrics are derived by applying a calculation on each of the listed metric properties.", - "longDescription": "The properties shall specify a metric to include in the metric report. The metrics shall be derived by applying the algorithm specified in CollectionnFunction property to each of the metric properties listed in the MetricProperties property.", + "description": "Specifies a metric to include in the metric report. The metrics are derived by applying a calculation on each of the listed metric properties.", + "longDescription": "The properties shall specify a metric to include in the metric report. The metrics shall be derived by applying the algorithm specified in CollectionnFunction property to each of the metric properties listed in the MetricProperties property.", "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", @@ -89,8 +129,8 @@ }, "properties": { "CollectionDuration": { - "description": "Specifies the duration over which the function is computed.", - "longDescription": "The value shall specify the duration over which the function is computed. The value shall conform to the Duration format.", + "description": "The duration over which the function is computed.", + "longDescription": "This property shall specify the duration over which the function is computed. The value shall conform to the Duration format.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -120,13 +160,13 @@ "type": "null" } ], - "description": "Specifies the scope of time scope over which the function is applied.", - "longDescription": "The value shall specify the scope of time over which the function is applied.", + "description": "The scope of time scope over which the function is applied.", + "longDescription": "This property shall specify the scope of time over which the function is applied.", "readonly": false }, "MetricId": { - "description": "Specifies the label for the metric definition which is derived by applying the CollectionFunction to the metric property.", - "longDescription": "This property shall specify a label for use in the metric report for the metric which is derived metrics by applying the CollectionFunction to the metric property. This property shall match the Id property of the corresponding metric definition resource.", + "description": "The label for the metric definition that is derived by applying the collectionFunction to the metric property. It matches the Id property of the corresponding metric definition.", + "longDescription": "This property shall specify the label for the metric definition that is derived by applying the collectionFunction to the metric property. This property shall match the Id property of the corresponding metric definition.", "readonly": true, "type": [ "string", @@ -134,15 +174,15 @@ ] }, "MetricProperties": { - "description": "A collection of URI for the properties on which this metric is collected.", - "format": "uri", + "description": "The set of URIs for the properties on which this metric is collected.", + "format": "uri-reference", "items": { "type": [ "string", "null" ] }, - "longDescription": "Each value may contain one or more Wildcard names enclosed in curly braces. Wildcard value entries shall be substituted for each Wildcard name found. If two or more wild names are found, the same Wildcard index is used for each in one substitution pass. After substituting the WildCard values entries, each value shall be a URI for a property in a resource that matches a property declaration in the corresponding MetricDefinition.", + "longDescription": "Each value may contain one or more Wildcard names enclosed in curly braces. Wildcard value entries shall be substituted for each Wildcard name found. If two or more wild names are found, the same Wildcard index is used for each in one substitution pass. After substituting the WildCard values entries, each value shall contain a URI for a property in a Resource that matches a property declaration in the corresponding MetricDefinition.", "readonly": false, "type": "array" } @@ -151,10 +191,10 @@ }, "MetricReportDefinition": { "additionalProperties": false, - "description": "A set of metrics that are collected into a metric report.", - "longDescription": "This resource specifies a set of metrics that shall be collected into a metric report.", + "description": "The MetricReportDefinition schema describes set of metrics that are collected into a metric report.", + "longDescription": "This Resource specifies a set of metrics that shall be collected into a metric report.", "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", @@ -169,25 +209,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AppendLimit": { - "description": "Indicates the maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior is dictated by the ReportUpdates property.", - "longDescription": "This property shall be a number that indicates the maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior shall be dictated by the ReportUpdates property. This property shall be required if ReportUpdates is either AppendWrapsWhenFull or AppendStopsWhenFull.", + "description": "The maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior is dictated by the ReportUpdates property.", + "longDescription": "This property shall contain a number that indicates the maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior shall be dictated by the ReportUpdates property. This property shall be required if ReportUpdates is either AppendWrapsWhenFull or AppendStopsWhenFull.", "minimum": 0, "readonly": true, "type": "integer" @@ -207,25 +247,41 @@ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, + "Links": { + "$ref": "#/definitions/Links", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", + "versionAdded": "v1_2_0" + }, "MetricProperties": { - "description": "A list of URIs with wildcards and property identifiers to include in the metric report. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.", - "format": "uri", + "description": "The list of URIs with wildcards and property identifiers to include in the metric report. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards property.", + "format": "uri-reference", "items": { "type": [ "string", "null" ] }, - "longDescription": "This array property shall contain a list of URIs with wildcards and property identifiers to include in the metric report. Each wildcard in the URI shall be delimited by a set of curly braces. Each wildcard shall be substituted as specified by the corresponding entry in the Wildcard array property. Once an URI with wildcards has had its wildcards fully substituted, it shall reference a resource property to include in the metric report. The property identifiers portion of the URI shall follow JSON fragment notation rules defined by RFC6901.", + "longDescription": "This property shall contain a list of URIs with wildcards and property identifiers to include in the metric report. A set of curly braces shall delimit each wildcard in the URI. The corresponding entry in the Wildcard property shall replace each wildcard. After a URI with wildcards replaces each wildcard, it shall describe a Resource property to include in the metric report. The property identifiers portion of the URI shall follow RFC6901-specified JSON fragment notation rules.", "readonly": false, "type": "array" }, "MetricReport": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReport.json#/definitions/MetricReport", - "description": "Specifies the location where the resultant metric report is placed.", - "longDescription": "This property shall be a reference to the resource where the resultant metric report is placed.", + "description": "The location where the resultant metric report is placed.", + "longDescription": "This property shall contain a link to the Resource where the resultant metric report is placed.", "readonly": true }, + "MetricReportDefinitionEnabled": { + "description": "An indication of whether the generation of new metric reports is enabled.", + "longDescription": "This property shall indicate whether the generation of new metric reports is enabled.", + "readonly": false, + "type": [ + "boolean", + "null" + ], + "versionAdded": "v1_2_0" + }, "MetricReportDefinitionType": { "anyOf": [ { @@ -236,22 +292,26 @@ } ], "description": "Specifies when the metric report is generated.", - "longDescription": "The value shall specify when the metric report is generated. If the value of the property is 'Periodic', then the Schedule property shall be present.", + "longDescription": "This property shall specify when the metric report is generated. If the value is `Periodic`, the Schedule property shall be present.", "readonly": false }, + "MetricReportHeartbeatInterval": { + "description": "The interval at which to send the complete metric report because the Redfish client wants refreshed metric data even when the data has not changed. This property value is always greater than the recurrence interval of a metric report, and it only applies when the SuppressRepeatedMetricValue property is `true`.", + "longDescription": "The property value shall contain a Redfish duration that describes the time interval between generations of the unsuppressed metric report. It shall always be a value greater than the RecurrenceInterval of a MetricReport and should only apply when the SuppressRepeatedMetricValue property is `true`.", + "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", + "readonly": false, + "type": [ + "string", + "null" + ], + "versionAdded": "v1_2_0" + }, "Metrics": { - "description": "Specifies a list of metrics to include in the metric report. The metrics may include metric properties or calculations applied to a metric property.", + "description": "The list of metrics to include in the metric report. The metrics may include metric properties or calculations applied to a metric property.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Metric" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Metric" }, - "longDescription": "The property shall specify a list of metrics to include in the metric report. The metrics may include metric properties or calculations applied to a metric property.", + "longDescription": "The property shall contain a list of metrics to include in the metric report. The metrics may include metric properties or calculations that are applied to a metric property.", "type": "array" }, "Name": { @@ -260,47 +320,61 @@ }, "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." }, "ReportActions": { - "description": "Specifies the actions to perform when a metric report is generated.", + "description": "The set of actions to perform when a metric report is generated.", "items": { "$ref": "#/definitions/ReportActionsEnum" }, - "longDescription": "The value of this property shall specify the actions to perform when the metric report is generated. The options are transmit an event or create a metric report resource.", + "longDescription": "This property shall contain the set of actions to perform when the metric report is generated.", "readonly": true, "type": "array" }, + "ReportTimespan": { + "description": "Specifies the timespan duration of the metric report.", + "longDescription": "This property shall specify the timespan duration that this metric report covers.", + "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", + "readonly": false, + "type": [ + "string", + "null" + ], + "versionAdded": "v1_3_0" + }, "ReportUpdates": { "$ref": "#/definitions/ReportUpdatesEnum", - "description": "When logging metric reports, specifies how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. Namely, whether to overwrite, append, or create new report resource.", - "longDescription": "The value of this property shall specify how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition.", + "description": "When logging metric reports, specifies how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. Namely, whether to overwrite, append, or create a report Resource.", + "longDescription": "This property shall contain how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition.", "readonly": true }, "Schedule": { "$ref": "http://redfish.dmtf.org/schemas/v1/Schedule.json#/definitions/Schedule", - "description": "Specifies the schedule for generating the metric report.", - "longDescription": "If the schedule present, the metric report is generated at an interval specified by Schedule.RecurrenceInterval property. If Schedule.MaxOccurrences is specified, the metric report will no longer be generated after the specified number of occurances." + "description": "The schedule for generating the metric report.", + "longDescription": "If the schedule present, the metric report is generated at an interval specified by Schedule.RecurrenceInterval property. If Schedule.MaxOccurrences is specified, the metric report is no longer generated after the specified number of occurrences." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." + }, + "SuppressRepeatedMetricValue": { + "description": "An indication of whether any metrics are suppressed from the generated metric report. If `true`, any metric that equals the same metric in the previously generated metric report is suppressed from the current report. Also, duplicate metrics are suppressed. If `false`, no metrics are suppressed from the current report. The current report may contain no metrics if all metrics equal the values of the same metrics in the previously generated metric report.", + "longDescription": "This property shall indicate whether any metrics are suppressed from the generated metric report. If `true`, any metric that equals the same metric in the previously generated metric report is suppressed from the current report. Also, duplicate metrics are suppressed. If `false`, no metrics are suppressed from the current report. The current report may contain no metrics if all metrics equal the values of the same metrics in the previously generated metric report.", + "readonly": false, + "type": [ + "boolean", + "null" + ], + "versionAdded": "v1_2_0" }, "Wildcards": { - "description": "A list of wildcards and their substitution values to be applied to the entries in the MetricProperties array property.", + "description": "The set of wildcards and their substitution values for the entries in the MetricProperties property.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Wildcard" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Wildcard" }, - "longDescription": "The property shall contain a list of wildcards and their replacement strings, which are applied to the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property.", + "longDescription": "The property shall contain a set of wildcards and their replacement strings, which are applied to the MetricProperties property. Each wildcard expressed in the MetricProperties property shall have a corresponding entry in this property.", "type": "array" } }, @@ -324,15 +398,15 @@ "OnRequest": "The metric report is generated when a HTTP GET is performed on the specified metric report.", "Periodic": "The metric report is generated at a periodic time interval, specified in the Schedule property." }, - "longDescription": "The value shall specify when the metric report is generated.", + "longDescription": "This type shall specify when the metric report is generated.", "type": "string" }, "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", @@ -355,18 +429,18 @@ "RedfishEvent" ], "enumDescriptions": { - "LogToMetricReportsCollection": "When a metric report is scheduled to be generated, record the occurrence to the Metric Report Collection.", - "RedfishEvent": "When a metric report is scheduled to be generated, send a Redfish Event message of type MetricReport." + "LogToMetricReportsCollection": "When a metric report is scheduled to be generated, record the occurrence to the metric report collection.", + "RedfishEvent": "When a metric report is scheduled to be generated, send a Redfish Event message of the MetricReport type." }, "enumLongDescriptions": { - "LogToMetricReportsCollection": "When a metric report is scheduled to be generated, the service shall record the occurrence to the Metric Report Collection found under the Telemetry Service. The service shall update the Metric Report Collection based on the setting of the ReportUpdates property.", - "RedfishEvent": "When a metric report is scheduled to be generated, the service shall produce a Redfish Event of type MetricReport to matching subscribers indicated in the EventSubscription collection found on the EventService." + "LogToMetricReportsCollection": "When a metric report is scheduled to be generated, the service shall record the occurrence to the metric report collection found under the Telemetry Service. The Service shall update the metric report collection based on the setting of the ReportUpdates property.", + "RedfishEvent": "When a metric report is scheduled to be generated, the service shall send an event of the MetricReport type to subscribers that the EventSubscription collection in the Event Service describes." }, - "longDescription": "The value shall specify the actions to perform when a metric report is generated.", + "longDescription": "This type shall specify the actions to perform when a metric report is generated.", "type": "string" }, "ReportUpdatesEnum": { - "description": "How to what to do with subsequent metric reports when a metric report already exists.", + "description": "Handling of subsequent metric reports when a metric report exists.", "enum": [ "Overwrite", "AppendWrapsWhenFull", @@ -374,20 +448,20 @@ "NewReport" ], "enumDescriptions": { - "AppendStopsWhenFull": "When a metric report is updated, append to the specified metric report resource. This also indicates that the metric report stops adding entries when the metric report has reached its maximum capacity.", - "AppendWrapsWhenFull": "When a metric report is updated, append to the specified metric report resource. This also indicates that the metric report overwrites its entries with new entries when the metric report has reached its maximum capacity.", - "NewReport": "When a metric report is updated, create a new metric report resource, whose resource name is the metric report resource name concatenated with the timestamp.", - "Overwrite": "When a metric report is updated, overwrite the specified metric report resource." + "AppendStopsWhenFull": "When a metric report is updated, append to the specified metric report Resource. This also indicates that the metric report stops adding entries when the metric report has reached its maximum capacity.", + "AppendWrapsWhenFull": "When a metric report is updated, new information is appended to the report. The metric report overwrites its entries with new entries when the metric report has reached its maximum capacity.", + "NewReport": "When a metric report is updated, create a new metric report Resource, whose Resource name is the metric report Resource name concatenated with the timestamp.", + "Overwrite": "When a metric report is updated, overwrite the metric report." }, - "longDescription": "The value shall specify what to do with subsequent metric reports when a metric report already exists.", + "longDescription": "This type shall indicate how the Service handles subsequent metric reports when a metric report exists.", "type": "string" }, "Wildcard": { "additionalProperties": false, - "description": "Contains a wildcard and its substitution values.", - "longDescription": "This property shall contain a wildcard and its substitution values.", + "description": "The wildcard and its substitution values.", + "longDescription": "This type shall contain a wildcard and its substitution values.", "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", @@ -402,6 +476,7 @@ }, "properties": { "Keys": { + "deprecated": "This property has been deprecated in favor of using the property 'Values'.", "description": "An array of values to substitute for the wildcard.", "items": { "type": [ @@ -411,7 +486,8 @@ }, "longDescription": "This property shall contain the list of values to substitute for the wildcard.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_1_0" }, "Name": { "description": "The string used as a wildcard.", @@ -440,6 +516,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#MetricReportDefinition.v1_1_0.MetricReportDefinition" + "release": "2019.2", + "title": "#MetricReportDefinition.v1_3_0.MetricReportDefinition" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/NetworkAdapter/NetworkAdapter.json b/static/redfish/v1/JsonSchemas/NetworkAdapter/NetworkAdapter.json index efe704d112..b6109673a5 100644 --- a/static/redfish/v1/JsonSchemas/NetworkAdapter/NetworkAdapter.json +++ b/static/redfish/v1/JsonSchemas/NetworkAdapter/NetworkAdapter.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/NetworkAdapter.v1_3_0.json", "$ref": "#/definitions/NetworkAdapter", "$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", @@ -27,8 +28,8 @@ }, "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." } }, "type": "object" @@ -38,7 +39,7 @@ "description": "The capabilities of a controller.", "longDescription": "This type shall describe the capabilities of a controller.", "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", @@ -53,44 +54,24 @@ }, "properties": { "DataCenterBridging": { - "anyOf": [ - { - "$ref": "#/definitions/DataCenterBridging" - }, - { - "type": "null" - } - ], - "description": "Data Center Bridging (DCB) for this controller.", - "longDescription": "This object shall contain capability, status, and configuration values related to Data Center Bridging (DCB) for this controller." + "$ref": "#/definitions/DataCenterBridging", + "description": "Data center bridging (DCB) for this controller.", + "longDescription": "This property shall contain capability, status, and configuration values related to data center bridging (DCB) for this controller." }, "NPAR": { - "anyOf": [ - { - "$ref": "#/definitions/NicPartitioning" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/NicPartitioning", "description": "NIC Partitioning (NPAR) capabilities for this controller.", - "longDescription": "This object shall contain capability, status, and configuration values related to NIC partitioning for this controller." + "longDescription": "This property shall contain capability, status, and configuration values related to NIC partitioning for this controller.", + "versionAdded": "v1_2_0" }, "NPIV": { - "anyOf": [ - { - "$ref": "#/definitions/NPIV" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/NPIV", "description": "N_Port ID Virtualization (NPIV) capabilties for this controller.", - "longDescription": "This object shall contain N_Port ID Virtualization (NPIV) capabilties for this controller." + "longDescription": "This property shall contain N_Port ID Virtualization (NPIV) capabilties for this controller." }, "NetworkDeviceFunctionCount": { "description": "The maximum number of physical functions available on this controller.", - "longDescription": "The value of this property shall be the number of physical functions available on this controller.", + "longDescription": "This property shall contain the number of physical functions available on this controller.", "readonly": true, "type": [ "integer", @@ -99,7 +80,7 @@ }, "NetworkPortCount": { "description": "The number of physical ports on this controller.", - "longDescription": "The value of this property shall be the number of physical ports on this controller.", + "longDescription": "This property shall contain the number of physical ports on this controller.", "readonly": true, "type": [ "integer", @@ -107,26 +88,19 @@ ] }, "VirtualizationOffload": { - "anyOf": [ - { - "$ref": "#/definitions/VirtualizationOffload" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/VirtualizationOffload", "description": "Virtualization offload for this controller.", - "longDescription": "This object shall contain capability, status, and configuration values related to virtualization offload for this controller." + "longDescription": "This property shall contain capability, status, and configuration values related to virtualization offload for this controller." } }, "type": "object" }, "ControllerLinks": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -141,45 +115,45 @@ }, "properties": { "NetworkDeviceFunctions": { - "description": "An array of references to the NetworkDeviceFunctions associated with this Network Controller.", + "description": "An array of links to the NetworkDeviceFunctions associated with this Network Controller.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction" }, - "longDescription": "The value of this property shall be an array of references of type NetworkDeviceFunction that represent the Network Device Functions associated with this Network Controller.", + "longDescription": "This property shall contain an array of links of the NetworkDeviceFunction type that represent the network device functions associated with this Network Controller.", "readonly": true, "type": "array" }, "NetworkDeviceFunctions@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "NetworkPorts": { - "description": "An array of references to the NetworkPorts associated with this Network Controller.", + "description": "An array of links to the NetworkPorts associated with this Network Controller.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort" }, - "longDescription": "The value of this property shall be an array of references of type NetworkPort that represent the Network Ports associated with this Network Controller.", + "longDescription": "This property shall contain an array of links of the NetworkPort type that represent the Network Ports associated with this Network Controller.", "readonly": true, "type": "array" }, "NetworkPorts@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PCIeDevices": { - "description": "An array of references to the PCIeDevices associated with this Network Controller.", + "description": "An array of links to the PCIeDevices associated with this Network Controller.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" }, - "longDescription": "The value of this property shall be an array of references of type PCIeDevice that represent the PCI-e Devices associated with this Network Controller.", + "longDescription": "This property shall contain an array of links of the PCIeDevice type that represent the PCIe devices associated with this Network Controller.", "readonly": true, "type": "array" }, "PCIeDevices@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" @@ -189,7 +163,7 @@ "description": "A network controller ASIC that makes up part of a NetworkAdapter.", "longDescription": "This type shall describe a network controller ASIC that makes up part of a NetworkAdapter.", "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", @@ -204,57 +178,54 @@ }, "properties": { "ControllerCapabilities": { - "anyOf": [ - { - "$ref": "#/definitions/ControllerCapabilities" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/ControllerCapabilities", "description": "The capabilities of this controller.", - "longDescription": "The value of this property shall contain the capabilities of this controller." + "longDescription": "This property shall contain the capabilities of this controller." }, "FirmwarePackageVersion": { "description": "The version of the user-facing firmware package.", - "longDescription": "The value of this property shall be the version number of the user-facing firmware package.", + "longDescription": "This property shall contain the version number of the user-facing firmware package.", "readonly": true, "type": [ "string", "null" ] }, + "Identifiers": { + "description": "The Durable names for the network adapter.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" + }, + "longDescription": "This property shall contain a list of all known durable names for the associated network adapter.", + "type": "array", + "versionAdded": "v1_3_0" + }, "Links": { "$ref": "#/definitions/ControllerLinks", - "description": "Links.", + "description": "The links.", "longDescription": "Links for this controller." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the network adapter controller.", - "longDescription": "This property shall contain location information of the associated network adapter controller." + "description": "The location of the network adapter controller.", + "longDescription": "This property shall contain location information of the associated network adapter controller.", + "versionAdded": "v1_1_0" }, "PCIeInterface": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface" - }, - { - "type": "null" - } - ], + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface", "description": "The PCIe interface details for this controller.", - "longDescription": "This object shall contain details on the PCIe interface used to connect this PCIe-based controller to its host." + "longDescription": "This property shall contain details for the PCIe interface that connects this PCIe-based controller to its host.", + "versionAdded": "v1_2_0" } }, "type": "object" }, "DataCenterBridging": { "additionalProperties": false, - "description": "Data Center Bridging (DCB) for capabilities of a controller.", - "longDescription": "This type shall describe the capability, status, and configuration values related to Data Center Bridging (DCB) for a controller.", + "description": "Data center bridging (DCB) for capabilities of a controller.", + "longDescription": "This type shall describe the capability, status, and configuration values related to data center bridging (DCB) for a controller.", "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", @@ -269,8 +240,8 @@ }, "properties": { "Capable": { - "description": "Whether this controller is capable of Data Center Bridging (DCB).", - "longDescription": "The value of this property shall be a boolean indicating whether this controller is capable of Data Center Bridging (DCB).", + "description": "An indication of whether this controller is capable of data center bridging (DCB).", + "longDescription": "This property shall indicate whether this controller is capable of data center bridging (DCB).", "readonly": true, "type": [ "boolean", @@ -285,7 +256,7 @@ "description": "N_Port ID Virtualization (NPIV) capabilties for a controller.", "longDescription": "This type shall contain N_Port ID Virtualization (NPIV) capabilties for a controller.", "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", @@ -301,7 +272,7 @@ "properties": { "MaxDeviceLogins": { "description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.", - "longDescription": "The value of this property shall be the maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.", + "longDescription": "This property shall contain the maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.", "readonly": true, "type": [ "integer", @@ -310,7 +281,7 @@ }, "MaxPortLogins": { "description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.", - "longDescription": "The value of this property shall be the maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.", + "longDescription": "This property shall contain the maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.", "readonly": true, "type": [ "integer", @@ -325,7 +296,7 @@ "description": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.", "longDescription": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.", "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", @@ -340,41 +311,35 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this adapter.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", - "readonly": true + "description": "The link to the assembly Resource associated with this adapter.", + "longDescription": "This property shall contain a link to a Resource of type assembly.", + "readonly": true, + "versionAdded": "v1_1_0" }, "Controllers": { "description": "The set of network controllers ASICs that make up this NetworkAdapter.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Controllers" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Controllers" }, - "longDescription": "The value of this property shall contain the set of network controllers ASICs that make up this NetworkAdapter.", + "longDescription": "This property shall contain the set of network controllers ASICs that make up this NetworkAdapter.", "type": "array" }, "Description": { @@ -394,7 +359,7 @@ }, "Manufacturer": { "description": "The manufacturer or OEM of this network adapter.", - "longDescription": "The value of this property shall contain a value that represents the manufacturer of the network adapter.", + "longDescription": "This property shall contain a value that represents the manufacturer of the network adapter.", "readonly": true, "type": [ "string", @@ -403,7 +368,7 @@ }, "Model": { "description": "The model string for this network adapter.", - "longDescription": "The value of this property shall contain the information about how the manufacturer references this network adapter.", + "longDescription": "This property shall contain the information about how the manufacturer refers to this network adapter.", "readonly": true, "type": [ "string", @@ -416,24 +381,24 @@ }, "NetworkDeviceFunctions": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionCollection.json#/definitions/NetworkDeviceFunctionCollection", - "description": "A reference to the collection of NetworkDeviceFunctions associated with this NetworkAdapter.", - "longDescription": "The value of this property shall be a link to a collection of type NetworkDeviceFunctionCollection.", + "description": "The link to the collection of NetworkDeviceFunctions associated with this NetworkAdapter.", + "longDescription": "This property shall contain a link to a Resource Collection of type NetworkDeviceFunctionCollection.", "readonly": true }, "NetworkPorts": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPortCollection.json#/definitions/NetworkPortCollection", - "description": "A reference to the collection of NetworkPorts associated with this NetworkAdapter.", - "longDescription": "The value of this property shall be a link to a collection of type NetworkPortCollection.", + "description": "The link to the collection of NetworkPorts associated with this NetworkAdapter.", + "longDescription": "This property shall contain a link to a Resource Collection of type NetworkPortCollection.", "readonly": true }, "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." }, "PartNumber": { "description": "Part number for this network adapter.", - "longDescription": "The value of this property shall contain the part number for the network adapter as defined by the manufacturer.", + "longDescription": "This property shall contain the part number for the network adapter as defined by the manufacturer.", "readonly": true, "type": [ "string", @@ -442,7 +407,7 @@ }, "SKU": { "description": "The manufacturer SKU for this network adapter.", - "longDescription": "The value of this property shall contain the Stock Keeping Unit (SKU) for the network adapter.", + "longDescription": "This property shall contain the SKU for the network adapter.", "readonly": true, "type": [ "string", @@ -451,7 +416,7 @@ }, "SerialNumber": { "description": "The serial number for this network adapter.", - "longDescription": "The value of this property shall contain the serial number for the network adapter.", + "longDescription": "This property shall contain the serial number for the network adapter.", "readonly": true, "type": [ "string", @@ -460,8 +425,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -477,7 +442,7 @@ "description": "NIC Partitioning capability, status, and configuration for a controller.", "longDescription": "This type shall contain the capability, status, and configuration values for a controller.", "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", @@ -492,32 +457,34 @@ }, "properties": { "NparCapable": { - "description": "Indicates whether or not NIC function partitioning is supported by a controller.", - "longDescription": "This property shall indicate the ability of a controller to support NIC function partitioning.", + "description": "An indication of whether the controller supports NIC function partitioning.", + "longDescription": "This property shall indicate whether the controller supports NIC function partitioning.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_2_0" }, "NparEnabled": { - "description": "When true, NIC function partitioning is active on this controller.", - "longDescription": "This property shall indicate whether or not NIC function partitioning is active on this controller.", + "description": "An indication of whether NIC function partitioning is active on this controller.", + "longDescription": "This property shall indicate whether NIC function partitioning is active on this controller.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_2_0" } }, "type": "object" }, "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", @@ -536,10 +503,10 @@ "ResetSettingsToDefault": { "additionalProperties": false, "description": "This action is to clear the settings back to factory defaults.", - "longDescription": "This action shall perform a reset of all active and pending settings back to factory default settings upon reset of the network adapter.", + "longDescription": "This action shall reset of all active and pending settings back to factory default settings upon reset of the network adapter.", "parameters": {}, "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", @@ -555,7 +522,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -570,7 +537,7 @@ "description": "Single-Root Input/Output Virtualization (SR-IOV) capabilities.", "longDescription": "This type shall contain Single-Root Input/Output Virtualization (SR-IOV) capabilities.", "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", @@ -585,8 +552,8 @@ }, "properties": { "SRIOVVEPACapable": { - "description": "Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.", - "longDescription": "The value of this property shall be a boolean indicating whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.", + "description": "An indication of whether this controller supports single root input/output virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.", + "longDescription": "This property shall indicate whether this controller supports single root input/output virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.", "readonly": true, "type": [ "boolean", @@ -601,7 +568,7 @@ "description": "A virtual function of a controller.", "longDescription": "This type shall describe the capability, status, and configuration values related to a virtual function for a controller.", "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", @@ -616,8 +583,8 @@ }, "properties": { "DeviceMaxCount": { - "description": "The maximum number of Virtual Functions (VFs) supported by this controller.", - "longDescription": "The value of this property shall be the maximum number of Virtual Functions (VFs) supported by this controller.", + "description": "The maximum number of virtual functions supported by this controller.", + "longDescription": "This property shall contain the maximum number of virtual functions supported by this controller.", "readonly": true, "type": [ "integer", @@ -625,8 +592,8 @@ ] }, "MinAssignmentGroupSize": { - "description": "The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.", - "longDescription": "The value of this property shall be the minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.", + "description": "The minimum number of virtual functions that can be allocated or moved between physical functions for this controller.", + "longDescription": "This property shall contain the minimum number of virtual functions that can be allocated or moved between physical functions for this controller.", "readonly": true, "type": [ "integer", @@ -634,8 +601,8 @@ ] }, "NetworkPortMaxCount": { - "description": "The maximum number of Virtual Functions (VFs) supported per network port for this controller.", - "longDescription": "The value of this property shall be the maximum number of Virtual Functions (VFs) supported per network port for this controller.", + "description": "The maximum number of virtual functions supported per network port for this controller.", + "longDescription": "This property shall contain the maximum number of virtual functions supported per network port for this controller.", "readonly": true, "type": [ "integer", @@ -650,7 +617,7 @@ "description": "A Virtualization offload capability of a controller.", "longDescription": "This type shall describe the capability, status, and configuration values related to a virtualization offload for a controller.", "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", @@ -665,26 +632,12 @@ }, "properties": { "SRIOV": { - "anyOf": [ - { - "$ref": "#/definitions/SRIOV" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/SRIOV", "description": "Single-Root Input/Output Virtualization (SR-IOV) capabilities.", - "longDescription": "This object shall contain Single-Root Input/Output Virtualization (SR-IOV) capabilities." + "longDescription": "This property shall contain Single-Root Input/Output Virtualization (SR-IOV) capabilities." }, "VirtualFunction": { - "anyOf": [ - { - "$ref": "#/definitions/VirtualFunction" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/VirtualFunction", "description": "The virtual function of the controller.", "longDescription": "This property shall describe the capability, status, and configuration values related to the virtual function for this controller." } @@ -693,5 +646,6 @@ } }, "owningEntity": "DMTF", - "title": "#NetworkAdapter.v1_2_0.NetworkAdapter" + "release": "2019.2", + "title": "#NetworkAdapter.v1_3_0.NetworkAdapter" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/NetworkDeviceFunction/NetworkDeviceFunction.json b/static/redfish/v1/JsonSchemas/NetworkDeviceFunction/NetworkDeviceFunction.json index 4f5dffbb0d..95902c8415 100644 --- a/static/redfish/v1/JsonSchemas/NetworkDeviceFunction/NetworkDeviceFunction.json +++ b/static/redfish/v1/JsonSchemas/NetworkDeviceFunction/NetworkDeviceFunction.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.v1_3_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.v1_3_3.json", "$ref": "#/definitions/NetworkDeviceFunction", "$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" } }, @@ -55,10 +55,10 @@ ], "enumDescriptions": { "Disabled": "Do not indicate to UEFI/BIOS that this device is bootable.", - "FibreChannel": "Boot this device using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannel.", - "FibreChannelOverEthernet": "Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannelOverEthernet.", - "PXE": "Boot this device using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is set to Ethernet.", - "iSCSI": "Boot this device using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to iSCSI." + "FibreChannel": "Boot this device by using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is `FibreChannel`.", + "FibreChannelOverEthernet": "Boot this device by using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is `FibreChannelOverEthernet`.", + "PXE": "Boot this device by using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is `Ethernet`.", + "iSCSI": "Boot this device by using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is `iSCSI`." }, "type": "string" }, @@ -67,7 +67,7 @@ "description": "A Fibre Channel boot target configured for a network device function.", "longDescription": "This type shall describe a Fibre Channel boot target configured for a network device function.", "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", @@ -83,7 +83,7 @@ "properties": { "BootPriority": { "description": "The relative priority for this entry in the boot targets array.", - "longDescription": "The value of this property shall be the relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The BootPriority shall be unique for all entries of the BootTargets array.", + "longDescription": "This property shall contain the relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The BootPriority shall be unique for all entries of the BootTargets array.", "readonly": false, "type": [ "integer", @@ -91,8 +91,8 @@ ] }, "LUNID": { - "description": "The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.", - "longDescription": "The value of this property shall be the Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.", + "description": "The logical unit number (LUN) ID from which to boot on the device to which the corresponding WWPN refers.", + "longDescription": "This property shall contain the logical unit number (LUN) ID from which to boot on the device to which the corresponding WWPN refers.", "readonly": false, "type": [ "string", @@ -100,8 +100,8 @@ ] }, "WWPN": { - "description": "The World-Wide Port Name to boot from.", - "longDescription": "The value of this property shall be World-Wide Port Name (WWPN) to boot from.", + "description": "The World Wide Port Name (WWPN) from which to boot.", + "longDescription": "This property shall contain World Wide Port Name (WWPN) from which to boot.", "readonly": false, "type": [ "string", @@ -113,10 +113,10 @@ }, "Ethernet": { "additionalProperties": false, - "description": "This type describes Ethernet capabilities, status, and configuration of a network device function.", + "description": "This type describes Ethernet capabilities, status, and configuration for a network device function.", "longDescription": "This type shall describe the Ethernet capabilities, status, and configuration values for a network device function.", "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", @@ -131,8 +131,9 @@ }, "properties": { "MACAddress": { - "description": "This is the currently configured MAC address of the (logical port) network device function.", - "longDescription": "The value of this property shall be the effective current MAC Address of this network device function. If an assignable MAC address is not supported, this is a read only alias of the PermanentMACAddress.", + "description": "The currently configured MAC address.", + "longDescription": "This property shall contain the effective current MAC address of this network device function. If an assignable MAC address is not supported, this is a read-only alias of the PermanentMACAddress.", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "readonly": false, "type": [ "string", @@ -140,8 +141,8 @@ ] }, "MTUSize": { - "description": "The Maximum Transmission Unit (MTU) configured for this network device function.", - "longDescription": "The Maximum Transmission Unit (MTU) configured for this Network Device Function. This value serves as a default for the OS driver when booting. The value only takes-effect on boot.", + "description": "The maximum transmission unit (MTU) configured for this network device function.", + "longDescription": "The maximum transmission unit (MTU) configured for this network device function. This value serves as a default for the OS driver when booting. The value only takes effect on boot.", "readonly": false, "type": [ "integer", @@ -149,8 +150,9 @@ ] }, "PermanentMACAddress": { - "description": "This is the permanent MAC address assigned to this network device function (physical function).", - "longDescription": "The value of this property shall be the Permanent MAC Address of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.", + "description": "The permanent MAC address assigned to this function.", + "longDescription": "This property shall contain the permanent MAC Address of this function. Typically, this value is programmed during manufacturing. This address is not assignable.", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "readonly": true, "type": [ "string", @@ -158,22 +160,15 @@ ] }, "VLAN": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN" - }, - { - "type": "null" - } - ], - "description": "If this Network Interface supports more than one VLAN, this property is not present. VLANs collections appear in the Link section of this resource.", - "longDescription": "The value of this property shall be the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead.", + "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN", + "description": "If this network interface supports more than one VLAN, this property is not present. VLANs collections appear in the Link section of this Resource.", + "longDescription": "This property shall contain the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead.", "versionAdded": "v1_3_0" }, "VLANs": { "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterfaceCollection.json#/definitions/VLanNetworkInterfaceCollection", - "description": "This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs.", - "longDescription": "The value of this property shall reference a collection of VLAN resources. If this property is used, the VLANEnabled and VLANId property shall not be used.", + "description": "The link to a collection of VLANs. This property is used only if the interface supports more than one VLAN.", + "longDescription": "This property shall contain a link to a collection of VLANs. If this property is used, the VLANEnabled and VLANId property shall not be used.", "readonly": true, "versionAdded": "v1_3_0" } @@ -182,10 +177,10 @@ }, "FibreChannel": { "additionalProperties": false, - "description": "This type describes Fibre Channel capabilities, status, and configuration of a network device function.", - "longDescription": "This object shall describe the Fibre Channel capabilities, status, and configuration values for a network device function.", + "description": "This type describes Fibre Channel capabilities, status, and configuration for a network device function.", + "longDescription": "This type shall describe the Fibre Channel capabilities, status, and configuration values for a network device function.", "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", @@ -200,8 +195,8 @@ }, "properties": { "AllowFIPVLANDiscovery": { - "description": "Whether the FCoE Initialization Protocol (FIP) is used for populating the FCoE VLAN Id.", - "longDescription": "For FCoE connections, the value of this property shall be a boolean indicating whether the FIP VLAN Discovery Protocol is used to determine the FCoE VLAN ID selected by the network device function for the FCoE connection. If true, and the FIP VLAN Discovery succeeds, the FCoEActiveVLANId property shall reflect the FCoE VLAN ID to be used for all FCoE traffic. If false, or if the FIP VLAN Discovery protocol fails, the FCoELocalVLANId shall be used for all FCoE traffic and the FCoEActiveVLANId shall reflect the FCoELocalVLANId.", + "description": "An indication of whether the FCoE Initialization Protocol (FIP) populates the FCoE VLAN ID.", + "longDescription": "For FCoE connections, this boolean property shall indicate whether the FIP VLAN Discovery Protocol determines the FCoE VLAN ID selected by the network device function for the FCoE connection. If `true` and the FIP VLAN discovery succeeds, the FCoEActiveVLANId property shall reflect the FCoE VLAN ID to use for all FCoE traffic. If `false` or if the FIP VLAN Discovery protocol fails, the FCoELocalVLANId shall be used for all FCoE traffic and the FCoEActiveVLANId shall reflect the FCoELocalVLANId.", "readonly": false, "type": [ "boolean", @@ -220,12 +215,12 @@ } ] }, - "longDescription": "The value of this property shall be an array of Fibre Channel boot targets configured for this network device function.", + "longDescription": "This property shall contain an array of Fibre Channel boot targets configured for this network device function.", "type": "array" }, "FCoEActiveVLANId": { "description": "The active FCoE VLAN ID.", - "longDescription": "For FCoE connections, the value of this property shall be null or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be null. When the FCoE link is up this value shall be either the FCoELocalVLANId property or a VLAN discovered via the FIP protocol.", + "longDescription": "For FCoE connections, this property shall contain `null` or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be null. When the FCoE link is up this value shall be either the FCoELocalVLANId property or a VLAN discovered through the FIP protocol.", "maximum": 4094, "minimum": 0, "readonly": true, @@ -236,7 +231,7 @@ }, "FCoELocalVLANId": { "description": "The locally configured FCoE VLAN ID.", - "longDescription": "For FCoE connections, the value of this property shall be the VLAN ID configured locally by setting this property. This value shall be used for FCoE traffic to this network device function during boot unless AllowFIPVLANDiscovery is true and a valid FCoE VLAN ID is found via the FIP VLAN Discovery Protocol.", + "longDescription": "For FCoE connections, this property shall contain the VLAN ID configured locally by setting this property. This value shall be used for FCoE traffic to this network device function during boot unless AllowFIPVLANDiscovery is `true` and a valid FCoE VLAN ID is found through the FIP VLAN Discovery Protocol.", "maximum": 4094, "minimum": 0, "readonly": false, @@ -246,8 +241,8 @@ ] }, "FibreChannelId": { - "description": "The Fibre Channel Id assigned by the switch for this interface.", - "longDescription": "This property shall indicate the Fibre Channel Id assigned by the switch for this interface.", + "description": "The Fibre Channel ID that the switch assigns for this interface.", + "longDescription": "This property shall indicate the Fibre Channel ID that the switch assigns for this interface.", "readonly": true, "type": [ "string", @@ -256,8 +251,8 @@ "versionAdded": "v1_3_0" }, "PermanentWWNN": { - "description": "This is the permanent WWNN address assigned to this network device function (physical function).", - "longDescription": "The value of this property shall be the permanent World-Wide Node Name (WWNN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.", + "description": "The permanent World Wide Node Name (WWNN) address assigned to this function.", + "longDescription": "This property shall contain the permanent World Wide Node Name (WWNN) of this function. Typically, this value is programmed during manufacturing. This address is not assignable.", "readonly": true, "type": [ "string", @@ -265,8 +260,8 @@ ] }, "PermanentWWPN": { - "description": "This is the permanent WWPN address assigned to this network device function (physical function).", - "longDescription": "The value of this property shall be the permanent World-Wide Port Name (WWPN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.", + "description": "The permanent World Wide Port Name (WWPN) address assigned to this function.", + "longDescription": "This property shall contain the permanent World Wide Port Name (WWPN) of this function. Typically, this value is programmed during manufacturing. This address is not assignable.", "readonly": true, "type": [ "string", @@ -274,8 +269,8 @@ ] }, "WWNN": { - "description": "This is the currently configured WWNN address of the network device function (physical function).", - "longDescription": "The value of this property shall be the effective current World-Wide Node Name (WWNN) of this network device function (physical function). If an assignable WWNN is not supported, this is a read only alias of the PermanentWWNN.", + "description": "The currently configured World Wide Node Name (WWNN) address of this function.", + "longDescription": "This property shall contain the effective current World Wide Node Name (WWNN) of this function. If an assignable WWNN is not supported, this is a read-only alias of the permanent WWNN.", "readonly": false, "type": [ "string", @@ -291,13 +286,13 @@ "type": "null" } ], - "description": "The configuration source of the WWNs for this connection (WWPN and WWNN).", - "longDescription": "The value of this property shall be the configuration source of the World-Wide Names (WWNs) for this connection (WWPN and WWNN).", + "description": "The configuration source of the World Wide Names (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.", + "longDescription": "This property shall contain the configuration source of the World Wide Name (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.", "readonly": false }, "WWPN": { - "description": "This is the currently configured WWPN address of the network device function (physical function).", - "longDescription": "The value of this property shall be the effective current World-Wide Port Name (WWPN) of this network device function (physical function). If an assignable WWPN is not supported, this is a read only alias of the PermanentWWPN.", + "description": "The currently configured World Wide Port Name (WWPN) address of this function.", + "longDescription": "This property shall contain the effective current World Wide Port Name (WWPN) of this function. If an assignable WWPN is not supported, this is a read-only alias of the permanent WWPN.", "readonly": false, "type": [ "string", @@ -320,10 +315,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -338,28 +333,28 @@ }, "properties": { "Endpoints": { - "description": "An array of references to endpoints associated with this network device function.", + "description": "An array of links to endpoints associated with this network device function.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The type shall contain an array property who's members reference resources, of type Endpoint, which are associated with this network device function.", + "longDescription": "The type shall contain an array property. The members of this array are Resources of the Endpoint type, which are associated with this network device function.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "PCIeFunction": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction", - "description": "A reference to the PCIeFunction associated with this Network Device Function.", - "longDescription": "The value of this property shall be a references of type PCIeFunction that represents the PCI-e Function associated with this Network Device Function.", + "description": "The link to the PCIe function associated with this network device function.", + "longDescription": "This property shall contain a link of the PCIeFunction type that represents the PCIe function associated with this network device function.", "readonly": true }, "PhysicalPortAssignment": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort", - "description": "The physical port that this network device function is currently assigned to.", - "longDescription": "The value of this property shall be the physical port that this network device function is currently assigned to. This value shall be one of the AssignablePhysicalPorts array members.", + "description": "The physical port to which this network device function is currently assigned.", + "longDescription": "This property shall contain the physical port to which this network device function is currently assigned. This value shall be one of the AssignablePhysicalPorts array members.", "versionAdded": "v1_3_0" } }, @@ -367,10 +362,10 @@ }, "NetworkDeviceFunction": { "additionalProperties": false, - "description": "A Network Device Function represents a logical interface exposed by the network adapter.", - "longDescription": "A Network Device Function represents a logical interface exposed by the network adapter.", + "description": "The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.", + "longDescription": "A network device function represents a logical interface that a network adapter exposes.", "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", @@ -385,34 +380,34 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AssignablePhysicalPorts": { - "description": "The array of physical port references that this network device function may be assigned to.", + "description": "An array of physical ports to which this network device function may be assigned.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort" }, - "longDescription": "The value of this property shall be an array of physical port references that this network device function may be assigned to.", + "longDescription": "This property shall contain an array of physical ports to which this network device function may be assigned.", "readonly": true, "type": "array" }, "AssignablePhysicalPorts@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "BootMode": { "anyOf": [ @@ -424,7 +419,7 @@ } ], "description": "The boot mode configured for this network device function.", - "longDescription": "The value of this property shall be the boot mode configured for this network device function. If the value is not quot;Disabled\", this network device function shall be configured for boot using the specified technology.", + "longDescription": "This property shall contain the boot mode configured for this network device function. If the value is not `Disabled`, this network device function shall be configured for boot by using the specified technology.", "readonly": false }, "Description": { @@ -439,8 +434,8 @@ "readonly": true }, "DeviceEnabled": { - "description": "Whether the network device function is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether the network device function is enabled. Disabled network device functions shall not be enumerated or seen by the operating system.", + "description": "An indication of whether the network device function is enabled.", + "longDescription": "This property shall indicate whether the network device function is enabled. The operating system shall not enumerate or see disabled network device functions.", "readonly": false, "type": [ "boolean", @@ -448,28 +443,14 @@ ] }, "Ethernet": { - "anyOf": [ - { - "$ref": "#/definitions/Ethernet" - }, - { - "type": "null" - } - ], - "description": "Ethernet.", - "longDescription": "This object shall contain Ethernet capabilities, status, and configuration values for this network device function." + "$ref": "#/definitions/Ethernet", + "description": "The Ethernet capabilities, status, and configuration values for this network device function.", + "longDescription": "This property shall contain Ethernet capabilities, status, and configuration values for this network device function." }, "FibreChannel": { - "anyOf": [ - { - "$ref": "#/definitions/FibreChannel" - }, - { - "type": "null" - } - ], - "description": "Fibre Channel.", - "longDescription": "This object shall contain Fibre Channel capabilities, status, and configuration values for this network device function." + "$ref": "#/definitions/FibreChannel", + "description": "The Fibre Channel capabilities, status, and configuration values for this network device function.", + "longDescription": "This property shall contain Fibre Channel capabilities, status, and configuration values for this network device function." }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -477,12 +458,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Links.", - "longDescription": "Links for this NetworkDeviceFunction." + "description": "The links for this network device function.", + "longDescription": "This property shall contain the Links for this network device function." }, "MaxVirtualFunctions": { - "description": "The number of virtual functions (VFs) that are available for this Network Device Function.", - "longDescription": "The value of this property shall be the number of virtual functions (VFs) that are available for this Network Device Function.", + "description": "The number of virtual functions that are available for this network device function.", + "longDescription": "This property shall contain the number of virtual functions that are available for this network device function.", "readonly": true, "type": [ "integer", @@ -494,7 +475,7 @@ "readonly": true }, "NetDevFuncCapabilities": { - "description": "Capabilities of this network device function.", + "description": "An array of capabilities for this network device function.", "items": { "anyOf": [ { @@ -505,7 +486,7 @@ } ] }, - "longDescription": "This object shall contain an array of capabilities of this network device function.", + "longDescription": "This property shall contain an array of capabilities for this network device function.", "readonly": true, "type": "array" }, @@ -519,28 +500,30 @@ } ], "description": "The configured capability of this network device function.", - "longDescription": "The value of this property shall be the configured capability of this network device function.", + "longDescription": "This property shall contain the configured capability of this network device function.", "readonly": false }, "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." }, "PhysicalPortAssignment": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort", - "description": "The physical port that this network device function is currently assigned to.", - "longDescription": "The value of this property shall be the physical port that this network device function is currently assigned to. This value shall be one of the AssignablePhysicalPorts array members.", - "readonly": true + "deprecated": "This property has been deprecated and moved to the Links section to avoid loops on expand.", + "description": "The physical port to which this network device function is currently assigned.", + "longDescription": "This property shall contain the physical port to which this network device function is currently assigned. This value shall be one of the AssignablePhysicalPorts array members.", + "readonly": true, + "versionDeprecated": "v1_3_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "VirtualFunctionsEnabled": { - "description": "Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function.", - "longDescription": "The value of this property shall be a boolean indicating whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function.", + "description": "An indication of whether single root input/output virtualization (SR-IOV) virtual functions are enabled for this network device function.", + "longDescription": "This property shall indicate whether single root input/output virtualization (SR-IOV) virtual functions are enabled for this network device function.", "readonly": true, "type": [ "boolean", @@ -548,16 +531,9 @@ ] }, "iSCSIBoot": { - "anyOf": [ - { - "$ref": "#/definitions/iSCSIBoot" - }, - { - "type": "null" - } - ], - "description": "iSCSI Boot.", - "longDescription": "This object shall contain iSCSI boot capabilities, status, and configuration values for this network device function." + "$ref": "#/definitions/iSCSIBoot", + "description": "The iSCSI boot capabilities, status, and configuration values for this network device function.", + "longDescription": "This property shall contain iSCSI boot capabilities, status, and configuration values for this network device function." } }, "required": [ @@ -587,10 +563,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", @@ -619,10 +595,10 @@ }, "iSCSIBoot": { "additionalProperties": false, - "description": "This type describes iSCSI boot capabilities, status, and configuration of a network device function.", + "description": "The iSCSI boot capabilities, status, and configuration for a network device function.", "longDescription": "This type shall describe the iSCSI boot capabilities, status, and configuration values for a network device function.", "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", @@ -646,12 +622,12 @@ } ], "description": "The iSCSI boot authentication method for this network device function.", - "longDescription": "The value of this property shall be the iSCSI boot authentication method for this network device function.", + "longDescription": "This property shall contain the iSCSI boot authentication method for this network device function.", "readonly": false }, "CHAPSecret": { "description": "The shared secret for CHAP authentication.", - "longDescription": "The value of this property shall be the shared secret for CHAP authentication.", + "longDescription": "This property shall contain the shared secret for CHAP authentication.", "readonly": false, "type": [ "string", @@ -659,8 +635,8 @@ ] }, "CHAPUsername": { - "description": "The username for CHAP authentication.", - "longDescription": "The value of this property shall behe username for CHAP authentication.", + "description": "The user name for CHAP authentication.", + "longDescription": "This property shall containhe user name for CHAP authentication.", "readonly": false, "type": [ "string", @@ -676,13 +652,13 @@ "type": "null" } ], - "description": "The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.", - "longDescription": "The value of this property shall behe type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields. Mixing of IPv6 and IPv4 addresses on the same network device function shall not be permissible.", + "description": "The type of IP address being populated in the iSCSIBoot IP address fields.", + "longDescription": "This property shall contain the type of IP address being populated in the iSCSIBoot IP address fields. Mixing IPv6 and IPv4 addresses on the same network device function shall not be permissible.", "readonly": false }, "IPMaskDNSViaDHCP": { - "description": "Whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.", - "longDescription": "The value of this property shall be a boolean indicating whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.", + "description": "An indication of whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.", + "longDescription": "This property shall indicate whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.", "readonly": false, "type": [ "boolean", @@ -691,7 +667,7 @@ }, "InitiatorDefaultGateway": { "description": "The IPv6 or IPv4 iSCSI boot default gateway.", - "longDescription": "The value of this property shall be the IPv6 or IPv4 iSCSI boot default gateway.", + "longDescription": "This property shall contain the IPv6 or IPv4 iSCSI boot default gateway.", "readonly": false, "type": [ "string", @@ -700,7 +676,7 @@ }, "InitiatorIPAddress": { "description": "The IPv6 or IPv4 address of the iSCSI initiator.", - "longDescription": "The value of this property shall be the IPv6 or IPv4 address of the iSCSI boot initiator.", + "longDescription": "This property shall contain the IPv6 or IPv4 address of the iSCSI boot initiator.", "readonly": false, "type": [ "string", @@ -709,7 +685,7 @@ }, "InitiatorName": { "description": "The iSCSI initiator name.", - "longDescription": "The value of this property shall be the iSCSI boot initiator name. The value of this property should match formats defined in RFC3720 or RFC3721.", + "longDescription": "This property shall contain the iSCSI boot initiator name. This property should match formats defined in RFC3720 or RFC3721.", "readonly": false, "type": [ "string", @@ -718,7 +694,7 @@ }, "InitiatorNetmask": { "description": "The IPv6 or IPv4 netmask of the iSCSI boot initiator.", - "longDescription": "The value of this property shall be the IPv6 or IPv4 netmask of the iSCSI boot initiator.", + "longDescription": "This property shall contain the IPv6 or IPv4 netmask of the iSCSI boot initiator.", "readonly": false, "type": [ "string", @@ -726,8 +702,8 @@ ] }, "MutualCHAPSecret": { - "description": "The CHAP Secret for 2-way CHAP authentication.", - "longDescription": "The value of this property shall be the CHAP Secret for 2-way CHAP authentication.", + "description": "The CHAP secret for two-way CHAP authentication.", + "longDescription": "This property shall contain the CHAP secret for two-way CHAP authentication.", "readonly": false, "type": [ "string", @@ -735,8 +711,8 @@ ] }, "MutualCHAPUsername": { - "description": "The CHAP Username for 2-way CHAP authentication.", - "longDescription": "The value of this property shall be the CHAP Username for 2-way CHAP authentication.", + "description": "The CHAP user name for two-way CHAP authentication.", + "longDescription": "This property shall contain the CHAP user name for two-way CHAP authentication.", "readonly": false, "type": [ "string", @@ -745,7 +721,7 @@ }, "PrimaryDNS": { "description": "The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.", - "longDescription": "The value of this property shall be the IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.", + "longDescription": "This property shall contain the IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.", "readonly": false, "type": [ "string", @@ -754,7 +730,7 @@ }, "PrimaryLUN": { "description": "The logical unit number (LUN) for the primary iSCSI boot target.", - "longDescription": "The value of this property shall be the logical unit number (LUN) for the primary iSCSI boot target.", + "longDescription": "This property shall contain the logical unit number (LUN) for the primary iSCSI boot target.", "readonly": false, "type": [ "integer", @@ -762,8 +738,8 @@ ] }, "PrimaryTargetIPAddress": { - "description": "The IP address (IPv6 or IPv4) for the primary iSCSI boot target.", - "longDescription": "The value of this property shall be the IP address (IPv6 or IPv4) for the primary iSCSI boot target.", + "description": "The IPv4 or IPv6 address for the primary iSCSI boot target.", + "longDescription": "This property shall contain the IPv4 or IPv6 address for the primary iSCSI boot target.", "readonly": false, "type": [ "string", @@ -772,7 +748,7 @@ }, "PrimaryTargetName": { "description": "The name of the iSCSI primary boot target.", - "longDescription": "The value of this property shall be the name of the primary iSCSI boot target. The value of this property should match formats defined in RFC3720 or RFC3721.", + "longDescription": "This property shall contain the name of the primary iSCSI boot target. This property should match formats defined in RFC3720 or RFC3721.", "readonly": false, "type": [ "string", @@ -781,7 +757,7 @@ }, "PrimaryTargetTCPPort": { "description": "The TCP port for the primary iSCSI boot target.", - "longDescription": "The value of this property shall be the TCP port for the primary iSCSI boot target.", + "longDescription": "This property shall contain the TCP port for the primary iSCSI boot target.", "readonly": false, "type": [ "integer", @@ -789,8 +765,8 @@ ] }, "PrimaryVLANEnable": { - "description": "This indicates if the primary VLAN is enabled.", - "longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for the primary iSCSI boot target.", + "description": "An indication of whether the primary VLAN is enabled.", + "longDescription": "This property shall indicate whether this VLAN is enabled for the primary iSCSI boot target.", "readonly": false, "type": [ "boolean", @@ -799,7 +775,7 @@ }, "PrimaryVLANId": { "description": "The 802.1q VLAN ID to use for iSCSI boot from the primary target.", - "longDescription": "The value of this property shall be the 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true.", + "longDescription": "This property shall contain the 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true.", "maximum": 4094, "minimum": 0, "readonly": false, @@ -809,8 +785,8 @@ ] }, "RouterAdvertisementEnabled": { - "description": "Whether IPv6 router advertisement is enabled for the iSCSI boot target.", - "longDescription": "The value of this property shall be a boolean indicating whether IPv6 router advertisement is enabled for the iSCSI boot target. This setting shall only apply to IPv6 configurations.", + "description": "An indication of whether IPv6 router advertisement is enabled for the iSCSI boot target.", + "longDescription": "This property shall indicate whether IPv6 router advertisement is enabled for the iSCSI boot target. This setting shall apply to only IPv6 configurations.", "readonly": false, "type": [ "boolean", @@ -819,7 +795,7 @@ }, "SecondaryDNS": { "description": "The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.", - "longDescription": "The value of this property shall be the IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.", + "longDescription": "This property shall contain the IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.", "readonly": false, "type": [ "string", @@ -828,7 +804,7 @@ }, "SecondaryLUN": { "description": "The logical unit number (LUN) for the secondary iSCSI boot target.", - "longDescription": "The value of this property shall be the logical unit number (LUN) for the secondary iSCSI boot target.", + "longDescription": "This property shall contain the logical unit number (LUN) for the secondary iSCSI boot target.", "readonly": false, "type": [ "integer", @@ -836,8 +812,8 @@ ] }, "SecondaryTargetIPAddress": { - "description": "The IP address (IPv6 or IPv4) for the secondary iSCSI boot target.", - "longDescription": "The value of this property shall be the IP address (IPv6 or IPv4) for the secondary iSCSI boot target.", + "description": "The IPv4 or IPv6 address for the secondary iSCSI boot target.", + "longDescription": "This property shall contain the IPv4 or IPv6 address for the secondary iSCSI boot target.", "readonly": false, "type": [ "string", @@ -846,7 +822,7 @@ }, "SecondaryTargetName": { "description": "The name of the iSCSI secondary boot target.", - "longDescription": "The value of this property shall be the name of the secondary iSCSI boot target. The value of this property should match formats defined in RFC3720 or RFC3721.", + "longDescription": "This property shall contain the name of the secondary iSCSI boot target. This property should match formats defined in RFC3720 or RFC3721.", "readonly": false, "type": [ "string", @@ -855,7 +831,7 @@ }, "SecondaryTargetTCPPort": { "description": "The TCP port for the secondary iSCSI boot target.", - "longDescription": "The value of this property shall be the TCP port for the secondary iSCSI boot target.", + "longDescription": "This property shall contain the TCP port for the secondary iSCSI boot target.", "readonly": false, "type": [ "integer", @@ -863,8 +839,8 @@ ] }, "SecondaryVLANEnable": { - "description": "This indicates if the secondary VLAN is enabled.", - "longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for the secondary iSCSI boot target.", + "description": "An indication of whether the secondary VLAN is enabled.", + "longDescription": "This property shall indicate whether this VLAN is enabled for the secondary iSCSI boot target.", "readonly": false, "type": [ "boolean", @@ -873,7 +849,7 @@ }, "SecondaryVLANId": { "description": "The 802.1q VLAN ID to use for iSCSI boot from the secondary target.", - "longDescription": "The value of this property shall be the 802.1q VLAN ID to use for iSCSI boot from the secondary target. This VLAN ID is only used if SecondaryVLANEnable is true.", + "longDescription": "This property shall contain the 802.1q VLAN ID to use for iSCSI boot from the secondary target. This VLAN ID is only used if SecondaryVLANEnable is `true`.", "maximum": 4094, "minimum": 0, "readonly": false, @@ -883,8 +859,8 @@ ] }, "TargetInfoViaDHCP": { - "description": "Whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.", - "longDescription": "The value of this property shall be a boolean indicating whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.", + "description": "An indication of whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.", + "longDescription": "This property shall indicate whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.", "readonly": false, "type": [ "boolean", @@ -897,5 +873,5 @@ }, "owningEntity": "DMTF", "release": "2018.2", - "title": "#NetworkDeviceFunction.v1_3_1.NetworkDeviceFunction" + "title": "#NetworkDeviceFunction.v1_3_3.NetworkDeviceFunction" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/NetworkInterface/NetworkInterface.json b/static/redfish/v1/JsonSchemas/NetworkInterface/NetworkInterface.json index 7300c0191b..d35d52bd3a 100644 --- a/static/redfish/v1/JsonSchemas/NetworkInterface/NetworkInterface.json +++ b/static/redfish/v1/JsonSchemas/NetworkInterface/NetworkInterface.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/NetworkInterface.v1_1_3.json", "$ref": "#/definitions/NetworkInterface", "$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,18 +25,19 @@ "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" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -51,24 +53,24 @@ "properties": { "NetworkAdapter": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkAdapter.json#/definitions/NetworkAdapter", - "description": "A reference to the NetworkAdapter which contains this NetworkInterface.", - "longDescription": "The value of this property shall be a reference to a resource of type NetworkAdapter that represents the physical container associated with this NetworkInterface.", + "description": "The link to the network adapter that contains this network interface.", + "longDescription": "This property shall contain a link to a Resource of type NetworkAdapter that represents the physical container associated with this NetworkInterface.", "readonly": true }, "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." } }, "type": "object" }, "NetworkInterface": { "additionalProperties": false, - "description": "A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.", - "longDescription": "A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.", + "description": "The NetworkInterface schema describes links to the NetworkAdapter, NetworkPort, and NetworkDeviceFunction Resources and represents the functionality available to the containing system.", + "longDescription": "This Resource contains links to the NetworkAdapter, NetworkPort, and NetworkDeviceFunction Resources and represents the functionality available to the containing system.", "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", @@ -83,21 +85,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": [ @@ -116,7 +119,7 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Links.", + "description": "The links.", "longDescription": "Links for this controller." }, "Name": { @@ -125,25 +128,25 @@ }, "NetworkDeviceFunctions": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionCollection.json#/definitions/NetworkDeviceFunctionCollection", - "description": "A reference to the collection of NetworkDeviceFunctions associated with this NetworkInterface.", - "longDescription": "The value of this property shall be a link to a collection of type NetworkDeviceFunctionCollection.", + "description": "The link to the network device functions associated with this network interface.", + "longDescription": "This property shall contain a link to a Resource Collection of type NetworkDeviceFunctionCollection.", "readonly": true }, "NetworkPorts": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPortCollection.json#/definitions/NetworkPortCollection", - "description": "A reference to the collection of NetworkPorts associated with this NetworkInterface.", - "longDescription": "The value of this property shall be a link to a collection of type NetworkPortCollection.", + "description": "The link to the network ports associated with this network interface.", + "longDescription": "This property shall contain a link to a Resource Collection of type NetworkPortCollection.", "readonly": true }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -156,10 +159,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", @@ -177,5 +180,6 @@ } }, "owningEntity": "DMTF", - "title": "#NetworkInterface.v1_1_1.NetworkInterface" + "release": "2017.1", + "title": "#NetworkInterface.v1_1_3.NetworkInterface" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/NetworkPort/NetworkPort.json b/static/redfish/v1/JsonSchemas/NetworkPort/NetworkPort.json index af053f2f16..9deb19be37 100644 --- a/static/redfish/v1/JsonSchemas/NetworkPort/NetworkPort.json +++ b/static/redfish/v1/JsonSchemas/NetworkPort/NetworkPort.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/NetworkPort.v1_2_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/NetworkPort.v1_2_3.json", "$ref": "#/definitions/NetworkPort", "$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" } }, @@ -73,10 +73,10 @@ }, "NetDevFuncMaxBWAlloc": { "additionalProperties": false, - "description": "A maximum bandwidth allocation percentage for a Network Device Functions associated a port.", + "description": "A maximum bandwidth allocation percentage for a network device functions associated a port.", "longDescription": "This type shall describe a maximum bandwidth percentage allocation for a network device function associated with a port.", "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", @@ -92,7 +92,7 @@ "properties": { "MaxBWAllocPercent": { "description": "The maximum bandwidth allocation percentage allocated to the corresponding network device function instance.", - "longDescription": "The value of this property shall be the maximum bandwidth percentage allocation for the associated network device function.", + "longDescription": "This property shall contain the maximum bandwidth percentage allocation for the associated network device function.", "readonly": false, "type": [ "integer", @@ -102,8 +102,8 @@ }, "NetworkDeviceFunction": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction", - "description": "A reference to the NetworkDeviceFunction associated with this bandwidth setting of this Network Port.", - "longDescription": "The value of this property shall be a reference of type NetworkDeviceFunction that represents the Network Device Function associated with this bandwidth setting of this Network Port.", + "description": "The link to the NetworkDeviceFunction associated with this bandwidth setting of this network port.", + "longDescription": "This property shall contain a link of the NetworkDeviceFunction type that represents the network device function associated with this bandwidth setting of this network port.", "readonly": true } }, @@ -111,10 +111,10 @@ }, "NetDevFuncMinBWAlloc": { "additionalProperties": false, - "description": "A minimum bandwidth allocation percentage for a Network Device Functions associated a port.", + "description": "A minimum bandwidth allocation percentage for a network device functions associated a port.", "longDescription": "This type shall describe a minimum bandwidth percentage allocation for a network device function associated with a port.", "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", @@ -130,7 +130,7 @@ "properties": { "MinBWAllocPercent": { "description": "The minimum bandwidth allocation percentage allocated to the corresponding network device function instance.", - "longDescription": "The value of this property shall be the minimum bandwidth percentage allocation for the associated network device function. The sum total of all minimum percentages shall not exceed 100.", + "longDescription": "This property shall contain the minimum bandwidth percentage allocation for the associated network device function. The sum total of all minimum percentages shall not exceed 100.", "readonly": false, "type": [ "integer", @@ -140,8 +140,8 @@ }, "NetworkDeviceFunction": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction", - "description": "A reference to the NetworkDeviceFunction associated with this bandwidth setting of this Network Port.", - "longDescription": "The value of this property shall be a reference of type NetworkDeviceFunction that represents the Network Device Function associated with this bandwidth setting of this Network Port.", + "description": "The link to the NetworkDeviceFunction associated with this bandwidth setting of this network port.", + "longDescription": "This property shall contain a link of the NetworkDeviceFunction type that represents the network device function associated with this bandwidth setting of this network port.", "readonly": true } }, @@ -149,10 +149,10 @@ }, "NetworkPort": { "additionalProperties": false, - "description": "A Network Port represents a discrete physical port capable of connecting to a network.", - "longDescription": "A Network Port represents a discrete physical port capable of connecting to a network.", + "description": "A network port, which is a discrete physical port that can connect to a network.", + "longDescription": "A network port represents a discrete physical port that can connect to a network.", "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", @@ -167,21 +167,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "ActiveLinkTechnology": { @@ -193,25 +193,25 @@ "type": "null" } ], - "description": "Network Port Active Link Technology.", - "longDescription": "The value of this property shall be the configured link technology of this port.", + "description": "Network port active link technology.", + "longDescription": "This property shall contain the configured link technology of this port.", "readonly": false }, "AssociatedNetworkAddresses": { - "description": "The array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", + "description": "An array of configured MAC or WWN network addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be an array of configured network addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", + "longDescription": "This property shall contain an array of configured network addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", "readonly": true, "type": "array" }, "CurrentLinkSpeedMbps": { - "description": "Network Port Current Link Speed.", - "longDescription": "The value of this property shall be the current configured link speed of this port.", + "description": "Network port current link speed.", + "longDescription": "This property shall contain the current configured link speed of this port.", "readonly": false, "type": [ "integer", @@ -232,8 +232,8 @@ "readonly": true }, "EEEEnabled": { - "description": "Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port.", - "longDescription": "The value of this property shall be a boolean indicating whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port.", + "description": "An indication of whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.", + "longDescription": "This property shall indicate whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.", "readonly": false, "type": [ "boolean", @@ -259,8 +259,8 @@ "type": "null" } ], - "description": "This is the connection type of this port.", - "longDescription": "The value of this property shall be the connection type for this port.", + "description": "The connection type of this port.", + "longDescription": "This property shall contain the connection type for this port.", "readonly": true, "versionAdded": "v1_2_0" }, @@ -274,7 +274,7 @@ } ], "description": "The locally configured 802.3x flow control setting for this network port.", - "longDescription": "The value of this property shall be the locally configured 802.3x flow control setting for this network port.", + "longDescription": "This property shall contain the locally configured 802.3x flow control setting for this network port.", "readonly": false }, "FlowControlStatus": { @@ -287,7 +287,7 @@ } ], "description": "The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).", - "longDescription": "The value of this property shall be the 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).", + "longDescription": "This property shall contain the 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).", "readonly": true }, "Id": { @@ -304,12 +304,12 @@ } ], "description": "The status of the link between this port and its link partner.", - "longDescription": "The value of this property shall be the link status between this port and its link partner.", + "longDescription": "This property shall contain the link status between this port and its link partner.", "readonly": true }, "MaxFrameSize": { "description": "The maximum frame size supported by the port.", - "longDescription": "The value of this property shall be the maximum frame size supported by the port.", + "longDescription": "This property shall contain the maximum frame size supported by the port.", "readonly": true, "type": [ "integer", @@ -323,38 +323,24 @@ "readonly": true }, "NetDevFuncMaxBWAlloc": { - "description": "The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port.", + "description": "An array of maximum bandwidth allocation percentages for the network device functions associated with this port.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/NetDevFuncMaxBWAlloc" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/NetDevFuncMaxBWAlloc" }, - "longDescription": "The value of this property shall be an array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port.", + "longDescription": "This property shall contain an array of maximum bandwidth allocation percentages for the network device functions associated with this port.", "type": "array" }, "NetDevFuncMinBWAlloc": { - "description": "The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port.", + "description": "An array of minimum bandwidth allocation percentages for the network device functions associated with this port.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/NetDevFuncMinBWAlloc" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/NetDevFuncMinBWAlloc" }, - "longDescription": "The value of this property shall be an array of minimum bandwidth percentage allocations for each of the network device functions associated with this port.", + "longDescription": "This property shall contain an array of minimum bandwidth percentage allocations for each of the network device functions associated with this port.", "type": "array" }, "NumberDiscoveredRemotePorts": { "description": "The number of ports not on this adapter that this port has discovered.", - "longDescription": "The value of this property shall be the number of ports not on this adapter that this port has discovered.", + "longDescription": "This property shall contain the number of ports not on this adapter that this port has discovered.", "readonly": true, "type": [ "integer", @@ -364,12 +350,12 @@ }, "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." }, "PhysicalPortNumber": { "description": "The physical port number label for this port.", - "longDescription": "The value of this property shall be the physical port number on the network adapter hardware that this Network Port corresponds to. This value should match a value visible on the hardware. When HostPortEnabled and ManagementPortEnabled are both \"false\", the port shall not establish physical link.", + "longDescription": "This property shall contain the physical port number on the network adapter hardware that this network port corresponds to. This value should match a value visible on the hardware.", "readonly": true, "type": [ "string", @@ -378,7 +364,7 @@ }, "PortMaximumMTU": { "description": "The largest maximum transmission unit (MTU) that can be configured for this network port.", - "longDescription": "The value of this property shall be the largest maximum transmission unit (MTU) that can be configured for this network port.", + "longDescription": "This property shall contain the largest maximum transmission unit (MTU) that can be configured for this network port.", "readonly": true, "type": [ "integer", @@ -386,8 +372,8 @@ ] }, "SignalDetected": { - "description": "Whether or not the port has detected enough signal on enough lanes to establish link.", - "longDescription": "The value of this property shall be a boolean indicating whether the port has detected enough signal on enough lanes to establish link.", + "description": "An indication of whether the port has detected enough signal on enough lanes to establish a link.", + "longDescription": "This property shall indicate whether the port has detected enough signal on enough lanes to establish a link.", "readonly": true, "type": [ "boolean", @@ -396,8 +382,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SupportedEthernetCapabilities": { "description": "The set of Ethernet capabilities that this port supports.", @@ -411,28 +397,21 @@ } ] }, - "longDescription": "The value of this property shall be an array of zero or more Ethernet capabilities supported by this port.", + "longDescription": "This property shall contain an array of zero or more Ethernet capabilities supported by this port.", "readonly": true, "type": "array" }, "SupportedLinkCapabilities": { - "description": "The self-described link capabilities of this port.", + "description": "The link capabilities of this port.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/SupportedLinkCapabilities" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/SupportedLinkCapabilities" }, - "longDescription": "This object shall describe the static capabilities of the port, irrespective of transient conditions such as cabling, interface module presence, or remote link parter status or configuration.", + "longDescription": "This property shall describe the static capabilities of the port, irrespective of transient conditions such as cabling, interface module presence, or remote link parter status or configuration.", "type": "array" }, "VendorId": { - "description": "The Vendor Identification for this port.", - "longDescription": "This property shall indicate the Vendor Identification string information as provided by the manufacturer of this port.", + "description": "The vendor Identification for this port.", + "longDescription": "This property shall indicate the vendor Identification string information as provided by the manufacturer of this port.", "readonly": true, "type": [ "string", @@ -441,8 +420,8 @@ "versionAdded": "v1_2_0" }, "WakeOnLANEnabled": { - "description": "Whether Wake on LAN (WoL) is enabled for this network port.", - "longDescription": "The value of this property shall be a boolean indicating whether Wake on LAN (WoL) is enabled for this network port.", + "description": "An indication of whether Wake on LAN (WoL) is enabled for this network port.", + "longDescription": "This property shall indicate whether Wake on LAN (WoL) is enabled for this network port.", "readonly": false, "type": [ "boolean", @@ -460,10 +439,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", @@ -492,7 +471,7 @@ "enumDescriptions": { "ExtenderFabric": "This port connection type is an extender fabric port.", "Generic": "This port connection type is a generic fabric port.", - "NPort": "This port connects via an N-Port to a switch.", + "NPort": "This port connects through an N-Port to a switch.", "NotConnected": "This port is not connected.", "PointToPoint": "This port connects in a Point-to-point configuration.", "PrivateLoop": "This port connects in a private loop configuration.", @@ -506,17 +485,17 @@ "EEE" ], "enumDescriptions": { - "EEE": "IEEE 802.3az Energy Efficient Ethernet (EEE) is supported on this port.", + "EEE": "IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port.", "WakeOnLAN": "Wake on LAN (WoL) is supported on this port." }, "type": "string" }, "SupportedLinkCapabilities": { "additionalProperties": false, - "description": "The self-described link capabilities of an assocaited port.", + "description": "The link capabilities of an assocaited port.", "longDescription": "This type shall describe the static capabilities of an associated port, irrespective of transient conditions such as cabling, interface module presence, or remote link parter status or configuration.", "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", @@ -531,8 +510,8 @@ }, "properties": { "AutoSpeedNegotiation": { - "description": "Indicates whether the port has the capability to auto negotiate speed.", - "longDescription": "The value of this property shall be indicate whether the port is capable of auto-negotiating speed.", + "description": "An indication of whether the port is capable of auto-negotiating speed.", + "longDescription": "This property shall indicate whether the port is capable of auto-negotiating speed.", "readonly": true, "type": [ "boolean", @@ -541,14 +520,14 @@ "versionAdded": "v1_2_0" }, "CapableLinkSpeedMbps": { - "description": "The self-described link network speed capabilities of this port. Note: Should this be a new enumerated type of link speeds?.", + "description": "The set of link speed capabilities of this port.", "items": { "type": [ "integer", "null" ] }, - "longDescription": "The value of this property shall be all of the possible network link speed capabilities of this port.", + "longDescription": "This property shall contain all of the possible network link speed capabilities of this port.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" @@ -562,19 +541,21 @@ "type": "null" } ], - "description": "The self-described link network technology capabilities of this port.", - "longDescription": "The value of this property shall be a network technology capability of this port.", + "description": "The link network technology capabilities of this port.", + "longDescription": "This property shall contain a network technology capability of this port.", "readonly": true }, "LinkSpeedMbps": { + "deprecated": "This property has been deprecated in favor of the CapableLinkSpeedMbps.", "description": "The speed of the link in Mbps when this link network technology is active.", - "longDescription": "The value of this property shall be the speed of the link in megabits per second (Mbps) for this port when this link network technology is active.", + "longDescription": "This property shall contain the speed of the link in megabits per second (Mbps) for this port when this link network technology is active.", "readonly": true, "type": [ "integer", "null" ], - "units": "Mbit/s" + "units": "Mbit/s", + "versionDeprecated": "v1_2_0" } }, "type": "object" @@ -582,5 +563,5 @@ }, "owningEntity": "DMTF", "release": "2018.2", - "title": "#NetworkPort.v1_2_1.NetworkPort" + "title": "#NetworkPort.v1_2_3.NetworkPort" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/PCIeDevice/PCIeDevice.json b/static/redfish/v1/JsonSchemas/PCIeDevice/PCIeDevice.json index 4f7c224175..3358583336 100644 --- a/static/redfish/v1/JsonSchemas/PCIeDevice/PCIeDevice.json +++ b/static/redfish/v1/JsonSchemas/PCIeDevice/PCIeDevice.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.v1_4_0.json", "$ref": "#/definitions/PCIeDevice", "$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" @@ -38,17 +40,17 @@ ], "enumDescriptions": { "MultiFunction": "A multi-function PCIe device.", - "Simulated": "A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.", + "Simulated": "A PCIe device that is not currently physically present, but is being simulated by the PCIe infrastructure.", "SingleFunction": "A single-function PCIe device." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -63,43 +65,45 @@ }, "properties": { "Chassis": { - "description": "An array of references to the chassis in which the PCIe device is contained.", + "description": "An array of links to the chassis in which the PCIe device is contained.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" }, - "longDescription": "The value of this property shall reference a resource of type Chassis that represents the physical container associated with this resource.", + "longDescription": "This property shall link to a Resource of type Chassis that represents the physical container associated with this Resource.", "readonly": true, "type": "array" }, "Chassis@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PCIeFunctions": { - "description": "An array of references to PCIeFunctions exposed by this device.", + "deprecated": "This property has been deprecated in favor of the PCIeFunctions property in the root that provides a link to a Resource Collection.", + "description": "An array of links to PCIeFunctions exposed by this device.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction" }, - "longDescription": "The value of this property shall be a reference to the resources that this device exposes and shall reference a resource of type PCIeFunction.", + "longDescription": "This property shall contain a link to the Resources of the PCIeFunction type that this device exposes.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_4_0" }, "PCIeFunctions@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -117,10 +121,10 @@ }, "PCIeDevice": { "additionalProperties": false, - "description": "This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System.", - "longDescription": "This resource shall be used to represent a PCIeDevice attached to a System.", + "description": "The PCIeDevice schema describes the properties of a PCIe device that is attached to a system.", + "longDescription": "This Resource contains a PCIeDevice that is attached to a system.", "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", @@ -135,31 +139,33 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this PCIe device.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", - "readonly": true + "description": "The link to the assembly Resource associated with this PCIe device.", + "longDescription": "This property shall contain a link to a Resource of type assembly.", + "readonly": true, + "versionAdded": "v1_2_0" }, "AssetTag": { - "description": "The user assigned asset tag for this PCIe device.", - "longDescription": "The value of this property shall be an identifying string used to track the PCIe device for inventory purposes.", + "description": "The user-assigned asset tag for this PCIe device.", + "longDescription": "This property shall contain an identifying string that tracks the PCIe device for inventory purposes.", "readonly": false, "type": [ "string", @@ -180,12 +186,12 @@ "DeviceType": { "$ref": "#/definitions/DeviceType", "description": "The device type for this PCIe device.", - "longDescription": "The value of this property shall be the device type of the PCIe device such as SingleFunction or MultiFunction.", + "longDescription": "This property shall contain the device type of the PCIe device such as SingleFunction or MultiFunction.", "readonly": true }, "FirmwareVersion": { "description": "The version of firmware for this PCIe device.", - "longDescription": "The value of this property shall be the firmware version of the PCIe device.", + "longDescription": "This property shall contain the firmware version of the PCIe device.", "readonly": true, "type": [ "string", @@ -198,12 +204,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "The links object contains the links to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by, or subordinate to, this Resource." }, "Manufacturer": { - "description": "This is the manufacturer of this PCIe device.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the PCIe device. This organization might be the entity from whom the PCIe device is purchased, but this is not necessarily true.", + "description": "The manufacturer of this PCIe device.", + "longDescription": "This property shall contain the name of the organization responsible for producing the PCIe device. This organization might be the entity from whom the PCIe device is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -211,8 +217,8 @@ ] }, "Model": { - "description": "This is the model number for the PCIe device.", - "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the PCIe device.", + "description": "The model number for the PCIe device.", + "longDescription": "This property shall contain the name by which the manufacturer generally refers to the PCIe device.", "readonly": true, "type": [ "string", @@ -225,24 +231,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." + }, + "PCIeFunctions": { + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunctionCollection.json#/definitions/PCIeFunctionCollection", + "description": "The link to the collection of PCIe functions associated with this PCIe device.", + "longDescription": "This property shall contain a link to a Resource Collection of type PCIeFunctionCollection.", + "readonly": true, + "versionAdded": "v1_4_0" }, "PCIeInterface": { - "anyOf": [ - { - "$ref": "#/definitions/PCIeInterface" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/PCIeInterface", "description": "The PCIe interface details for this PCIe device.", - "longDescription": "This object shall contain details on the PCIe interface used to connect this PCIe Device to its host or upstream switch." + "longDescription": "This object shall contain details for the PCIe interface that connects this PCIe device to its host or upstream switch.", + "versionAdded": "v1_3_0" }, "PartNumber": { "description": "The part number for this PCIe device.", - "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the PCIe device.", + "longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the PCIe device.", "readonly": true, "type": [ "string", @@ -250,8 +257,8 @@ ] }, "SKU": { - "description": "This is the SKU for this PCIe device.", - "longDescription": "The value of this property shall be the stock-keeping unit number for this PCIe device.", + "description": "The SKU for this PCIe device.", + "longDescription": "This property shall contain the stock-keeping unit number for this PCIe device.", "readonly": true, "type": [ "string", @@ -260,7 +267,7 @@ }, "SerialNumber": { "description": "The serial number for this PCIe device.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the PCIe device.", + "longDescription": "This property shall contain a manufacturer-allocated number that identifies the PCIe device.", "readonly": true, "type": [ "string", @@ -269,8 +276,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -283,10 +290,10 @@ }, "PCIeInterface": { "additionalProperties": false, - "description": "This is the definition for a PCI Interface object.", - "longDescription": "These properties shall be the definition for a PCIe Interface for a Redfish implementation.", + "description": "This type defines a PCI interface.", + "longDescription": "These properties shall contain the definition for a PCIe Interface 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", @@ -301,24 +308,26 @@ }, "properties": { "LanesInUse": { - "description": "This is the number of PCIe lanes in use by this device.", - "longDescription": "The value of this property shall be the number of PCIe lanes in use by this device, which shall be equal or less than the value of MaxLanes.", + "description": "The number of PCIe lanes in use by this device.", + "longDescription": "This property shall contain the number of PCIe lanes in use by this device, which shall be equal to or less than the MaxLanes property value.", "maximum": 32, "readonly": true, "type": [ "integer", "null" - ] + ], + "versionAdded": "v1_3_0" }, "MaxLanes": { - "description": "This is the number of PCIe lanes supported by this device.", - "longDescription": "The value of this property shall be the maximum number of PCIe lanes supported by this device.", + "description": "The number of PCIe lanes supported by this device.", + "longDescription": "This property shall contain the maximum number of PCIe lanes supported by this device.", "maximum": 32, "readonly": true, "type": [ "integer", "null" - ] + ], + "versionAdded": "v1_3_0" }, "MaxPCIeType": { "anyOf": [ @@ -330,13 +339,15 @@ } ], "description": "The highest version of the PCIe specification supported by this device.", - "longDescription": "The value of this property shall be the maximum PCIe specification that this device supports.", - "readonly": true + "longDescription": "This property shall contain the maximum PCIe specification that this device supports.", + "readonly": true, + "versionAdded": "v1_3_0" }, "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" }, "PCIeType": { "anyOf": [ @@ -348,30 +359,15 @@ } ], "description": "The version of the PCIe specification in use by this device.", - "longDescription": "The value of this property shall be the negotiated PCIe interface version in use by this device.", - "readonly": true + "longDescription": "This property shall contain the negotiated PCIe interface version in use by this device.", + "readonly": true, + "versionAdded": "v1_3_0" } }, "type": "object" - }, - "PCIeTypes": { - "enum": [ - "Gen1", - "Gen2", - "Gen3", - "Gen4", - "Gen5" - ], - "enumDescriptions": { - "Gen1": "A PCIe v1.0 slot.", - "Gen2": "A PCIe v2.0 slot.", - "Gen3": "A PCIe v3.0 slot.", - "Gen4": "A PCIe v4.0 slot.", - "Gen5": "A PCIe v5.0 slot." - }, - "type": "string" } }, "owningEntity": "DMTF", - "title": "#PCIeDevice.v1_3_0.PCIeDevice" + "release": "2019.2", + "title": "#PCIeDevice.v1_4_0.PCIeDevice" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/PCIeFunction/PCIeFunction.json b/static/redfish/v1/JsonSchemas/PCIeFunction/PCIeFunction.json index 94e628c25f..a607d067cd 100644 --- a/static/redfish/v1/JsonSchemas/PCIeFunction/PCIeFunction.json +++ b/static/redfish/v1/JsonSchemas/PCIeFunction/PCIeFunction.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.v1_2_3.json", "$ref": "#/definitions/PCIeFunction", "$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" @@ -71,7 +73,7 @@ "MultimediaController": "A multimedia controller.", "NetworkController": "A network controller.", "NonEssentialInstrumentation": "A non-essential instrumentation.", - "Other": "A other class. The function Device Class Id needs to be verified.", + "Other": "A other class. The function Device Class Id needs to be verified.", "ProcessingAccelerators": "A processing accelerators.", "Processor": "A processor.", "SatelliteCommunicationsController": "A satellite communications controller.", @@ -89,17 +91,17 @@ "Virtual" ], "enumDescriptions": { - "Physical": "A physical PCie function.", + "Physical": "A physical PCIe function.", "Virtual": "A virtual PCIe function." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -114,80 +116,74 @@ }, "properties": { "Drives": { - "description": "An array of references to the drives which the PCIe device produces.", + "description": "An array of links to the drives that the PCIe device produces.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" }, - "longDescription": "The value of this property shall reference a resource of type Drive that represents the storage drives associated with this resource.", + "longDescription": "This property shall link to a Resource of type Drive that represents the storage drives associated with this Resource.", "readonly": true, "type": "array" }, "Drives@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "EthernetInterfaces": { - "description": "An array of references to the ethernet interfaces which the PCIe device produces.", + "description": "An array of links to the Ethernet interfaces that the PCIe device produces.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface" }, - "longDescription": "The value of this property shall reference a resource of type EthernetInterface that represents the network interfaces associated with this resource.", + "longDescription": "This property shall link to a Resource of type EthernetInterface that represents the network interfaces associated with this Resource.", "readonly": true, "type": "array" }, "EthernetInterfaces@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "NetworkDeviceFunctions": { - "description": "An array of references to the Network Device Functions which the PCIe device produces.", + "description": "An array of links to the network device functions that the PCIe device produces.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction" }, - "longDescription": "The value of this property shall be an array of references to resources of type NetworkDeviceFunction that represents the network device functions associated with this resource.", + "longDescription": "This property shall contain an array of links to Resources of the NetworkDeviceFunction type that represents the network device functions associated with this Resource.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "NetworkDeviceFunctions@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PCIeDevice": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" - }, - { - "type": "null" - } - ], - "description": "A reference to the PCIeDevice on which this function resides.", - "longDescription": "The value of this property shall be a reference to the resource that this function is a part of and shall reference a resource of type PCIeDevice.", + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice", + "description": "The link to the PCIe device on which this function resides.", + "longDescription": "This property shall contain a link to a Resource of type PCIeDevice of which this function is a part.", "readonly": true }, "StorageControllers": { - "description": "An array of references to the storage controllers which the PCIe device produces.", + "description": "An array of links to the storage controllers that the PCIe device produces.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/StorageController" }, - "longDescription": "The value of this property shall reference a resource of type StorageController that represents the storage controllers associated with this resource.", + "longDescription": "This property shall link to a Resource of type StorageController that represents the storage controllers associated with this Resource.", "readonly": true, "type": "array" }, "StorageControllers@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -205,10 +201,10 @@ }, "PCIeFunction": { "additionalProperties": false, - "description": "This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a System.", - "longDescription": "This resource shall be used to represent a PCIeFunction attached to a System.", + "description": "The schema definition for the PCIeFunction Resource. It represents the properties of a PCIeFunction attached to a System.", + "longDescription": "This Resource shall represent a PCIeFunction attached to a System.", "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", @@ -223,25 +219,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "ClassCode": { "description": "The Class Code of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Class Code of the PCIe device function.", + "longDescription": "This property shall contain the PCI Class Code of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){3}$", "readonly": true, "type": [ @@ -262,13 +259,13 @@ }, "DeviceClass": { "$ref": "#/definitions/DeviceClass", - "description": "The class for this PCIe Function.", - "longDescription": "The value of this property shall be the device class of the PCIe device function such as Storage, Network, Memory etc.", + "description": "The class for this PCIe function.", + "longDescription": "This property shall contain the device class of the PCIe device function, such as storage, network, or memory.", "readonly": true }, "DeviceId": { "description": "The Device ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Device ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Device ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -277,8 +274,8 @@ ] }, "FunctionId": { - "description": "The the PCIe Function identifier.", - "longDescription": "The value of this property shall the PCIe device function number within a given PCIe device.", + "description": "The PCIe Function Number.", + "longDescription": "This property shall contain the PCIe Function Number within a given PCIe device.", "readonly": true, "type": [ "integer", @@ -287,8 +284,8 @@ }, "FunctionType": { "$ref": "#/definitions/FunctionType", - "description": "The type of the PCIe Function.", - "longDescription": "The value of this property shall be the function type of the PCIe device function such as Physical or Virtual.", + "description": "The type of the PCIe function.", + "longDescription": "This property shall contain the function type of the PCIe device function such as Physical or Virtual.", "readonly": true }, "Id": { @@ -297,8 +294,8 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "The links object contains the links to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by, or subordinate to, this Resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -306,12 +303,12 @@ }, "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." }, "RevisionId": { "description": "The Revision ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Revision ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Revision ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){1}$", "readonly": true, "type": [ @@ -321,12 +318,12 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SubsystemId": { "description": "The Subsystem ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Subsystem ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Subsystem ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -336,7 +333,7 @@ }, "SubsystemVendorId": { "description": "The Subsystem Vendor ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -346,7 +343,7 @@ }, "VendorId": { "description": "The Vendor ID of this PCIe function.", - "longDescription": "The value of this property shall be the PCI Vendor ID of the PCIe device function.", + "longDescription": "This property shall contain the PCI Vendor ID of the PCIe device function.", "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$", "readonly": true, "type": [ @@ -365,5 +362,6 @@ } }, "owningEntity": "DMTF", - "title": "#PCIeFunction.v1_2_1.PCIeFunction" + "release": "2018.1", + "title": "#PCIeFunction.v1_2_3.PCIeFunction" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/PCIeSlots/PCIeSlots.json b/static/redfish/v1/JsonSchemas/PCIeSlots/PCIeSlots.json index d854d753d8..dc298c1674 100644 --- a/static/redfish/v1/JsonSchemas/PCIeSlots/PCIeSlots.json +++ b/static/redfish/v1/JsonSchemas/PCIeSlots/PCIeSlots.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/PCIeSlots.v1_1_1.json", "$ref": "#/definitions/PCIeSlots", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "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", @@ -53,10 +54,10 @@ }, "PCIeLinks": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -72,30 +73,30 @@ "properties": { "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." }, "PCIeDevice": { - "description": "An array of references to the PCIe Devices contained in this slot.", + "description": "An array of links to the PCIe devices contained in this slot.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" }, - "longDescription": "The value of this property shall be an array of references to the resources that this physical slot is associated with and shall reference resources of type PCIeDevice. If the Status.State of this slot has a value of Absent, this property shall not appear in the resource.", + "longDescription": "This property shall contain an array of links to the Resources of the PCIeDevice type with which this physical slot is associated. If the Status.State of this slot is `Absent`, this property shall not appear in the Resource.", "readonly": true, "type": "array" }, "PCIeDevice@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "PCIeSlot": { "additionalProperties": false, - "description": "This is the definition for a PCI slot information object.", - "longDescription": "These properties shall be the definition for a PCIe Slot for a Redfish implementation.", + "description": "This type defines information for a PCIe slot.", + "longDescription": "These properties shall contain the definition for a PCIe Slot 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", @@ -109,9 +110,19 @@ } }, "properties": { + "HotPluggable": { + "description": "An indication of whether this PCIe slot supports hotplug.", + "longDescription": "This property shall contain indicating whether this PCIe slot supports hotplug.", + "readonly": true, + "type": [ + "boolean", + "null" + ], + "versionAdded": "v1_1_0" + }, "Lanes": { - "description": "This is the number of PCIe lanes supported by this slot.", - "longDescription": "The value of this property shall be the maximum number of PCIe lanes supported by the slot.", + "description": "The number of PCIe lanes supported by this slot.", + "longDescription": "This property shall contain the maximum number of PCIe lanes supported by the slot.", "maximum": 32, "readonly": true, "type": [ @@ -120,26 +131,19 @@ ] }, "Links": { - "anyOf": [ - { - "$ref": "#/definitions/PCIeLinks" - }, - { - "type": "null" - } - ], - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "$ref": "#/definitions/PCIeLinks", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the PCIe slot.", + "description": "The location of the PCIe slot.", "longDescription": "This property shall contain part location information, including a ServiceLable of the associated PCIe Slot." }, "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." }, "PCIeType": { "anyOf": [ @@ -150,8 +154,8 @@ "type": "null" } ], - "description": "This is the PCIe specification supported by this slot.", - "longDescription": "The value of this property shall be the maximum PCIe specification that this slot supports.", + "description": "The PCIe specification supported by this slot.", + "longDescription": "This property shall contain the maximum PCIe specification that this slot supports.", "readonly": true }, "SlotType": { @@ -163,24 +167,24 @@ "type": "null" } ], - "description": "This is the PCIe slot type for this slot.", - "longDescription": "The value of this property shall be the slot type as specified by the PCIe specification.", + "description": "The PCIe slot type for this slot.", + "longDescription": "This property shall contain the slot type as specified by the PCIe specification.", "readonly": true }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "type": "object" }, "PCIeSlots": { "additionalProperties": false, - "description": "This is the schema definition for the PCIe Slot properties.", - "longDescription": "This resource shall be used to represent an set of PCIe slot information for a Redfish implementation.", + "description": "The PCIeSlots schema describes PCIe slot properties.", + "longDescription": "This Resource shall represent a set of PCIe slot information 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", @@ -195,21 +199,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -232,20 +236,13 @@ }, "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." }, "Slots": { "description": "An array of PCI Slot information.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/PCIeSlot" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/PCIeSlot" }, "longDescription": "This array shall contain an entry for each PCIe slot, including empty slots (with no device or card installed).", "type": "array" @@ -280,5 +277,6 @@ } }, "owningEntity": "DMTF", - "title": "#PCIeSlots.v1_0_0.PCIeSlots" + "release": "2019.1", + "title": "#PCIeSlots.v1_1_1.PCIeSlots" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Port/Port.json b/static/redfish/v1/JsonSchemas/Port/Port.json index 30045463ce..5bf02719a8 100644 --- a/static/redfish/v1/JsonSchemas/Port/Port.json +++ b/static/redfish/v1/JsonSchemas/Port/Port.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Port.v1_1_3.json", "$ref": "#/definitions/Port", "$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", @@ -27,18 +28,18 @@ }, "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." } }, "type": "object" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -53,55 +54,55 @@ }, "properties": { "AssociatedEndpoints": { - "description": "An array of references to the endpoints that connect to the switch through this port.", + "description": "An array of links to the endpoints that connect through this port.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be a reference to the resources that this port is associated with and shall reference a resource of type Endpoint.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this port is associated.", "readonly": true, "type": "array" }, "AssociatedEndpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ConnectedSwitchPorts": { - "description": "An array of references to the ports that connect to the switch through this port.", + "description": "An array of links to the ports that connect to the switch through this port.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port" }, - "longDescription": "The value of this property shall be a reference to the resources that this port is associated with and shall reference a resource of type Port.", + "longDescription": "This property shall contain a link to the Resources of the Port type with which this port is associated.", "readonly": true, "type": "array" }, "ConnectedSwitchPorts@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ConnectedSwitches": { - "description": "An array of references to the switches that connect to the switch through this port.", + "description": "An array of links to the switches that connect to the device through this port.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Switch.json#/definitions/Switch" }, - "longDescription": "The value of this property shall be a reference to the resources that this port is associated with and shall reference a resource of type Switch.", + "longDescription": "This property shall contain a link to the Resources of the Switch type with which this port is associated.", "readonly": true, "type": "array" }, "ConnectedSwitches@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." } }, "type": "object" }, "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", @@ -119,10 +120,10 @@ }, "Port": { "additionalProperties": false, - "description": "Port contains properties describing a port of a switch.", - "longDescription": "This resource shall be used to represent a simple switch port for a Redfish implementation.", + "description": "The Port schema contains properties that describe a port of a switch, controller, chassis, or any other device that could be connected to another entity.", + "longDescription": "This Resource contains a simple port 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", @@ -137,25 +138,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "CurrentSpeedGbps": { "description": "The current speed of this port.", - "longDescription": "The value of this property shall be the speed of this port currently negotiated and running.", + "longDescription": "This property shall contain the speed of this port currently negotiated and running.", "readonly": true, "type": [ "number", @@ -180,17 +181,18 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the port.", - "longDescription": "This property shall contain location information of the associated port." + "description": "The location of the port.", + "longDescription": "This property shall contain location information of the associated port.", + "versionAdded": "v1_1_0" }, "MaxSpeedGbps": { "description": "The maximum speed of this port as currently configured.", - "longDescription": "The value of this property shall be the maximum speed of which this port is capable of being configured. If capable of auto-negotiation, the system shall attempt to negotiate at the maximum speed set.", + "longDescription": "This property shall contain the maximum speed of which this port is capable of being configured. If capable of auto-negotiation, the system shall attempt to negotiate at the maximum speed set.", "readonly": true, "type": [ "number", @@ -204,12 +206,12 @@ }, "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." }, "PortId": { - "description": "This is the label of this port on the physical switch package.", - "longDescription": "The value of this property shall be the name of the switch port as indicated on the outside of the switch.", + "description": "The label of this port on the physical package for this port.", + "longDescription": "This property shall contain the name of the port as indicated on the device containing the port.", "readonly": true, "type": [ "string", @@ -226,7 +228,7 @@ } ], "description": "The protocol being sent over this port.", - "longDescription": "The value of this property shall contain the protocol being sent over this port.", + "longDescription": "This property shall contain the protocol being sent over this port.", "readonly": true }, "PortType": { @@ -238,18 +240,18 @@ "type": "null" } ], - "description": "This is the type of this port.", - "longDescription": "The value of this property shall be the port type for this port.", + "description": "The type of this port.", + "longDescription": "This property shall contain the port type for this port.", "readonly": true }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Width": { "description": "The number of lanes, phys, or other physical transport links that this port contains.", - "longDescription": "The value of this property shall be the number of physical transport links that this port contains.", + "longDescription": "This property shall contain the number of physical transport links that this port contains.", "readonly": true, "type": [ "integer", @@ -286,17 +288,17 @@ }, "Reset": { "additionalProperties": false, - "description": "This action is used to reset this port.", - "longDescription": "This action shall perform a reset of this port.", + "description": "This action resets this port.", + "longDescription": "This action shall reset this port.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", - "description": "The type of reset to be performed.", - "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset." + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation specific default reset." } }, "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", @@ -312,7 +314,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -324,5 +326,6 @@ } }, "owningEntity": "DMTF", - "title": "#Port.v1_1_1.Port" + "release": "2017.3", + "title": "#Port.v1_1_3.Port" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Power/Power.json b/static/redfish/v1/JsonSchemas/Power/Power.json index 7a55e97de9..576c476da7 100644 --- a/static/redfish/v1/JsonSchemas/Power/Power.json +++ b/static/redfish/v1/JsonSchemas/Power/Power.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Power.v1_5_2.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Power.v1_5_4.json", "$ref": "#/definitions/Power", "$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_3_0" } }, @@ -35,9 +35,9 @@ "InputRange": { "additionalProperties": false, "description": "This type describes an input range for a power supply.", - "longDescription": "This type shall describe an input range that the associated power supply is able to utilize.", + "longDescription": "This type shall describe an input range that the associated power supply can utilize.", "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", @@ -67,7 +67,7 @@ }, "MaximumFrequencyHz": { "description": "The maximum line input frequency at which this power supply input range is effective.", - "longDescription": "This property shall contain the value in Hertz of the maximum line input frequency which the power supply is capable of consuming for this range.", + "longDescription": "This property shall contain the value, in Hertz, of the maximum line input frequency that the power supply is capable of consuming for this range.", "minimum": 0, "readonly": true, "type": [ @@ -79,7 +79,7 @@ }, "MaximumVoltage": { "description": "The maximum line input voltage at which this power supply input range is effective.", - "longDescription": "This property shall contain the value in Volts of the maximum line input voltage which the power supply is capable of consuming for this range.", + "longDescription": "This property shall contain the value, in volts, of the maximum line input voltage that the power supply is capable of consuming for this range.", "readonly": true, "type": [ "number", @@ -90,7 +90,7 @@ }, "MinimumFrequencyHz": { "description": "The minimum line input frequency at which this power supply input range is effective.", - "longDescription": "This property shall contain the value in Hertz of the minimum line input frequency which the power supply is capable of consuming for this range.", + "longDescription": "This property shall contain the value, in Hertz, of the minimum line input frequency that the power supply is capable of consuming for this range.", "minimum": 0, "readonly": true, "type": [ @@ -102,7 +102,7 @@ }, "MinimumVoltage": { "description": "The minimum line input voltage at which this power supply input range is effective.", - "longDescription": "This property shall contain the value in Volts of the minimum line input voltage which the power supply is capable of consuming for this range.", + "longDescription": "This property shall contain the value, in volts, of the minimum line input voltage that the power supply is capable of consuming for this range.", "readonly": true, "type": [ "number", @@ -113,13 +113,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_1_0" }, "OutputWattage": { - "description": "The maximum capacity of this Power Supply when operating in this input range.", - "longDescription": "This property shall contiain the maximum amount of power, in Watts, that the associated power supply is rated to deliver while operating in this input range.", + "description": "The maximum capacity of this power supply when operating in this input range.", + "longDescription": "This property shall contain the maximum amount of power, in watts, that the associated power supply is rated to deliver while operating in this input range.", "minimum": 0, "readonly": true, "type": [ @@ -159,9 +159,9 @@ "DC240V" ], "enumDeprecated": { - "ACHighLine": "This value has been Deprecated in favor of AC277V.", - "ACLowLine": "This value has been Deprecated in favor of AC120V.", - "ACMidLine": "This value has been Deprecated in favor of AC240V." + "ACHighLine": "This value has been deprecated in favor of AC277V.", + "ACLowLine": "This value has been deprecated in favor of AC120V.", + "ACMidLine": "This value has been deprecated in favor of AC240V." }, "enumDescriptions": { "AC120V": "AC 120V nominal input.", @@ -194,10 +194,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", @@ -215,10 +215,10 @@ }, "Power": { "additionalProperties": false, - "description": "This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.", - "longDescription": "This resource shall be used to represent a power metrics resource for a Redfish implementation.", + "description": "The Power schema describes power metrics and represents the properties for power consumption and power limiting.", + "longDescription": "This Resource contains a Power Metrics Resource 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", @@ -233,21 +233,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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_3_0" }, "Description": { @@ -271,56 +271,56 @@ }, "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." }, "PowerControl": { "autoExpand": true, - "description": "This is the definition for power control function (power reading/limiting).", + "description": "The set of power control functions, including power reading and limiting.", "items": { "$ref": "#/definitions/PowerControl" }, - "longDescription": "These properties shall be the definition for power control (power reading and limiting) for a Redfish implementation.", + "longDescription": "This property shall contain the set of power control readings and settings.", "type": "array" }, "PowerControl@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "PowerSupplies": { "autoExpand": true, - "description": "Details of the power supplies associated with this system or device.", + "description": "The set of power supplies associated with this system or device.", "items": { "$ref": "#/definitions/PowerSupply" }, - "longDescription": "This object shall contain details of the power supplies associated with this system or device.", + "longDescription": "This property shall contain the set of power supplies associated with this system or device.", "type": "array" }, "PowerSupplies@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Redundancy": { "autoExpand": true, - "description": "Redundancy information for the power subsystem of this system or device.", + "description": "The redundancy information for the set of power supplies in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "This property shall contain redundancy information for the power subsystem of this system or device.", + "longDescription": "This property shall contain redundancy information for the set of power supplies in this system or device.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Voltages": { "autoExpand": true, - "description": "This is the definition for voltage sensors.", + "description": "The set of voltage sensors for this chassis.", "items": { "$ref": "#/definitions/Voltage" }, - "longDescription": "These properties shall be the definition for voltage sensors for a Redfish implementation.", + "longDescription": "This property shall contain the set of voltage sensors for this chassis.", "type": "array" }, "Voltages@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "required": [ @@ -334,7 +334,7 @@ "PowerControl": { "additionalProperties": false, "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", @@ -349,23 +349,23 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/PowerControlActions", - "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_3_0" }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "Name": { - "description": "Power Control Function name.", - "longDescription": "The value of this property shall be the name of the Voltage sensor.", + "description": "The power control function name.", + "longDescription": "This property shall contain the name of the power control function name.", "readonly": true, "type": [ "string", @@ -374,19 +374,19 @@ }, "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." }, "PhysicalContext": { "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext", - "description": "Describes the area, device, or set of devices to which this power control applies.", - "longDescription": "The value of this property shall be a description of the affected device(s) or region within the chassis to which this power control applies.", + "description": "The area, device, or set of devices to which this power control applies.", + "longDescription": "This property shall contain a description of the affected device(s) or region within the chassis to which this power control applies.", "readonly": true, "versionAdded": "v1_4_0" }, "PowerAllocatedWatts": { - "description": "The total amount of power that has been allocated (or budegeted)to chassis resources.", - "longDescription": "The value of this property shall represent the total power currently allocated to chassis resources.", + "description": "The total amount of power that has been allocated or budgeted to chassis.", + "longDescription": "This property shall represent the total power currently allocated or budgeted to the chassis.", "minimum": 0, "readonly": true, "type": [ @@ -396,8 +396,8 @@ "units": "W" }, "PowerAvailableWatts": { - "description": "The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.", - "longDescription": "The value of this property shall represent the amount of power capacity (in Watts) not already allocated and shall equal PowerCapacityWatts - PowerAllocatedWatts.", + "description": "The amount of reserve power capacity, in watts, that remains. This value is the PowerCapacity value minus the PowerAllocated value.", + "longDescription": "This property shall represent the amount of reserve power capacity, in watts, that remains. This value is the PowerCapacity value minus the PowerAllocated value.", "minimum": 0, "readonly": true, "type": [ @@ -407,8 +407,8 @@ "units": "W" }, "PowerCapacityWatts": { - "description": "The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.", - "longDescription": "The value of this property shall represent the total power capacity that is available for allocation to the chassis resources.", + "description": "The total amount of power that can be allocated to the chassis. This value can be either the power supply capacity or the power budget that an upstream chassis assigns to this chassis.", + "longDescription": "This property shall represent the total power capacity that can be allocated to the chassis.", "minimum": 0, "readonly": true, "type": [ @@ -418,8 +418,8 @@ "units": "W" }, "PowerConsumedWatts": { - "description": "The actual power being consumed by the chassis.", - "longDescription": "The value of this property shall represent the actual power being consumed (in Watts) by the chassis.", + "description": "The actual power that the chassis consumes, in watts.", + "longDescription": "This property shall represent the actual power that the chassis consumes, in watts.", "minimum": 0, "readonly": true, "type": [ @@ -430,17 +430,17 @@ }, "PowerLimit": { "$ref": "#/definitions/PowerLimit", - "description": "Power limit status and configuration information for this chassis.", - "longDescription": "This object shall contain power limit status and configuration information for this chassis." + "description": "The power limit status and configuration information for this chassis.", + "longDescription": "This property shall contain power limit status and configuration information for this chassis." }, "PowerMetrics": { "$ref": "#/definitions/PowerMetric", - "description": "Power readings for this chassis.", - "longDescription": "This object shall contain power metrics for power readings (interval, minimum/maximum/average power consumption) for the chassis." + "description": "The power readings for this chassis.", + "longDescription": "This property shall contain power metrics for power readings, such as interval, minimum, maximum, and average power consumption, for the chassis." }, "PowerRequestedWatts": { - "description": "The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.", - "longDescription": "The value of this property shall represent the amount of power (in Watts) that the chassis resource is currently requesting be budgeted to it for future use.", + "description": "The potential power, in watts, that the chassis requests, which may be higher than the current level being consumed because the requested power includes a budget that the chassis wants for future use.", + "longDescription": "This property shall represent the amount of power, in watts, that the chassis currently requests to be budgeted for future use.", "minimum": 0, "readonly": true, "type": [ @@ -450,21 +450,21 @@ "units": "W" }, "RelatedItem": { - "description": "The ID(s) of the resources associated with this Power Limit.", + "description": "An array of one or more IDs of the Resources associated with this power limit.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is being limited.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is being limited.", "readonly": true, "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -475,10 +475,10 @@ }, "PowerControlActions": { "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", @@ -494,8 +494,8 @@ "properties": { "Oem": { "$ref": "#/definitions/PowerControlOemActions", - "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_3_0" } }, @@ -503,10 +503,10 @@ }, "PowerControlOemActions": { "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", @@ -524,10 +524,10 @@ }, "PowerLimit": { "additionalProperties": false, - "description": "This object contains power limit status and configuration information for the chassis.", + "description": "The power limit status and configuration information for the chassis.", "longDescription": "This type shall contain power limit status and configuration information for this chassis.", "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", @@ -543,7 +543,7 @@ "properties": { "CorrectionInMs": { "description": "The time required for the limiting process to reduce power consumption to below the limit.", - "longDescription": "The value of this property shall represent the time interval in ms required for the limiting process to react and reduce the power consumption below the limit.", + "longDescription": "This property shall represent the time interval in ms required for the limiting process to react and reduce the power consumption below the limit.", "readonly": false, "type": [ "integer", @@ -561,12 +561,12 @@ } ], "description": "The action that is taken if the power cannot be maintained below the LimitInWatts.", - "longDescription": "The value of this property shall represent the action to be taken if the resource power consumption can not be limited below the specified limit after several correction time periods.", + "longDescription": "This property shall represent the action to be taken if the Resource power consumption cannot be limited below the specified limit after several correction time periods.", "readonly": false }, "LimitInWatts": { - "description": "The Power limit in watts. Set to null to disable power capping.", - "longDescription": "The value of this property shall represent the power cap limit in watts for the resource. If set to null, power capping shall be disabled.", + "description": "The power limit, in watts. If `null`, power capping is disabled.", + "longDescription": "This property shall represent the power capping limit, in watts, for the Resource. If `null`, power capping shall be disabled.", "minimum": 0, "readonly": false, "type": [ @@ -595,10 +595,10 @@ }, "PowerMetric": { "additionalProperties": false, - "description": "This type describe the power metrics for a resource.", - "longDescription": "This type shall contain power metrics for power readings (interval, minimum/maximum/average power consumption) for a resource.", + "description": "The power metrics for a Resource.", + "longDescription": "This type shall contain power metrics for power readings, such as interval, minimum, maximum, and average power consumption, for a 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", @@ -613,8 +613,8 @@ }, "properties": { "AverageConsumedWatts": { - "description": "The average power level over the measurement window (the last IntervalInMin minutes).", - "longDescription": "The value of this property shall represent the average power level that occured averaged over the last IntervalInMin minutes.", + "description": "The average power level over the measurement window over the last IntervalInMin minutes.", + "longDescription": "This property shall represent the average power level that occurred over the last IntervalInMin minutes.", "minimum": 0, "readonly": true, "type": [ @@ -624,8 +624,8 @@ "units": "W" }, "IntervalInMin": { - "description": "The time interval (or window) in which the PowerMetrics are measured over.", - "longDescription": "The value of this property shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over.", + "description": "The time interval, or window, over which the power metrics are measured.", + "longDescription": "This property shall represent the time interval or window, in minutes, over which the power metrics are measured.", "minimum": 0, "readonly": true, "type": [ @@ -635,8 +635,8 @@ "units": "min" }, "MaxConsumedWatts": { - "description": "The highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).", - "longDescription": "The value of this property shall represent the maximum power level in watts that occured within the last IntervalInMin minutes.", + "description": "The highest power consumption level, in watts, that has occurred over the measurement window within the last IntervalInMin minutes.", + "longDescription": "This property shall represent the maximum power level, in watts, that occurred within the last IntervalInMin minutes.", "minimum": 0, "readonly": true, "type": [ @@ -646,8 +646,8 @@ "units": "W" }, "MinConsumedWatts": { - "description": "The lowest power consumption level over the measurement window (the last IntervalInMin minutes).", - "longDescription": "The value of this property shall represent the minimum power level in watts that occured within the last IntervalInMin minutes.", + "description": "The lowest power consumption level, in watts, over the measurement window that occurred within the last IntervalInMin minutes.", + "longDescription": "This property shall represent the minimum power level, in watts, that occurred within the last IntervalInMin minutes.", "minimum": 0, "readonly": true, "type": [ @@ -663,7 +663,7 @@ "additionalProperties": false, "description": "Details of a power supplies associated with this system or device.", "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", @@ -678,24 +678,24 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/PowerSupplyActions", - "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_3_0" }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this power supply.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to the assembly Resource associated with this power supply.", + "longDescription": "This property shall contain a link to a Resource of type assembly.", "readonly": true, "versionAdded": "v1_5_0" }, "EfficiencyPercent": { - "description": "The measured efficiency of this Power Supply as a percentage.", - "longDescription": "This property shall contain the value of the measured power efficiency, as a percentage, of the associated power supply.", + "description": "The measured efficiency of this power supply as a percentage.", + "longDescription": "This property shall contain the measured power efficiency, as a percentage, of the associated power supply.", "maximum": 100, "minimum": 0, "readonly": true, @@ -707,7 +707,7 @@ "versionAdded": "v1_5_0" }, "FirmwareVersion": { - "description": "The firmware version for this Power Supply.", + "description": "The firmware version for this power supply.", "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the associated power supply.", "readonly": true, "type": [ @@ -716,8 +716,8 @@ ] }, "HotPluggable": { - "description": "Indicates if this device can be inserted or removed while the equipment is in operation.", - "longDescription": "The value of this property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.", + "description": "An indication of whether this device can be inserted or removed while the equipment is in operation.", + "longDescription": "This property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.", "readonly": true, "type": [ "boolean", @@ -734,23 +734,23 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify the power supply.", - "longDescription": "The value of this property shall contain the indicator light state for the indicator light associated with this power supply.", + "description": "The state of The indicator LED, which identifies the power supply.", + "longDescription": "This property shall contain the indicator light state for the indicator light associated with this power supply.", "readonly": false, "versionAdded": "v1_2_0" }, "InputRanges": { - "description": "This is the input ranges that the power supply can use.", + "description": "The input ranges that the power supply can use.", "items": { "$ref": "#/definitions/InputRange" }, - "longDescription": "The value of this property shall be a collection of ranges usable by the power supply unit.", + "longDescription": "This property shall contain a collection of ranges usable by the power supply unit.", "type": "array", "versionAdded": "v1_1_0" }, "LastPowerOutputWatts": { - "description": "The average power output of this Power Supply.", - "longDescription": "This property shall contain the average power output, measured in Watts, of the associated power supply.", + "description": "The average power output of this power supply.", + "longDescription": "This property shall contain the average power output, measured in watts, of the associated power supply.", "minimum": 0, "readonly": true, "type": [ @@ -760,7 +760,7 @@ "units": "W" }, "LineInputVoltage": { - "description": "The line input voltage at which the Power Supply is operating.", + "description": "The line input voltage at which the power supply is operating.", "longDescription": "This property shall contain the value in Volts of the line input voltage (measured or configured for) that the power supply has been configured to operate with or is currently receiving.", "readonly": true, "type": [ @@ -778,19 +778,19 @@ "type": "null" } ], - "description": "The line voltage type supported as an input to this Power Supply.", + "description": "The line voltage type supported as an input to this power supply.", "longDescription": "This property shall contain the type of input line voltage supported by the associated power supply.", "readonly": true }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the power supply.", + "description": "The location of the power supply.", "longDescription": "This property shall contain location information of the associated power supply.", "versionAdded": "v1_5_0" }, "Manufacturer": { - "description": "This is the manufacturer of this power supply.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the power supply. This organization might be the entity from whom the power supply is purchased, but this is not necessarily true.", + "description": "The manufacturer of this power supply.", + "longDescription": "This property shall contain the name of the organization responsible for producing the power supply. This organization might be the entity from whom the power supply is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -799,13 +799,13 @@ "versionAdded": "v1_1_0" }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "Model": { - "description": "The model number for this Power Supply.", + "description": "The model number for this power supply.", "longDescription": "This property shall contain the model information as defined by the manufacturer for the associated power supply.", "readonly": true, "type": [ @@ -814,7 +814,7 @@ ] }, "Name": { - "description": "The name of the Power Supply.", + "description": "The name of the power supply.", "longDescription": "This property shall contain a descriptive name for the associated power supply.", "readonly": true, "type": [ @@ -824,11 +824,11 @@ }, "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." }, "PartNumber": { - "description": "The part number for this Power Supply.", + "description": "The part number for this power supply.", "longDescription": "This property shall contain the part number as defined by the manufacturer for the associated power supply.", "readonly": true, "type": [ @@ -837,8 +837,8 @@ ] }, "PowerCapacityWatts": { - "description": "The maximum capacity of this Power Supply.", - "longDescription": "This property shall contiain the maximum amount of power, in Watts, that the associated power supply is rated to deliver.", + "description": "The maximum capacity of this power supply.", + "longDescription": "This property shall contain the maximum amount of power, in watts, that the associated power supply is rated to deliver.", "minimum": 0, "readonly": true, "type": [ @@ -848,8 +848,8 @@ "units": "W" }, "PowerInputWatts": { - "description": "The measured input power of this Power Supply.", - "longDescription": "This property shall contain the value of the measured input power, in Watts, of the associated power supply.", + "description": "The measured input power of this power supply.", + "longDescription": "This property shall contain the measured input power, in watts, of the associated power supply.", "minimum": 0, "readonly": true, "type": [ @@ -860,8 +860,8 @@ "versionAdded": "v1_5_0" }, "PowerOutputWatts": { - "description": "The measured output power of this Power Supply.", - "longDescription": "This property shall contain the value of the measured output power, in Watts, of the associated power supply.", + "description": "The measured output power of this power supply.", + "longDescription": "This property shall contain the measured output power, in watts, of the associated power supply.", "minimum": 0, "readonly": true, "type": [ @@ -880,34 +880,34 @@ "type": "null" } ], - "description": "The Power Supply type (AC or DC).", + "description": "The power supply type (AC or DC).", "longDescription": "This property shall contain the input power type (AC or DC) of the associated power supply.", "readonly": true }, "Redundancy": { - "description": "This structure is used to show redundancy for power supplies. The Component ids will reference the members of the redundancy groups.", + "description": "The set of redundancy groups for this power supply.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show redundancy for power supplies and other elements in this resource. The use of IDs within these arrays shall reference the members of the redundancy groups.", + "longDescription": "This property shall contain an array of links to the redundancy groups to which this power supply belongs.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "RelatedItem": { - "description": "The ID(s) of the resources associated with this Power Limit.", + "description": "The ID(s) of the Resources associated with this power limit.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is being limited.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is being limited.", "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SerialNumber": { - "description": "The serial number for this Power Supply.", + "description": "The serial number for this power supply.", "longDescription": "This property shall contain the serial number as defined by the manufacturer for the associated power supply.", "readonly": true, "type": [ @@ -916,7 +916,7 @@ ] }, "SparePartNumber": { - "description": "The spare part number for this Power Supply.", + "description": "The spare part number for this power supply.", "longDescription": "This property shall contain the spare or replacement part number as defined by the manufacturer for the associated power supply.", "readonly": true, "type": [ @@ -926,8 +926,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -938,10 +938,10 @@ }, "PowerSupplyActions": { "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", @@ -957,8 +957,8 @@ "properties": { "Oem": { "$ref": "#/definitions/PowerSupplyOemActions", - "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_3_0" } }, @@ -966,10 +966,10 @@ }, "PowerSupplyOemActions": { "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", @@ -994,7 +994,7 @@ ], "enumDescriptions": { "AC": "Alternating Current (AC) power supply.", - "ACorDC": "Power Supply supports both DC or AC.", + "ACorDC": "The power supply supports both DC or AC.", "DC": "Direct Current (DC) power supply.", "Unknown": "The power supply type cannot be determined." }, @@ -1003,7 +1003,7 @@ "Voltage": { "additionalProperties": false, "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", @@ -1018,17 +1018,17 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/VoltageActions", - "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_3_0" }, "LowerThresholdCritical": { - "description": "Below normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the present reading is below the normal range but is not yet fatal. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "The value at which the reading is below normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the ReadingVolts property is below the normal range but is not yet fatal. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1037,8 +1037,8 @@ "units": "V" }, "LowerThresholdFatal": { - "description": "Below normal range and is fatal.", - "longDescription": "The value of this property shall indicate the present reading is below the normal range and is fatal. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "The value at which the reading is below normal range and fatal.", + "longDescription": "This property shall contain the value at which the ReadingVolts property is below the normal range and is fatal. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1047,8 +1047,8 @@ "units": "V" }, "LowerThresholdNonCritical": { - "description": "Below normal range.", - "longDescription": "The value of this property shall indicate the present reading is below the normal range but is not critical. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "The value at which the reading is below normal range.", + "longDescription": "This property shall contain the value at which the ReadingVolts property is below normal range. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1057,8 +1057,8 @@ "units": "V" }, "MaxReadingRange": { - "description": "Maximum value for this Voltage sensor.", - "longDescription": "The value of this property shall indicate the highest possible value for ReadingVolts. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "Maximum value for this sensor.", + "longDescription": "This property shall indicate the highest possible value for the ReadingVolts property. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1067,14 +1067,14 @@ "units": "V" }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "MinReadingRange": { - "description": "Minimum value for this Voltage sensor.", - "longDescription": "The value of this property shall indicate the lowest possible value for ReadingVolts. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "Minimum value for this sensor.", + "longDescription": "This property shall indicate the lowest possible value for the ReadingVolts property. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1084,7 +1084,7 @@ }, "Name": { "description": "Voltage sensor name.", - "longDescription": "The value of this property shall be the name of the Voltage sensor.", + "longDescription": "This property shall contain the name of the Voltage sensor.", "readonly": true, "type": [ "string", @@ -1093,18 +1093,18 @@ }, "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." }, "PhysicalContext": { "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext", - "description": "Describes the area or device to which this voltage measurement applies.", - "longDescription": "The value of this property shall be a description of the affected device or region within the chassis to which this voltage measurement applies.", + "description": "The area or device to which this voltage measurement applies.", + "longDescription": "This property shall contain a description of the affected device or region within the chassis to which this voltage measurement applies.", "readonly": true }, "ReadingVolts": { - "description": "The present reading of the voltage sensor.", - "longDescription": "The value of this property shall be the present reading of the voltage sensor's reading.", + "description": "The reading of the voltage sensor.", + "longDescription": "This property shall contain the voltage sensor's reading.", "readonly": true, "type": [ "number", @@ -1113,20 +1113,20 @@ "units": "V" }, "RelatedItem": { - "description": "Describes the areas or devices to which this voltage measurement applies.", + "description": "The areas or devices to which this voltage measurement applies.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the areas or devices to which this voltage measurement applies.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the areas or devices to which this voltage measurement applies.", "readonly": true, "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SensorNumber": { "description": "A numerical identifier to represent the voltage sensor.", - "longDescription": "The value of this property shall be a numerical identifier for this voltage sensor that is unique within this resource.", + "longDescription": "This property shall contain a numerical identifier for this voltage sensor that is unique within this Resource.", "readonly": true, "type": [ "integer", @@ -1135,12 +1135,12 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UpperThresholdCritical": { - "description": "Above normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the present reading is above the normal range but is not yet fatal. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "The value at which the reading is above normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the ReadingVolts property is above the normal range but is not yet fatal. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1149,8 +1149,8 @@ "units": "V" }, "UpperThresholdFatal": { - "description": "Above normal range and is fatal.", - "longDescription": "The value of this property shall indicate the present reading is above the normal range and is fatal. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "The value at which the reading is above normal range and fatal.", + "longDescription": "This property shall contain the value at which the ReadingVolts property is above the normal range and is fatal. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1159,8 +1159,8 @@ "units": "V" }, "UpperThresholdNonCritical": { - "description": "Above normal range.", - "longDescription": "The value of this property shall indicate the present reading is above the normal range but is not critical. Units shall use the same units as the related ReadingVolts propoerty.", + "description": "The value at which the reading is above normal range.", + "longDescription": "This property shall contain the value at which the ReadingVolts property is above the normal range. The value of the property shall use the same units as the ReadingVolts property.", "readonly": true, "type": [ "number", @@ -1177,10 +1177,10 @@ }, "VoltageActions": { "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", @@ -1196,8 +1196,8 @@ "properties": { "Oem": { "$ref": "#/definitions/VoltageOemActions", - "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_3_0" } }, @@ -1205,10 +1205,10 @@ }, "VoltageOemActions": { "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", @@ -1227,5 +1227,5 @@ }, "owningEntity": "DMTF", "release": "2017.3", - "title": "#Power.v1_5_2.Power" + "title": "#Power.v1_5_4.Power" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json b/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json index 596100fc18..b50a7997be 100644 --- a/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json +++ b/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/PrivilegeRegistry.v1_1_4.json", "$ref": "#/definitions/PrivilegeRegistry", "$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,18 +25,19 @@ "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" }, "Mapping": { "additionalProperties": false, - "description": "This type describes a mapping between an entity and the relevant privileges used to access it.", - "longDescription": "This type shall describe a mapping between an entity and the relevant privileges used to access it.", + "description": "The mapping between a Resource type and the relevant privileges that accesses the Resource.", + "longDescription": "This type shall describe a mapping between a Resource type and the relevant privileges that accesses the 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,59 +52,38 @@ }, "properties": { "Entity": { - "description": "Indicates entity name. e.g., Manager.", - "longDescription": "Indicates entity name. e.g., Manager.", + "description": "The Resource name, such as `Manager`.", + "longDescription": "This property shall contain the Resource name, such as `Manager`.", "readonly": true, "type": "string" }, "OperationMap": { "$ref": "#/definitions/OperationMap", - "description": "List mapping between HTTP method and privilege required for entity.", - "longDescription": "List mapping between HTTP method and privilege required for entity." + "description": "List mapping between HTTP methods and privilege required for the Resource.", + "longDescription": "This property shall list the mapping between HTTP methods and the privilege required for the Resource." }, "PropertyOverrides": { - "description": "Indicates privilege overrides of property or element within a entity.", + "description": "The privilege overrides of properties within a Resource.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Target_PrivilegeMap" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Target_PrivilegeMap" }, - "longDescription": "Indicates privilege overrides of property or element. e.g., password property.", + "longDescription": "This property shall contain the privilege overrides of properties, such as the `Password` property in the `ManagerAccount` Resource.", "type": "array" }, "ResourceURIOverrides": { - "description": "Indicates privilege overrides of Resource URI.", + "description": "The privilege overrides of Resource URIs.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Target_PrivilegeMap" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Target_PrivilegeMap" }, - "longDescription": "Indicates privilege overrides of Resource URI. Target lists Resource URI.", + "longDescription": "This property shall contain the privilege overrides of Resource URIs. The target lists the Resource URI and the new privileges.", "type": "array" }, "SubordinateOverrides": { - "description": "Indicates privilege overrides of subordinate resource.", + "description": "The privilege overrides of the subordinate Resource.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Target_PrivilegeMap" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Target_PrivilegeMap" }, - "longDescription": "Indicates privilege overrides of subordinate resource. Target lists referenced by Entity.", + "longDescription": "This property shall contain the privilege overrides of the subordinate Resource. The target lists are identified by Resource type.", "type": "array" } }, @@ -110,10 +91,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", @@ -131,10 +112,10 @@ }, "OperationMap": { "additionalProperties": false, - "description": "Used for describing the specific privileges for a set of HTTP operations.", - "longDescription": "This type shall describe the specific privileges required for a set of HTTP operations.", + "description": "The specific privileges required to complete a set of HTTP operations.", + "longDescription": "This type shall describe the specific privileges required to complete a set of HTTP operations.", "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", @@ -149,51 +130,51 @@ }, "properties": { "DELETE": { - "description": "Indicates privilege required for HTTP DELETE operation.", + "description": "The privilege required to complete an HTTP DELETE operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP DELETE operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP DELETE operation.", "type": "array" }, "GET": { - "description": "Indicates privilege required for HTTP GET operation.", + "description": "The privilege required to complete an HTTP GET operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP GET operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP GET operation.", "type": "array" }, "HEAD": { - "description": "Indicates privilege required for HTTP HEAD operation.", + "description": "The privilege required to complete an HTTP HEAD operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP HEAD operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP HEAD operation.", "type": "array" }, "PATCH": { - "description": "Indicates privilege required for HTTP PATCH operation.", + "description": "The privilege required to complete an HTTP PATCH operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP PATCH operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP PATCH operation.", "type": "array" }, "POST": { - "description": "Indicates privilege required for HTTP POST operation.", + "description": "The privilege required to complete an HTTP POST operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP POST operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP POST operation.", "type": "array" }, "PUT": { - "description": "Indicates privilege required for HTTP PUT operation.", + "description": "The privilege required to complete an HTTP PUT operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP PUT operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP PUT operation.", "type": "array" } }, @@ -201,10 +182,10 @@ }, "OperationPrivilege": { "additionalProperties": false, - "description": "Used for describing the specific privileges for a given type of HTTP operation.", - "longDescription": "This type shall describe the specific privileges required for a given type of HTTP operation.", + "description": "The privileges for a specific HTTP operation.", + "longDescription": "This type shall describe the privileges required to complete a specific HTTP operation.", "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", @@ -219,11 +200,11 @@ }, "properties": { "Privilege": { - "description": "Lists the privileges that are allowed to perform the given type of HTTP operation on the entity type.", + "description": "An array of privileges that are required to complete a specific HTTP operation on a Resource.", "items": { "type": "string" }, - "longDescription": "This array shall contain a set of strings that match 0 or more of the strings found in the PrivilegesUsed and OEMPrivilegesUsed properties.", + "longDescription": "This array shall contain an array of privileges that are required to complete a specific HTTP operation on a Resource. This set of strings match zero or more strings in the PrivilegesUsed and OEMPrivilegesUsed properties.", "readonly": true, "type": "array" } @@ -232,10 +213,10 @@ }, "PrivilegeRegistry": { "additionalProperties": false, - "description": "This is the schema definition for Operation to Privilege mapping.", - "longDescription": "This resource shall be used to represent operation to privilege mappings.", + "description": "The PrivilegeRegistry schema describes the operation-to-privilege mappings.", + "longDescription": "This Resource contains operation-to-privilege mappings.", "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", @@ -249,22 +230,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": [ @@ -282,11 +255,11 @@ "readonly": true }, "Mappings": { - "description": "This property describes the mappings between entities and the relevant privileges used to access them.", + "description": "The mappings between entities and the relevant privileges that access those entities.", "items": { "$ref": "#/definitions/Mapping" }, - "longDescription": "This property shall describe the mappings between entities and the relevant privileges used to access them.", + "longDescription": "This property shall describe the mappings between entities and the relevant privileges that access those entities.", "type": "array" }, "Name": { @@ -294,31 +267,30 @@ "readonly": true }, "OEMPrivilegesUsed": { - "description": "Lists the set of OEM Priviliges used in building this mapping.", + "description": "The set of OEM privileges used in this mapping.", "items": { "type": "string" }, - "longDescription": "This property shall be an array that contains the set of OEM Priviliges used in building this mapping.", + "longDescription": "This property shall contain an array of OEM privileges used in this mapping.", "readonly": true, "type": "array" }, "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." }, "PrivilegesUsed": { - "description": "Lists the set of Redfish standard priviliges used in building this mapping.", + "description": "The set of Redfish standard privileges used in this mapping.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType" }, - "longDescription": "This property shall be an array that contains the set of Redfish standard priviliges used in building this mapping.", + "longDescription": "This property shall contain an array of Redfish standard privileges used in this mapping.", "readonly": true, "type": "array" } }, "required": [ - "@odata.id", "@odata.type", "Id", "Name" @@ -330,7 +302,7 @@ "description": "This type describes a mapping between one or more targets and the HTTP operations associated with them.", "longDescription": "This type shall describe a mapping between one or more targets and the HTTP operations associated with them.", "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", @@ -345,26 +317,19 @@ }, "properties": { "OperationMap": { - "anyOf": [ - { - "$ref": "#/definitions/OperationMap" - }, - { - "type": "null" - } - ], - "description": "List mapping between HTTP operation and privilege needed to perform operation.", - "longDescription": "List mapping between HTTP operation and privilege needed to perform operation." + "$ref": "#/definitions/OperationMap", + "description": "The mapping between the HTTP operation and the privilege required to complete the operation.", + "longDescription": "This property shall contain the mapping between the HTTP operation and the privilege required to complete the operation." }, "Targets": { - "description": "Indicates the URI or Entity.", + "description": "The set of URIs, Resource types, or properties.", "items": { "type": [ "string", "null" ] }, - "longDescription": "Indicates the set of URI(s) or Entity(s) or property(s). e.g./redfish/v1/Systems/1, Manager, Password. When targets property is not mentioned, then there is no override.", + "longDescription": "This property shall contain the array of URIs, Resource types, or properties. For example, `/redfish/v1/Systems/1`, `Manager`, or `Password`. When the Targets property is not present, no override is specified.", "readonly": true, "type": "array" } @@ -373,5 +338,6 @@ } }, "owningEntity": "DMTF", - "title": "#PrivilegeRegistry.v1_1_2.PrivilegeRegistry" + "release": "2017.1", + "title": "#PrivilegeRegistry.v1_1_4.PrivilegeRegistry" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Privileges/Privileges.json b/static/redfish/v1/JsonSchemas/Privileges/Privileges.json index bd2265d6d7..56e88ecd7d 100644 --- a/static/redfish/v1/JsonSchemas/Privileges/Privileges.json +++ b/static/redfish/v1/JsonSchemas/Privileges/Privileges.json @@ -1,25 +1,9 @@ { - "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json", - "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", - "definitions": { - "PrivilegeType": { - "deprecated": "This definition has been moved to the unversioned namespace so that external references can pick up changes over time.", - "enum": [ - "Login", - "ConfigureManager", - "ConfigureUsers", - "ConfigureSelf", - "ConfigureComponents" - ], - "enumDescriptions": { - "ConfigureComponents": "Able to configure components managed by this service.", - "ConfigureManager": "Able to configure Manager resources.", - "ConfigureSelf": "Able to change the password for the current user Account.", - "ConfigureUsers": "Able to configure Users and their Accounts.", - "Login": "Able to log into the service and read resources." - }, - "type": "string" - } - }, - "title": "#Privileges.v1_0_4" + "$id": "http://redfish.dmtf.org/schemas/v1/Privileges.v1_0_5.json", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "definitions": {}, + "owningEntity": "DMTF", + "release": "1.0", + "title": "#Privileges.v1_0_5" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Processor/Processor.json b/static/redfish/v1/JsonSchemas/Processor/Processor.json index 3c7997ea56..508bbdca29 100644 --- a/static/redfish/v1/JsonSchemas/Processor/Processor.json +++ b/static/redfish/v1/JsonSchemas/Processor/Processor.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Processor.v1_4_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Processor.v1_5_1.json", "$ref": "#/definitions/Processor", "$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 @@ }, "EthernetInterface": { "additionalProperties": false, - "description": "This is the definition for an Ethernet Interface object.", - "longDescription": "These properties shall be the definition for an Ethernet Interface for a Redfish implementation.", + "description": "This type defines an Ethernet interface.", + "longDescription": "These properties shall contain the definition for an Ethernet interface 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", @@ -52,8 +52,8 @@ }, "properties": { "MaxLanes": { - "description": "This is the number of lanes supported by this interface.", - "longDescription": "The value of this property shall be the maximum number of lanes supported by this interface.", + "description": "The number of lanes supported by this interface.", + "longDescription": "This property shall contain the maximum number of lanes supported by this interface.", "readonly": true, "type": [ "integer", @@ -63,7 +63,7 @@ }, "MaxSpeedMbps": { "description": "The maximum speed supported by this interface.", - "longDescription": "The value of this property shall be the maximum speed supported by this interface.", + "longDescription": "This property shall contain the maximum speed supported by this interface.", "readonly": true, "type": [ "integer", @@ -74,8 +74,8 @@ }, "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_4_0" } }, @@ -84,9 +84,9 @@ "FPGA": { "additionalProperties": false, "description": "The properties of the FPGA device.", - "longDescription": "This object shall contain the properties of the FPGA device represented by a Processor.", + "longDescription": "This object shall contain the properties of the FPGA device represented by a processor.", "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", @@ -105,27 +105,27 @@ "items": { "$ref": "#/definitions/FpgaInterface" }, - "longDescription": "The value of this property shall be an array of objects that describe the external connectivity of the FPGA.", + "longDescription": "This property shall contain an array of objects that describe the external connectivity of the FPGA.", "type": "array", "versionAdded": "v1_4_0" }, "FirmwareId": { "description": "The FPGA firmware identifier.", - "longDescription": "The value of this property shall contain a string decsribing the FPGA firmware identifier.", + "longDescription": "This property shall contain a string decsribing the FPGA firmware identifier.", "readonly": true, "type": "string", "versionAdded": "v1_4_0" }, "FirmwareManufacturer": { "description": "The FPGA firmware manufacturer.", - "longDescription": "The value of this property shall contain a string decsribing the FPGA firmware manufacturer.", + "longDescription": "This property shall contain a string decsribing the FPGA firmware manufacturer.", "readonly": true, "type": "string", "versionAdded": "v1_4_0" }, "FirmwareVersion": { "description": "The FPGA firmware version.", - "longDescription": "The value of this property shall contain a string decsribing the FPGA firmware version.", + "longDescription": "This property shall contain a string decsribing the FPGA firmware version.", "readonly": true, "type": "string", "versionAdded": "v1_4_0" @@ -133,39 +133,39 @@ "FpgaType": { "$ref": "#/definitions/FpgaType", "description": "The FPGA type.", - "longDescription": "The value of this property shall be a type of the FPGA device.", + "longDescription": "This property shall contain a type of the FPGA device.", "readonly": true, "versionAdded": "v1_4_0" }, "HostInterface": { "$ref": "#/definitions/FpgaInterface", "description": "The FPGA interface to the host.", - "longDescription": "The value of this property shall be an object that describes the connectivity to the host for system software to use.", + "longDescription": "This property shall contain an object that describes the connectivity to the host for system software to use.", "versionAdded": "v1_4_0" }, "Model": { "description": "The FPGA model.", - "longDescription": "The value of this property shall be a model of the FPGA device.", + "longDescription": "This property shall contain a model of the FPGA device.", "readonly": true, "type": "string", "versionAdded": "v1_4_0" }, "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_4_0" }, "PCIeVirtualFunctions": { "description": "The number of the PCIe Virtual Functions.", - "longDescription": "The value of this property shall be an integer that describes the number of PCIe Virtual Functions configured within the FPGA.", + "longDescription": "This property shall contain an integer that describes the number of PCIe Virtual Functions configured within the FPGA.", "readonly": false, "type": "integer", "versionAdded": "v1_4_0" }, "ProgrammableFromHost": { - "description": "This flag indicates if the FPGA firmware can be reprogrammed from the host using system software.", - "longDescription": "The value of this property shall indicate whether the FPGA firmware can be reprogrammed from the host using system software. If set to false, system software shall not be able to program the FPGA firmware from the host interface. In either state, a management controller may be able to program the FPGA firmware using the sideband interface.", + "description": "An indication of whether the FPGA firmware can be reprogrammed from the host by using system software.", + "longDescription": "This property shall indicate whether the FPGA firmware can be reprogrammed from the host by using system software. If false, system software shall not be able to program the FPGA firmware from the system interface. In either state, a management controller may be able to program the FPGA firmware by using the sideband interface.", "readonly": false, "type": [ "boolean", @@ -174,11 +174,11 @@ "versionAdded": "v1_4_0" }, "ReconfigurationSlots": { - "description": "An array of the FPGA reconfiguration slots. A reconfiguration slot is used by an FPGA to contain an acceleration function that can change as the FPGA is being provisioned.", + "description": "An array of the FPGA reconfiguration slots. An FPGA uses a reconfiguration slot to contain an acceleration function that can change as the FPGA is provisioned.", "items": { "$ref": "#/definitions/FpgaReconfigurationSlot" }, - "longDescription": "The value of this property shall be an array of the structures describing the FPGA reconfiguration slots that can be programmed with the acceleration functions.", + "longDescription": "This property shall contain an array of the structures that describe the FPGA reconfiguration slots that the acceleration functions can program.", "type": "array", "versionAdded": "v1_4_0" } @@ -190,7 +190,7 @@ "description": "This type describes an interface to the FPGA.", "longDescription": "This type shall contain information about the interface to the FPGA.", "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", @@ -205,16 +205,9 @@ }, "properties": { "Ethernet": { - "anyOf": [ - { - "$ref": "#/definitions/EthernetInterface" - }, - { - "type": "null" - } - ], - "description": "Describes the Ethernet related information about this FPGA interface.", - "longDescription": "The value of this property shall be an object the describes the Ethernet related information about this FPGA interface.", + "$ref": "#/definitions/EthernetInterface", + "description": "The Ethernet-related information for this FPGA interface.", + "longDescription": "This property shall contain an object the describes the Ethernet-related information for this FPGA interface.", "versionAdded": "v1_4_0" }, "InterfaceType": { @@ -227,21 +220,14 @@ } ], "description": "The FPGA interface type.", - "longDescription": "The value of this property shall be an enum that describes the type of interface to the FPGA.", + "longDescription": "This property shall contain an enumerated value that describes the type of interface to the FPGA.", "readonly": true, "versionAdded": "v1_4_0" }, "PCIe": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface" - }, - { - "type": "null" - } - ], - "description": "Describes the PCI-e related information about this FPGA interface.", - "longDescription": "The value of this property shall be an object the describes the PCI-e related information about this FPGA interface.", + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface", + "description": "The PCIe-related information for this FPGA interface.", + "longDescription": "This property shall contain an object the describes the PCIe-related information for this FPGA interface.", "versionAdded": "v1_4_0" } }, @@ -257,7 +243,7 @@ ], "enumDescriptions": { "Ethernet": "An Ethernet interface.", - "OEM": "An OEM defined interface.", + "OEM": "An OEM-defined interface.", "PCIe": "A PCI Express interface.", "QPI": "The Intel QuickPath Interconnect.", "UPI": "The Intel UltraPath Interconnect." @@ -266,10 +252,10 @@ }, "FpgaReconfigurationSlot": { "additionalProperties": false, - "description": "This type describes the FPGA reconfiguration slot. A reconfiguration slot is used by an FPGA to contain an acceleration function that can change as the FPGA is being provisioned.", + "description": "This type describes the FPGA reconfiguration slot. An FPGA uses a reconfiguration slot to contain an acceleration function that can change as the FPGA is provisioned.", "longDescription": "This type shall contain information about the FPGA reconfiguration slot.", "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", @@ -284,22 +270,15 @@ }, "properties": { "AccelerationFunction": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/AccelerationFunction.json#/definitions/AccelerationFunction" - }, - { - "type": "null" - } - ], - "description": "A link to the Acceleration Function provided by the code programmed into a reconfiguration slot.", - "longDescription": "The value of this property shall be a reference to the acceleration function resources provided by the code programmed into a reconfiguration slot and shall reference a resource of type AccelerationFunction.", + "$ref": "http://redfish.dmtf.org/schemas/v1/AccelerationFunction.json#/definitions/AccelerationFunction", + "description": "The link to the acceleration function that the code programmed into a reconfiguration slot provides.", + "longDescription": "This property shall contain a link to the acceleration function that the code programmed into a reconfiguration slot provides. It shall link to a Resource of type AccelerationFunction.", "readonly": true, "versionAdded": "v1_4_0" }, "ProgrammableFromHost": { - "description": "This flag indicates if the reconfiguration slot can be reprogrammed from the host using system software.", - "longDescription": "The value of this property shall indicate whether the reconfiguration slot can be reprogrammed from the host using system software. If set to false, system software shall not be able to program the reconfiguration slot from the host interface. In either state, a management controller may be able to program the reconfiguration slot using the sideband interface.", + "description": "An indication of whether the reconfiguration slot can be reprogrammed from the host by using system software.", + "longDescription": "This property shall indicate whether the reconfiguration slot can be reprogrammed from the host by using system software. If false, system software shall not be able to program the reconfiguration slot from the system interface. In either state, a management controller may be able to program the reconfiguration slot by using the sideband interface.", "readonly": false, "type": [ "boolean", @@ -309,7 +288,7 @@ }, "SlotId": { "description": "The FPGA reconfiguration slot identifier.", - "longDescription": "The value of this property shall be the FPGA reconfiguration slot identifier.", + "longDescription": "This property shall contain the FPGA reconfiguration slot identifier.", "readonly": true, "type": [ "string", @@ -326,8 +305,8 @@ "type": "null" } ], - "description": "The universal unique identifier (UUID) for this reconfiguration slot.", - "longDescription": "The value of this property shall be used to contain a universal unique identifier number for the reconfiguration slot.", + "description": "The UUID for this reconfiguration slot.", + "longDescription": "This property shall contain a universal unique identifier number for the reconfiguration slot.", "readonly": true, "versionAdded": "v1_4_0" } @@ -341,7 +320,7 @@ ], "enumDescriptions": { "Discrete": "The discrete FPGA device.", - "Integrated": "The FPGA device integrasted with other porcessor in the single chip." + "Integrated": "The FPGA device integrasted with other processor in the single chip." }, "type": "string" }, @@ -375,10 +354,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -394,78 +373,71 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the Chassis which contains this Processor.", - "longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Processor.", + "description": "The link to the chassis that contains this processor.", + "longDescription": "This property shall contain a link to a Resource of type chassis that represents the physical container associated with this processor.", "readonly": true, "versionAdded": "v1_1_0" }, "ConnectedProcessors": { - "description": "An array of references to the processors directly connected to this processor.", + "description": "An array of links to the processors directly connected to this processor.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor" }, - "longDescription": "The value of this property shall be an array of references of type Processor that are directly connected to this Processor.", + "longDescription": "This property shall contain an array of links of the Processor type that are directly connected to this Processor.", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "ConnectedProcessors@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Endpoints": { - "description": "An array of references to the endpoints that connect to this processor.", + "description": "An array of links to the endpoints that connect to this processor.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be an array of references of type Endpoint that represent Endpoints accociated with this Processor.", + "longDescription": "This property shall contain an array of links of the Endpoint type that represent endpoints accociated with this Processor.", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "PCIeDevice": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" - }, - { - "type": "null" - } - ], - "description": "A reference to the PCIeDevice associated with this Processor.", - "longDescription": "The value of this property shall be a reference of type PCIeDevice that represents the PCI-e Device associated with this Processor.", + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice", + "description": "The link to the PCIe device associated with this processor.", + "longDescription": "This property shall contain a link of the PCIeDevice type that represents the PCIe device associated with this processor.", "readonly": true, "versionAdded": "v1_4_0" }, "PCIeFunctions": { - "description": "An array of references to the PCIeFunctions associated with this Processor.", + "description": "An array of links to the PCIeFunctions associated with this Processor.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction" }, - "longDescription": "The value of this property shall be an array of references of type PCIeFunction that represent the PCI-e Functions associated with this Processor.", + "longDescription": "This property shall contain an array of links of the PCIeFunction type that represent the PCIe functions associated with this Processor.", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "PCIeFunctions@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -483,10 +455,10 @@ }, "Processor": { "additionalProperties": false, - "description": "This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.", - "longDescription": "This resource shall be used to represent a single processor contained within a system.", + "description": "The Processor schema describes the information about a single processor that a system contains. A processor includes both performance characteristics, clock speed, architecture, core count, and so on, and compatibility, such as the CPU ID instruction results.", + "longDescription": "This Resource shall represent a single processor that a system contains. A processor includes both performance characteristics, clock speed, architecture, core count, and so on, and compatibility, such as the CPU ID instruction results.", "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", @@ -501,34 +473,34 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AccelerationFunctions": { "$ref": "http://redfish.dmtf.org/schemas/v1/AccelerationFunctionCollection.json#/definitions/AccelerationFunctionCollection", - "description": "A reference to the collection of Acceleration Functions associated with this Processor.", - "longDescription": "The value of this property shall be a link to a collection of type AccelerationFunctionCollection.", + "description": "The link to the collection of acceleration functions associated with this processor.", + "longDescription": "This property shall contain a link to a Resource Collection of type AccelerationFunctionCollection.", "readonly": true, "versionAdded": "v1_4_0" }, "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" }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this processor.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to an assembly associated with this processor.", + "longDescription": "This property shall contain a link to a Resource of type assembly.", "readonly": true, "versionAdded": "v1_2_0" }, @@ -544,16 +516,9 @@ "readonly": true }, "FPGA": { - "anyOf": [ - { - "$ref": "#/definitions/FPGA" - }, - { - "type": "null" - } - ], - "description": "The properties specific for Processors of type FPGA.", - "longDescription": "The value of this property shall be an object containing properties specific for Processors of type FPGA.", + "$ref": "#/definitions/FPGA", + "description": "The properties for processors of the FPGA type.", + "longDescription": "This property shall contain an object containing properties for processors of the FPGA type.", "versionAdded": "v1_4_0" }, "Id": { @@ -570,24 +535,24 @@ } ], "description": "The instruction set of the processor.", - "longDescription": "This property shall contain the string which identifies the instruction set of the processor contained in this socket.", + "longDescription": "This property shall contain the string that identifies the instruction set of the processor contained in this socket.", "readonly": true }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", "versionAdded": "v1_1_0" }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the processor.", + "description": "The location of the processor.", "longDescription": "This property shall contain location information of the associated processor.", "versionAdded": "v1_2_0" }, "Manufacturer": { "description": "The processor manufacturer.", - "longDescription": "This property shall contain a string which identifies the manufacturer of the processor.", + "longDescription": "This property shall contain a string that identifies the manufacturer of the processor.", "readonly": true, "type": [ "string", @@ -606,7 +571,7 @@ }, "MaxTDPWatts": { "description": "The maximum Thermal Design Power (TDP) in watts.", - "longDescription": "The value of this property shall be the maximum Thermal Design Power (TDP) in watts.", + "longDescription": "This property shall contain the maximum Thermal Design Power (TDP) in watts.", "readonly": true, "type": [ "integer", @@ -616,16 +581,9 @@ "versionAdded": "v1_4_0" }, "Metrics": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.json#/definitions/ProcessorMetrics" - }, - { - "type": "null" - } - ], - "description": "A reference to the Metrics associated with this Processor.", - "longDescription": "This property shall be a reference to the Metrics associated with this Processor.", + "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.json#/definitions/ProcessorMetrics", + "description": "The link to the metrics associated with this processor.", + "longDescription": "This property shall contain a link to the metrics associated with this processor.", "readonly": true, "versionAdded": "v1_4_0" }, @@ -644,8 +602,8 @@ }, "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." }, "ProcessorArchitecture": { "anyOf": [ @@ -657,12 +615,12 @@ } ], "description": "The architecture of the processor.", - "longDescription": "This property shall contain the string which identifies the architecture of the processor contained in this Socket.", + "longDescription": "This property shall contain the string that identifies the architecture of the processor contained in this Socket.", "readonly": true }, "ProcessorId": { "$ref": "#/definitions/ProcessorId", - "description": "Identification information for this processor.", + "description": "The identification information for this processor.", "longDescription": "This object shall contain identification information for this processor." }, "ProcessorMemory": { @@ -670,7 +628,7 @@ "items": { "$ref": "#/definitions/ProcessorMemory" }, - "longDescription": "The value of this property shall be the memory directly attached or integrated witin this Processor.", + "longDescription": "This property shall contain the memory directly attached or integrated witin this Processor.", "type": "array", "versionAdded": "v1_4_0" }, @@ -684,12 +642,12 @@ } ], "description": "The type of processor.", - "longDescription": "This property shall contain the string which identifies the type of processor contained in this Socket.", + "longDescription": "This property shall contain the string that identifies the type of processor contained in this Socket.", "readonly": true }, "Socket": { "description": "The socket or location of the processor.", - "longDescription": "This property shall contain the string which identifies the physical location or socket of the processor.", + "longDescription": "This property shall contain the string that identifies the physical location or socket of the processor.", "readonly": true, "type": [ "string", @@ -698,19 +656,19 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SubProcessors": { "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorCollection.json#/definitions/ProcessorCollection", - "description": "A reference to the collection of Sub-Processors associated with this system, such as cores or threads that are part of a processor.", - "longDescription": "The value of this property shall be a link to a collection of type ProcessorCollection.", + "description": "The link to the collection of subprocessors associated with this system, such as cores or threads, that are part of a processor.", + "longDescription": "This property shall contain a link to a Resource Collection of type ProcessorCollection.", "readonly": true, "versionAdded": "v1_3_0" }, "TDPWatts": { "description": "The nominal Thermal Design Power (TDP) in watts.", - "longDescription": "The value of this property shall be the nominal Thermal Design Power (TDP) in watts.", + "longDescription": "This property shall contain the nominal Thermal Design Power (TDP) in watts.", "readonly": true, "type": [ "integer", @@ -720,7 +678,7 @@ "versionAdded": "v1_4_0" }, "TotalCores": { - "description": "The total number of cores contained in this processor.", + "description": "The total number of cores that this processor contains.", "longDescription": "This property shall indicate the total count of independent processor cores contained within this processor.", "readonly": true, "type": [ @@ -728,9 +686,19 @@ "null" ] }, + "TotalEnabledCores": { + "description": "The total number of enabled cores that this processor contains.", + "longDescription": "This property shall indicate the total count of enabled independent processor cores contained within this processor.", + "readonly": true, + "type": [ + "integer", + "null" + ], + "versionAdded": "v1_5_0" + }, "TotalThreads": { - "description": "The total number of execution threads supported by this processor.", - "longDescription": "This property shall indicate the total count of independent execution threads supported by this processor.", + "description": "The total number of execution threads that this processor supports.", + "longDescription": "This property shall indicate the total count of independent execution threads that this processor supports.", "readonly": true, "type": [ "integer", @@ -746,8 +714,8 @@ "type": "null" } ], - "description": "The universal unique identifier (UUID) for this processor.", - "longDescription": "The value of this property shall be used to contain a universal unique identifier number for the processor. RFC4122 describes methods that can be used to create the value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", + "description": "The UUID for this processor.", + "longDescription": "This property shall contain a universal unique identifier number for the processor. RFC4122 describes methods to use to create the value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", "readonly": true, "versionAdded": "v1_4_0" } @@ -784,10 +752,10 @@ }, "ProcessorId": { "additionalProperties": false, - "description": "This type describes the Identification information for a processor.", + "description": "The identification information for a processor.", "longDescription": "This type shall contain identification information for a processor.", "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", @@ -802,7 +770,7 @@ }, "properties": { "EffectiveFamily": { - "description": "The effective Family for this processor.", + "description": "The effective family for this processor.", "longDescription": "This property shall indicate the effective Family information as provided by the manufacturer of this processor.", "readonly": true, "type": [ @@ -811,7 +779,7 @@ ] }, "EffectiveModel": { - "description": "The effective Model for this processor.", + "description": "The effective model for this processor.", "longDescription": "This property shall indicate the effective Model information as provided by the manufacturer of this processor.", "readonly": true, "type": [ @@ -820,8 +788,8 @@ ] }, "IdentificationRegisters": { - "description": "The contents of the Identification Registers (CPUID) for this processor.", - "longDescription": "This property shall include the raw CPUID instruction output as provided by the manufacturer of this processor.", + "description": "The raw manufacturer-provided CPUID instruction output for this processor.", + "longDescription": "This property shall contain the raw manufacturer-provided CPUID instruction output for this processor.", "readonly": true, "type": [ "string", @@ -829,7 +797,7 @@ ] }, "MicrocodeInfo": { - "description": "The Microcode Information for this processor.", + "description": "The microcode information for this processor.", "longDescription": "This property shall indicate the Microcode Information as provided by the manufacturer of this processor.", "readonly": true, "type": [ @@ -838,7 +806,7 @@ ] }, "Step": { - "description": "The Step value for this processor.", + "description": "The step value for this processor.", "longDescription": "This property shall indicate the Step or revision string information as provided by the manufacturer of this processor.", "readonly": true, "type": [ @@ -847,8 +815,8 @@ ] }, "VendorId": { - "description": "The Vendor Identification for this processor.", - "longDescription": "This property shall indicate the Vendor Identification string information as provided by the manufacturer of this processor.", + "description": "The vendor identification for this processor.", + "longDescription": "This property shall indicate the vendor Identification string information as provided by the manufacturer of this processor.", "readonly": true, "type": [ "string", @@ -863,7 +831,7 @@ "description": "This type describes the memory directly attached or integrated within a processor.", "longDescription": "This type shall contain information about memory directly attached or integratied within a processor.", "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", @@ -879,7 +847,7 @@ "properties": { "CapacityMiB": { "description": "The memory capacity in MiB.", - "longDescription": "The value of this property shall be the memory capacity in MiB.", + "longDescription": "This property shall contain the memory capacity in MiB.", "readonly": true, "type": [ "integer", @@ -889,8 +857,8 @@ "versionAdded": "v1_4_0" }, "IntegratedMemory": { - "description": "This indicates whether this memory is integrated within the Processor.", - "longDescription": "The value of this property shall be a boolean indicating whether this memory is integrated within the Porcessor. Otherwise it is discrete memory attached to the Processor.", + "description": "An indication of whether this memory is integrated within the processor.", + "longDescription": "This property shall indicate whether this memory is integrated within the processor. Otherwise, it is discrete memory attached to the processor.", "readonly": true, "type": [ "boolean", @@ -908,13 +876,13 @@ } ], "description": "The type of memory used by this processor.", - "longDescription": "The value of this property shall be a type of the processor memory type.", + "longDescription": "This property shall contain a type of the processor memory type.", "readonly": true, "versionAdded": "v1_4_0" }, "SpeedMHz": { "description": "The operating speed of the memory in MHz.", - "longDescription": "The value of this property shall be the operating speed of the memory in MHz.", + "longDescription": "This property shall contain the operating speed of the memory in MHz.", "readonly": true, "type": [ "integer", @@ -998,14 +966,14 @@ "OEM" ], "enumDescriptions": { - "Accelerator": "An Accelerator.", - "CPU": "A Central Processing Unit.", - "Core": "A Core in a Processor.", - "DSP": "A Digital Signal Processor.", - "FPGA": "A Field Programmable Gate Array.", - "GPU": "A Graphics Processing Unit.", - "OEM": "An OEM-defined Processing Unit.", - "Thread": "A Thread in a Processor." + "Accelerator": "An accelerator.", + "CPU": "A CPU.", + "Core": "A core in a processor.", + "DSP": "A DSP.", + "FPGA": "An FPGA.", + "GPU": "A GPU.", + "OEM": "An OEM-defined processing unit.", + "Thread": "A thread in a processor." }, "enumVersionAdded": { "Core": "v1_3_0", @@ -1015,6 +983,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#Processor.v1_4_0.Processor" + "release": "2019.1", + "title": "#Processor.v1_5_1.Processor" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ProcessorMetrics/ProcessorMetrics.json b/static/redfish/v1/JsonSchemas/ProcessorMetrics/ProcessorMetrics.json index 65aa5bb7fc..1b9a37fded 100644 --- a/static/redfish/v1/JsonSchemas/ProcessorMetrics/ProcessorMetrics.json +++ b/static/redfish/v1/JsonSchemas/ProcessorMetrics/ProcessorMetrics.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.v1_0_2.json", "$ref": "#/definitions/ProcessorMetrics", "$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." } }, "type": "object" @@ -34,9 +34,9 @@ "CStateResidency": { "additionalProperties": false, "description": "The C-state residency of the processor.", - "longDescription": "This type shall contain properties which describe the C-state residency of the processor or core.", + "longDescription": "This type shall contain properties that describe the C-state residency of the processor or core.", "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,8 +51,8 @@ }, "properties": { "Level": { - "description": "The level of C-state, e.g. C0, C1, C2.", - "longDescription": "The value of this property shall be the level of C-state.", + "description": "The C-state level, such as C0, C1, or C2.", + "longDescription": "This property shall contain the C-state level, such as C0, C1, or C2. When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.", "readonly": true, "type": [ "string", @@ -61,7 +61,7 @@ }, "ResidencyPercent": { "description": "The percentage of time that the processor or core has spent in this particular level of C-state.", - "longDescription": "The value of this property shall be the percentage of time that the processor or core has spent in this particular level of C-state.", + "longDescription": "This property shall contain the percentage of time that the processor or core has spent in this particular level of C-state. When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.", "minimum": 0, "readonly": true, "type": [ @@ -78,7 +78,7 @@ "description": "The processor core metrics.", "longDescription": "This type shall contain properties that describe cache metrics of a processor or core.", "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", @@ -94,7 +94,7 @@ "properties": { "CacheMiss": { "description": "The number of cache line misses in millions.", - "longDescription": "The value of this property shall be the number of cache line misses of the processor or core in millions.", + "longDescription": "This property shall contain the number of cache line misses of the processor or core in millions.", "readonly": true, "type": [ "number", @@ -103,7 +103,7 @@ }, "CacheMissesPerInstruction": { "description": "The number of cache misses per instruction.", - "longDescription": "The value of this property shall be the number of cache misses per instruction of the processor or core.", + "longDescription": "This property shall contain the number of cache misses per instruction of the processor or core.", "readonly": true, "type": [ "number", @@ -112,7 +112,7 @@ }, "HitRatio": { "description": "The cache line hit ratio.", - "longDescription": "The value of this property shall be the cache hit ratio of the processor or core.", + "longDescription": "This property shall contain the cache hit ratio of the processor or core.", "readonly": true, "type": [ "number", @@ -121,7 +121,7 @@ }, "Level": { "description": "The cache level.", - "longDescription": "This property shall be the level of the cache in the processor or core.", + "longDescription": "This property shall contain the level of the cache in the processor or core.", "readonly": true, "type": [ "string", @@ -130,7 +130,7 @@ }, "OccupancyBytes": { "description": "The total cache level occupancy in bytes.", - "longDescription": "The value of this property shall be the total cache occupancy of the processor or core in bytes.", + "longDescription": "This property shall contain the total cache occupancy of the processor or core in bytes.", "readonly": true, "type": [ "integer", @@ -140,7 +140,7 @@ }, "OccupancyPercent": { "description": "The total cache occupancy percentage.", - "longDescription": "The value of this property shall be the total cache occupancy percentage of the processor or core.", + "longDescription": "This property shall contain the total cache occupancy percentage of the processor or core.", "minimum": 0, "readonly": true, "type": [ @@ -157,7 +157,7 @@ "description": "The processor core metrics.", "longDescription": "This type shall contain properties that describe the cores of a processor.", "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", @@ -174,14 +174,7 @@ "CStateResidency": { "description": "The C-state residency of this core in the processor.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/CStateResidency" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/CStateResidency" }, "longDescription": "This property shall contain properties that describe the C-state residency of this core in the processor.", "type": "array" @@ -189,21 +182,14 @@ "CoreCache": { "description": "The cache metrics of this core in the processor.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/CacheMetrics" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/CacheMetrics" }, "longDescription": "This property shall contain properties that describe the cache metrics of this core in the processor.", "type": "array" }, "CoreId": { "description": "The processor core identifier.", - "longDescription": "This property shall be the processor core identifier.", + "longDescription": "This property shall contain the identifier of the core within the processor.", "readonly": true, "type": [ "string", @@ -212,7 +198,7 @@ }, "IOStallCount": { "description": "The number of stalled cycles due to I/O operations.", - "longDescription": "The value of this property shall be the number of stalled cycles due to I/O operations of this core in the processor.", + "longDescription": "This property shall contain the number of stalled cycles due to I/O operations of this core in the processor.", "readonly": true, "type": [ "number", @@ -221,7 +207,7 @@ }, "InstructionsPerCycle": { "description": "The number of instructions per clock cycle of this core.", - "longDescription": "The value of this property shall be the number of instructions per clock cycle of this core in the processor.", + "longDescription": "This property shall contain the number of instructions per clock cycle of this core in the processor.", "readonly": true, "type": [ "number", @@ -230,7 +216,7 @@ }, "MemoryStallCount": { "description": "The number of stalled cycles due to memory operations.", - "longDescription": "The value of this property shall be the number of stalled cycles due to memory operations of this core in the processor.", + "longDescription": "This property shall contain the number of stalled cycles due to memory operations of this core in the processor.", "readonly": true, "type": [ "number", @@ -239,7 +225,7 @@ }, "UnhaltedCycles": { "description": "The unhalted cycles count of this core.", - "longDescription": "The value of this property shall be the number of unhalted cycles of this core in the processor.", + "longDescription": "This property shall contain the number of unhalted cycles of this core in the processor.", "readonly": true, "type": [ "number", @@ -251,10 +237,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", @@ -272,10 +258,10 @@ }, "ProcessorMetrics": { "additionalProperties": false, - "description": "ProcessorMetrics contains usage and health statistics for a Processor (all Cores).", - "longDescription": "This resource shall be used to represent the Processor Metrics for a single Processor in a Redfish implementation.", + "description": "The ProcessorMetrics schema contains usage and health statistics for a processor.", + "longDescription": "This Resource contains the Processor Metrics for a single Processor in 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", @@ -290,25 +276,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AverageFrequencyMHz": { "description": "The average frequency of the processor.", - "longDescription": "The value of this property shall be average frequency across all enabled cores in the processor in MHz.", + "longDescription": "This property shall contain average frequency in MHz, across all enabled cores in the processor. When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.", "readonly": true, "type": [ "number", @@ -318,7 +304,7 @@ }, "BandwidthPercent": { "description": "The CPU bandwidth as a percentage.", - "longDescription": "The value of this property shall be CPU utilization of the processor as a percentage.", + "longDescription": "This property shall contain CPU utilization of the processor as a percentage. When this Resource is subordinate to the ProcessorSummary object, this property shall be the CPU utilization over all processors as a percentage.", "minimum": 0, "readonly": true, "type": [ @@ -330,21 +316,14 @@ "Cache": { "description": "The processor cache metrics.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/CacheMetrics" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/CacheMetrics" }, - "longDescription": "This property shall contain properties that describe this processor's cache.", + "longDescription": "This property shall contain properties that describe this processor's cache. When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.", "type": "array" }, "ConsumedPowerWatt": { - "description": "The power consumed by the processor.", - "longDescription": "The value of this property shall be the power consumed by the processor in Watts.", + "description": "The power, in watts, that the processor has consumed.", + "longDescription": "This property shall contain the power, in watts, that the processor has consumed. When this Resource is subordinate to the ProcessorSummary object, this property shall be the sum of power, in watts, that all processors have consumed.", "readonly": true, "type": [ "number", @@ -355,16 +334,9 @@ "CoreMetrics": { "description": "The processor core metrics.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/CoreMetrics" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/CoreMetrics" }, - "longDescription": "This property shall contain properties that describe the cores of this processor.", + "longDescription": "This property shall contain properties that describe the cores of this processor. When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.", "type": "array" }, "Description": { @@ -380,7 +352,7 @@ }, "FrequencyRatio": { "description": "The frequency relative to the nominal processor frequency ratio.", - "longDescription": "The value of this property shall be the frequency relative to the nominal processor frequency ratio of this processor.", + "longDescription": "This property shall contain the frequency relative to the nominal processor frequency ratio of this processor. When this Resource is subordinate to the ProcessorSummary object, this property shall be the average FrequencyRatio over all processors.", "readonly": true, "type": [ "number", @@ -393,7 +365,7 @@ }, "KernelPercent": { "description": "The percentage of time spent in kernel mode.", - "longDescription": "The value of this property shall be total percentage of time the processor has spent in kernel mode.", + "longDescription": "This property shall contain total percentage of time the processor has spent in kernel mode. When this Resource is subordinate to the ProcessorSummary object, this property shall be the average KernelPercent over all processors.", "minimum": 0, "readonly": true, "type": [ @@ -404,7 +376,7 @@ }, "LocalMemoryBandwidthBytes": { "description": "The local memory bandwidth usage in bytes.", - "longDescription": "The value of this property shall be the local memory bandwidth usage of this processor in bytes.", + "longDescription": "This property shall contain the local memory bandwidth usage of this processor in bytes. When this Resource is subordinate to the ProcessorSummary object, this property shall be the sum of LocalMemoryBandwidthBytes over all processors.", "readonly": true, "type": [ "integer", @@ -418,12 +390,12 @@ }, "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." }, "RemoteMemoryBandwidthBytes": { "description": "The remote memory bandwidth usage in bytes.", - "longDescription": "The value of this property shall be the remote memory bandwidth usage of this processor in bytes.", + "longDescription": "This property shall contain the remote memory bandwidth usage of this processor in bytes. When this Resource is subordinate to the ProcessorSummary object, this property shall be the sum of RemoteMemoryBandwidthBytes over all processors.", "readonly": true, "type": [ "integer", @@ -433,7 +405,7 @@ }, "TemperatureCelsius": { "description": "The temperature of the processor.", - "longDescription": "The value of this property shall be the temperature of the processor in Celsius.", + "longDescription": "This property shall contain the temperature, in Celsius, of the processor. When this Resource is subordinate to the ProcessorSummary object, this property shall be the average temperature, in Celcius, over all processors.", "readonly": true, "type": [ "number", @@ -443,7 +415,7 @@ }, "ThrottlingCelsius": { "description": "The CPU margin to throttle (temperature offset in degree Celsius).", - "longDescription": "The value of this property shall be the CPU margin to throttle based on an offset between the maximum temperature in which the processor can operate, and the processor's current temperature.", + "longDescription": "This property shall contain the CPU margin to throttle based on an offset between the maximum temperature in which the processor can operate, and the processor's current temperature. When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.", "readonly": true, "type": [ "number", @@ -453,7 +425,7 @@ }, "UserPercent": { "description": "The percentage of time spent in user mode.", - "longDescription": "The value of this property shall be total percentage of time the processor has spent in user mode.", + "longDescription": "This property shall contain total percentage of time the processor has spent in user mode. When this Resource is subordinate to the ProcessorSummary object, this property shall be the average UserPercent over all processors.", "minimum": 0, "readonly": true, "type": [ @@ -474,5 +446,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#ProcessorMetrics.v1_0_0.ProcessorMetrics" + "title": "#ProcessorMetrics.v1_0_2.ProcessorMetrics" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Redundancy/Redundancy.json b/static/redfish/v1/JsonSchemas/Redundancy/Redundancy.json index 58cc138e07..1ec0a41aad 100644 --- a/static/redfish/v1/JsonSchemas/Redundancy/Redundancy.json +++ b/static/redfish/v1/JsonSchemas/Redundancy/Redundancy.json @@ -1,14 +1,14 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Redundancy.v1_3_2.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Redundancy.v1_3_4.json", "$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 +24,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_2_0" } }, @@ -33,10 +33,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", @@ -54,10 +54,10 @@ }, "Redundancy": { "additionalProperties": false, - "description": "This is the redundancy definition to be used in other resource schemas.", - "longDescription": "This object represents the Redundancy element property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification. The value of this string shall be of the format for the reserved word *Redundancy*.", + "description": "The common redundancy definition and structure used in other Redfish schemas.", + "longDescription": "This object represents the redundancy element property.", "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", @@ -72,17 +72,17 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "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_2_0" }, "MaxNumSupported": { - "description": "This is the maximum number of members allowable for this particular redundancy group.", - "longDescription": "The value of this property shall contain the maximum number of members allowed in the redundancy group.", + "description": "The maximum number of members allowable for this particular redundancy group.", + "longDescription": "This property shall contain the maximum number of members allowed in the redundancy group.", "readonly": true, "type": [ "integer", @@ -90,14 +90,14 @@ ] }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "MinNumNeeded": { - "description": "This is the minumum number of members needed for this group to be redundant.", - "longDescription": "The value of this property shall contain the minimum number of members allowed in the redundancy group for the current redundancy mode to still be fault tolerant.", + "description": "The minumum number of members needed for this group to be redundant.", + "longDescription": "This property shall contain the minimum number of members allowed in the redundancy group for the current redundancy mode to still be fault tolerant.", "readonly": true, "type": [ "integer", @@ -113,24 +113,24 @@ "type": "null" } ], - "description": "This is the redundancy mode of the group.", - "longDescription": "The value of this property shall contain the information about the redundancy mode of this subsystem.", + "description": "The redundancy mode of the group.", + "longDescription": "This property shall contain the information about the redundancy mode of this subsystem.", "readonly": false }, "Name": { - "description": "The name of the resource or array element.", - "longDescription": "This object represents the Name property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification. The value of this string shall be of the format for the reserved word *Name*.", + "description": "The name of the Resource or array member.", + "longDescription": "This object represents the name of this Resource or array member. The Resource values shall comply with the Redfish Specification-described requirements. This string value shall be of the 'Name' reserved word format.", "readonly": true, "type": "string" }, "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." }, "RedundancyEnabled": { - "description": "This indicates whether redundancy is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether the redundancy is enabled.", + "description": "An indication of whether redundancy is enabled.", + "longDescription": "This property shall indicate whether the redundancy is enabled.", "readonly": false, "type": [ "boolean", @@ -139,21 +139,21 @@ "versionAdded": "v1_1_0" }, "RedundancySet": { - "description": "Contains any ids that represent components of this redundancy set.", + "description": "The links to components of this redundancy set.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall contain the ids of components that are part of this redundancy set. The id values may or may not be dereferenceable.", + "longDescription": "This property shall contain the links to components that are part of this redundancy set.", "readonly": true, "type": "array" }, "RedundancySet@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -176,7 +176,7 @@ "NotRedundant" ], "enumDescriptions": { - "Failover": "Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set.", + "Failover": "Failure of one unit automatically causes a standby or offline unit in the redundancy set to take over its functions.", "N+m": "Multiple units are available and active such that normal operation will continue if one or more units fail.", "NotRedundant": "The subsystem is not configured in a redundancy mode, either due to configuration or the functionality has been disabled by the user.", "Sharing": "Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail.", @@ -190,5 +190,5 @@ }, "owningEntity": "DMTF", "release": "2017.3", - "title": "#Redundancy.v1_3_2" + "title": "#Redundancy.v1_3_4" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Resource/Resource.json b/static/redfish/v1/JsonSchemas/Resource/Resource.json index a1291ea9fd..8dab64534d 100644 --- a/static/redfish/v1/JsonSchemas/Resource/Resource.json +++ b/static/redfish/v1/JsonSchemas/Resource/Resource.json @@ -1,14 +1,14 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Resource.v1_8_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Resource.v1_8_2.json", "$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": { "ContactInfo": { "additionalProperties": false, - "description": "Contact information for this resource.", - "longDescription": "This object shall contain contact information used to obtain more information from an individual or organization responsible for this resource.", + "description": "Contact information for this Resource.", + "longDescription": "This object shall contain contact information for an individual or organization responsible 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,7 +24,7 @@ "properties": { "ContactName": { "description": "Name of this contact.", - "longDescription": "The value shall contain the name of a person or organization to contact for information about this resource.", + "longDescription": "This property shall contain the name of a person or organization to contact for information about this Resource.", "readonly": false, "type": [ "string", @@ -34,7 +34,7 @@ }, "EmailAddress": { "description": "Email address for this contact.", - "longDescription": "The value shall contain the email address for a person or organization to contact for information about this resource.", + "longDescription": "This property shall contain the email address for a person or organization to contact for information about this Resource.", "readonly": false, "type": [ "string", @@ -44,7 +44,7 @@ }, "PhoneNumber": { "description": "Phone number for this contact.", - "longDescription": "The value shall contain the phone number for a person or organization to contact for information about this resource.", + "longDescription": "This property shall contain the phone number for a person or organization to contact for information about this Resource.", "readonly": false, "type": [ "string", @@ -66,22 +66,22 @@ "NSID" ], "enumDescriptions": { - "EUI": "IEEE-defined 64-bit Extended Unique Identifier.", - "FC_WWN": "Fibre Channel World Wide Name.", - "NAA": "Name Address Authority Format.", - "NQN": "NVMe Qualified Name.", - "NSID": "NVM Namespace Identifier.", - "UUID": "Universally Unique Identifier.", - "iQN": "iSCSI Qualified Name." + "EUI": "The IEEE-defined 64-bit Extended Unique Identifier (EUI).", + "FC_WWN": "The Fibre Channel (FC) World Wide Name (WWN).", + "NAA": "The Name Address Authority (NAA) format.", + "NQN": "The NVMe Qualified Name (NQN).", + "NSID": "The NVM Namespace Identifier (NSID).", + "UUID": "The Universally Unique Identifier (UUID).", + "iQN": "The iSCSI Qualified Name (iQN)." }, "enumLongDescriptions": { - "EUI": "This durable name shall be the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification.", - "FC_WWN": "This durable name shall be a hexadecimal representation of the World Wide Name format as defined in the T11 Fibre Channel Physical and Signaling Interface Specification.", - "NAA": "This durable name shall be a hexadecimal representation of the Name Address Authority structure as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification.", - "NQN": "This durable name shall be in the NVMe Qualified Name format as defined in the NVN Express over Fabric Specification.", - "NSID": "This durable name shall be in the NVM Namespace Identifier format as defined in the NVN Express Specification.", - "UUID": "This durable name shall be the hexadecimal representation of the Universal Unique Identifier as defined in the Internation Telecom Union's OSI networking and system aspects - Naming, Addressing and Registration Specification.", - "iQN": "This durable name shall be in the iSCSI Qualified Name format as defined in RFC 3720 and RFC 3721." + "EUI": "This durable name shall contain the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier (EUI), as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification.", + "FC_WWN": "This durable name shall contain a hexadecimal representation of the World-Wide Name (WWN) format, as defined in the T11 Fibre Channel Physical and Signaling Interface Specification.", + "NAA": "This durable name shall contain a hexadecimal representation of the Name Address Authority structure, as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification.", + "NQN": "This durable name shall be in the NVMe Qualified Name (NQN) format, as defined in the NVN Express over Fabric Specification.", + "NSID": "This durable name shall be in the NVM Namespace Identifier (NSID) format, as defined in the NVN Express Specification.", + "UUID": "This durable name shall contain the hexadecimal representation of the UUID, as defined in the International Telecom Union's OSI networking and system aspects - Naming, Addressing and Registration Specification.", + "iQN": "This durable name shall be in the iSCSI Qualified Name (iQN) format, as defined in RFC3720 and RFC3721." }, "enumVersionAdded": { "NQN": "v1_6_0", @@ -91,10 +91,10 @@ }, "Identifier": { "additionalProperties": false, - "description": "This type describes any additional identifiers for a resource.", - "longDescription": "This type shall contain any additional identifiers of a resource.", + "description": "Any additional identifiers for a Resource.", + "longDescription": "This type shall contain any additional identifiers for a 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", @@ -109,8 +109,8 @@ }, "properties": { "DurableName": { - "description": "This indicates the world wide, persistent name of the resource.", - "longDescription": "This property shall contain the world wide unique identifier for the resource. The string shall be in the format described by the value of the Identifier.DurableNameFormat property.", + "description": "The world-wide, persistent name of the Resource.", + "longDescription": "This property shall contain the world-wide unique identifier for the Resource. The string shall be in the Identifier.DurableNameFormat property value format.", "readonly": true, "type": [ "string", @@ -127,7 +127,7 @@ "type": "null" } ], - "description": "This represents the format of the DurableName property.", + "description": "The format of the durable name property.", "longDescription": "This property shall represent the format of the DurableName property.", "readonly": true, "versionAdded": "v1_1_0" @@ -137,10 +137,10 @@ }, "Location": { "additionalProperties": false, - "description": "This type describes the location of a resource.", - "longDescription": "This type shall describe the location of a resource.", + "description": "The location of a Resource.", + "longDescription": "This type shall describe the location of a 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", @@ -155,8 +155,8 @@ }, "properties": { "AltitudeMeters": { - "description": "The altitude of the resource in meters.", - "longDescription": "The altitude of the resource in meters.", + "description": "The altitude of the Resource in meters.", + "longDescription": "This property shall contain the altitude of the Resource in meters.", "readonly": false, "type": [ "number", @@ -166,7 +166,7 @@ "versionAdded": "v1_6_0" }, "Contacts": { - "description": "Array of contact information.", + "description": "An array of contact information.", "items": { "anyOf": [ { @@ -177,33 +177,37 @@ } ] }, - "longDescription": "The value shall contain contact information used to obtain more information from an individual or organization responsible for this resource.", + "longDescription": "This property shall contain an array of contact information for an individual or organization responsible for this Resource.", "type": "array", "versionAdded": "v1_7_0" }, "Info": { - "description": "This indicates the location of the resource.", - "longDescription": "This property shall represent the location of the resource.", + "deprecated": "This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.", + "description": "The location of the Resource.", + "longDescription": "This property shall represent the location of the Resource.", "readonly": true, "type": [ "string", "null" ], - "versionAdded": "v1_1_0" + "versionAdded": "v1_1_0", + "versionDeprecated": "v1_5_0" }, "InfoFormat": { - "description": "This represents the format of the Info property.", - "longDescription": "This property shall represent the format of the Info property.", + "deprecated": "This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.", + "description": "The format of the Info property.", + "longDescription": "This property shall represent the Info property format.", "readonly": true, "type": [ "string", "null" ], - "versionAdded": "v1_1_0" + "versionAdded": "v1_1_0", + "versionDeprecated": "v1_5_0" }, "Latitude": { - "description": "The latitude resource.", - "longDescription": "The value shall be the latitude of the resource specified in degrees using a decimal format and not minutes or seconds.", + "description": "The latitude of the Resource.", + "longDescription": "This property shall contain the latitude of the Resource specified in degrees using a decimal format and not minutes or seconds.", "readonly": false, "type": [ "number", @@ -213,8 +217,8 @@ "versionAdded": "v1_6_0" }, "Longitude": { - "description": "The longitude resource in degrees.", - "longDescription": "The value shall be the longitude of the resource specified in degrees using a decimal format and not minutes or seconds.", + "description": "The longitude of the Resource in degrees.", + "longDescription": "This property shall contain the longitude of the Resource specified in degrees using a decimal format and not minutes or seconds.", "readonly": false, "type": [ "number", @@ -225,54 +229,33 @@ }, "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_1_0" }, "PartLocation": { - "anyOf": [ - { - "$ref": "#/definitions/PartLocation" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/PartLocation", "description": "The part location within the placement.", - "longDescription": "The value shall describe a location within a resource. This representation shall be used to indicate the location within the Placement.", + "longDescription": "The location within a Resource. This representation shall indicate the location within the Placement.", "versionAdded": "v1_5_0" }, "Placement": { - "anyOf": [ - { - "$ref": "#/definitions/Placement" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/Placement", "description": "A place within the addressed location.", - "longDescription": "The value shall be a place within the addressed location.", + "longDescription": "This property shall contain a place within the addressed location.", "versionAdded": "v1_3_0" }, "PostalAddress": { - "anyOf": [ - { - "$ref": "#/definitions/PostalAddress" - }, - { - "type": "null" - } - ], - "description": "Postal address of the addressed resource.", - "longDescription": "The value shall be a postal address of the resource.", + "$ref": "#/definitions/PostalAddress", + "description": "The postal address of the addressed Resource.", + "longDescription": "This property shall contain a postal address of the Resource.", "versionAdded": "v1_3_0" } }, "type": "object" }, "LocationType": { - "description": "Defines the location types for PartLocation.", + "description": "The location types for PartLocation.", "enum": [ "Slot", "Bay", @@ -280,22 +263,22 @@ "Socket" ], "enumDescriptions": { - "Bay": "Defines a bay as the type of location.", - "Connector": "Defines a connector as the type of location.", - "Slot": "Defines a slot as the type of location.", - "Socket": "Defines a socket as the type of location." + "Bay": "The bay as the type of location.", + "Connector": "The connector as the type of location.", + "Slot": "The slot as the type of location.", + "Socket": "The socket as the type of location." }, "enumLongDescriptions": { - "Bay": "Bay shall be used to indicate the type of PartLocation is of type bay.", - "Connector": "Connector shall be used to indicate the type of PartLocation is of type connector.", - "Slot": "Slot shall be used to indicate the type of PartLocation is of type slot.", - "Socket": "Socket shall be used to indicate the type of PartLocation is of type socket." + "Bay": "Bay shall indicate the type of PartLocation is of the Bay type.", + "Connector": "Connector shall indicate the type of PartLocation is of the Connector type.", + "Slot": "Slot shall indicate the type of PartLocation is of the Slot type.", + "Socket": "Socket shall indicate the type of PartLocation of the Socket type." }, "longDescription": "Enumeration literals shall name the type of location in use.", "type": "string" }, "Orientation": { - "description": "Defines a orientation for the ordering of the ordinal value of the part location.", + "description": "The orientation for the ordering of the part location ordinal value.", "enum": [ "FrontToBack", "BackToFront", @@ -305,30 +288,30 @@ "RightToLeft" ], "enumDescriptions": { - "BackToFront": "Defines the ordering for the LocationOrdinalValue is back to front.", - "BottomToTop": "Defines the ordering for the LocationOrdinalValue is bottom to top.", - "FrontToBack": "Defines the ordering for the LocationOrdinalValue is front to back.", - "LeftToRight": "Defines the ordering for the LocationOrdinalValue is left to right.", - "RightToLeft": "Defines the ordering for the LocationOrdinalValue is right to left.", - "TopToBottom": "Defines the ordering for the LocationOrdinalValue is top to bottom." + "BackToFront": "The ordering for the LocationOrdinalValue is back to front.", + "BottomToTop": "The ordering for LocationOrdinalValue is bottom to top.", + "FrontToBack": "The ordering for LocationOrdinalValue is front to back.", + "LeftToRight": "The ordering for the LocationOrdinalValue is left to right.", + "RightToLeft": "The ordering for the LocationOrdinalValue is right to left.", + "TopToBottom": "The ordering for the LocationOrdinalValue is top to bottom." }, "enumLongDescriptions": { - "BackToFront": "This value shall be used to specify the ordering for LocationOrdinalValue is back to front.", - "BottomToTop": "This value shall be used to specify the ordering for LocationOrdinalValue is bottom to top.", - "FrontToBack": "This value shall be used to specify the ordering for LocationOrdinalValue is front to back.", - "LeftToRight": "This value shall be used to specify the ordering for LocationOrdinalValue is left to right.", - "RightToLeft": "This value shall be used to specify the ordering for LocationOrdinalValue is right to left.", - "TopToBottom": "This value shall be used to specify the ordering for LocationOrdinalValue is top to bottom." + "BackToFront": "This value shall be used to indicate the ordering for LocationOrdinalValue is back to front.", + "BottomToTop": "This value shall be used to indicate the ordering for LocationOrdinalValue is bottom to top.", + "FrontToBack": "This value shall be used to indicate the ordering for LocationOrdinalValue is front to back.", + "LeftToRight": "This value shall be used to indicate the ordering for LocationOrdinalValue is left to right.", + "RightToLeft": "This value shall be used to indicate the ordering for LocationOrdinalValue is right to left.", + "TopToBottom": "This value shall be used to indicate the ordering for LocationOrdinalValue is top to bottom." }, - "longDescription": "Enumeration literals shall name the orientation for the location type ordering in determining the LocationOrdinalValue.", + "longDescription": "These enumeration literals shall name the orientation for the location type ordering in determining the LocationOrdinalValue.", "type": "string" }, "PartLocation": { "additionalProperties": false, "description": "The part location within the placement.", - "longDescription": "The value shall describe a location within a resource. This representation shall be used to indicate the location within the Placement.", + "longDescription": "This type shall describe a location within a Resource. This representation shall indicate the location within the Placement.", "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", @@ -343,8 +326,8 @@ }, "properties": { "LocationOrdinalValue": { - "description": "The number that represents the location of the part. If LocationType is slot and this unit is in slot 2 then the LocationOrdinalValue will be 2.", - "longDescription": "The value shall be the number that represents the location of the part based on the LocationType. LocationOrdinalValue shall be measured based on the Orientation value starting with 0.", + "description": "The number that represents the location of the part. If LocationType is `slot` and this unit is in slot 2, the LocationOrdinalValue is 2.", + "longDescription": "This property shall contain the number that represents the location of the part based on the LocationType. LocationOrdinalValue shall be measured based on the Orientation value starting with 0.", "readonly": true, "type": [ "integer", @@ -362,7 +345,7 @@ } ], "description": "The type of location of the part, such as slot, bay, socket and slot.", - "longDescription": "The value shall be a LocationType enumeration literal indicating the type of rack units in use.", + "longDescription": "This property shall contain the type of location of the part, such as slot, bay, socket and slot.", "readonly": true, "versionAdded": "v1_5_0" }, @@ -376,7 +359,7 @@ } ], "description": "The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.", - "longDescription": "The value shall be a Orientation enumeration literal indicating the orientation for the ordering used by the LocationOrdinalValue property.", + "longDescription": "This property shall contain the orientation for the ordering used by the LocationOrdinalValue property.", "readonly": true, "versionAdded": "v1_5_0" }, @@ -389,14 +372,14 @@ "type": "null" } ], - "description": "The reference point for the part location. This is used to give guidance as to the general location of the part.", - "longDescription": "The value shall be a Reference enumeration literal indicating the general location within the unit of the part.", + "description": "The reference point for the part location. Provides guidance about the general location of the part.", + "longDescription": "This property shall contain the general location within the unit of the part.", "readonly": true, "versionAdded": "v1_5_0" }, "ServiceLabel": { - "description": "This is the label of the part location, such as a silk screened name or a printed label.", - "longDescription": "The value shall be the label assigned for service at the part location.", + "description": "The label of the part location, such as a silk-screened name or a printed label.", + "longDescription": "This property shall contain the label assigned for service at the part location.", "readonly": true, "type": [ "string", @@ -410,9 +393,9 @@ "Placement": { "additionalProperties": false, "description": "The placement within the addressed location.", - "longDescription": "The value shall describe a location within a resource. Examples include a shelf in a rack.", + "longDescription": "The value shall describe a location within a Resource. Examples include a shelf in a rack.", "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", @@ -428,7 +411,7 @@ "properties": { "AdditionalInfo": { "description": "Area designation or other additional info.", - "longDescription": "The value shall contain additional information, such as Tile, Column (Post), Wall, or other designation used to describe a location that cannot be conveyed with other properties defined for the Placement object.", + "longDescription": "This property shall contain additional information, such as Tile, Column (Post), Wall, or other designation that describes a location that cannot be conveyed with other properties defined for the Placement object.", "readonly": false, "type": [ "string", @@ -437,8 +420,8 @@ "versionAdded": "v1_7_0" }, "Rack": { - "description": "Name of a rack location within a row.", - "longDescription": "The value shall be the name of the rack within a row.", + "description": "The name of a rack location within a row.", + "longDescription": "This property shall contain the name of the rack within a row.", "readonly": false, "type": [ "string", @@ -447,8 +430,8 @@ "versionAdded": "v1_3_0" }, "RackOffset": { - "description": "Vertical location of the item in terms of RackOffsetUnits.", - "longDescription": "Vertical location of the item in the rack. Rack offset units shall be measured from bottom to top starting with 0.", + "description": "The vertical location of the item, in terms of RackOffsetUnits.", + "longDescription": "The vertical location of the item in the rack. Rack offset units shall be measured from bottom to top, starting with 0.", "readonly": false, "type": [ "integer", @@ -465,14 +448,14 @@ "type": "null" } ], - "description": "The type of Rack Units in use.", - "longDescription": "The value shall be a RackUnit enumeration literal indicating the type of rack units in use.", + "description": "The type of rack units in use.", + "longDescription": "This property shall contain a RackUnit enumeration literal that indicates the type of rack units in use.", "readonly": false, "versionAdded": "v1_3_0" }, "Row": { - "description": "Name of row.", - "longDescription": "The value shall be the name of the row.", + "description": "The name of the row.", + "longDescription": "This property shall contain the name of the row.", "readonly": false, "type": [ "string", @@ -485,10 +468,10 @@ }, "PostalAddress": { "additionalProperties": false, - "description": "The PostalAddress for a resource.", - "longDescription": "Instances shall describe a postal address for a resource. For more information see RFC5139. Depending on use, the instance may represent a past, current, or future location.", + "description": "The postal address for a Resource.", + "longDescription": "Instances shall describe a postal address for a Resource. For more information, see RFC5139. Depending on use, the instance may represent a past, current, or future location.", "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", @@ -503,8 +486,8 @@ }, "properties": { "AdditionalCode": { - "description": "Additional code.", - "longDescription": "The value shall conform the requirements of the ADDCODE field as defined in RFC5139.", + "description": "The additional code.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field.", "readonly": false, "type": [ "string", @@ -513,8 +496,8 @@ "versionAdded": "v1_3_0" }, "AdditionalInfo": { - "description": "Room designation or other additional info.", - "longDescription": "The value shall conform the requirements of the LOC field as defined in RFC5139. It is used to provide additional information.", + "description": "The room designation or other additional information.", + "longDescription": "The value shall conform to the requirements of the LOC field as defined in RFC5139. Provides additional information.", "readonly": false, "type": [ "string", @@ -523,8 +506,8 @@ "versionAdded": "v1_7_0" }, "Building": { - "description": "Name of the building.", - "longDescription": "The value shall conform the requirements of the BLD field as defined in RFC5139. The value shall be name a building used to locate the resource.", + "description": "The name of the building.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the BLD field. Names the building.", "readonly": false, "type": [ "string", @@ -534,7 +517,7 @@ }, "City": { "description": "City, township, or shi (JP).", - "longDescription": "The value shall conform the requirements of the A3 field as defined in RFC5139. It is used to name a city, township, or shi (JP).", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the A3 field. Names a city, township, or shi (JP).", "readonly": false, "type": [ "string", @@ -543,8 +526,8 @@ "versionAdded": "v1_3_0" }, "Community": { - "description": "Postal community name.", - "longDescription": "The value shall conform the requirements of the PCN field as defined in RFC5139. The value shall be a postal community name.", + "description": "The postal community name.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the PCN field. A postal community name.", "readonly": false, "type": [ "string", @@ -553,8 +536,8 @@ "versionAdded": "v1_3_0" }, "Country": { - "description": "Country.", - "longDescription": "The value shall conform the requirements of the Country field as defined in RFC5139.", + "description": "The country.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the Country field.", "readonly": false, "type": [ "string", @@ -563,8 +546,8 @@ "versionAdded": "v1_3_0" }, "District": { - "description": "A county, parish, gun (JP), or district (IN).", - "longDescription": "The value shall conform the requirements of the A2 field as defined in RFC5139. It is used to name a county, parish, gun (JP), or district (IN).", + "description": "A county, parish, gun (JP), or district (IN).", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the A2 field. Names a county, parish, gun (JP), or district (IN).", "readonly": false, "type": [ "string", @@ -573,8 +556,8 @@ "versionAdded": "v1_3_0" }, "Division": { - "description": "City division, borough, dity district, ward, chou (JP).", - "longDescription": "The value shall conform the requirements of the A4 field as defined in RFC5139. It is used to name a city division, borough, dity district, ward, chou (JP).", + "description": "City division, borough, dity district, ward, or chou (JP).", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the A4 field. Names a city division, borough, dity district, ward, or chou (JP).", "readonly": false, "type": [ "string", @@ -583,8 +566,8 @@ "versionAdded": "v1_3_0" }, "Floor": { - "description": "Floor.", - "longDescription": "The value shall conform the requirements of the FLR field as defined in RFC5139. It is used to provide a floor designation.", + "description": "The floor.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the FLR field. Provides a floor designation.", "readonly": false, "type": [ "string", @@ -593,18 +576,20 @@ "versionAdded": "v1_3_0" }, "GPSCoords": { + "deprecated": "This property has been deprecated in favor of the Longitude and Latitude properties.", "description": "The GPS coordinates of the part.", - "longDescription": "The value shall conform the requirements of the ADDCODE field as defined in RFC5139. The value shall be the GPS coordinates of the location. If furnished, this shall be expressed in the format '[-][nn]n.nnnnnn, [-][nn]n.nnnnn', i.e. two numbers, either positive or negative, with six decimal places of precision, comma-separated.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field. Shall contain the GPS coordinates of the location. If furnished, expressed in the '[-][nn]n.nnnnnn, [-][nn]n.nnnnn' format. For example, two comma-separated positive or negative numbers with six decimal places of precision.", "readonly": false, "type": [ "string", "null" ], - "versionAdded": "v1_3_0" + "versionAdded": "v1_3_0", + "versionDeprecated": "v1_6_0" }, "HouseNumber": { - "description": "Numeric portion of house number.", - "longDescription": "The value shall conform the requirements of the HNO field as defined in RFC5139. It is the numeric portion of the house number.", + "description": "The numeric portion of house number.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNO field. The numeric portion of the house number.", "readonly": false, "type": [ "integer", @@ -613,8 +598,8 @@ "versionAdded": "v1_3_0" }, "HouseNumberSuffix": { - "description": "House number suffix.", - "longDescription": "The value shall conform the requirements of the HNS field as defined in RFC5139. It is used to provide a suffix to a house number, (F, B, 1/2).", + "description": "The house number suffix.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNS field. Provides a suffix to a house number, (F, B, or 1/2).", "readonly": false, "type": [ "string", @@ -623,8 +608,8 @@ "versionAdded": "v1_3_0" }, "Landmark": { - "description": "Landmark.", - "longDescription": "The value shall conform the requirements of the LMK field as defined in RFC5139. It is used to identify a landmark or vanity address.", + "description": "The landmark.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the LMK field. Identifies a landmark or vanity address.", "readonly": false, "type": [ "string", @@ -634,7 +619,7 @@ }, "LeadingStreetDirection": { "description": "A leading street direction.", - "longDescription": "The value shall conform the requirements of the PRD field as defined in RFC5139. It is used to name a leading street direction, (N, W, SE).", + "longDescription": "The value shall conform to the requirements of the PRD field as defined in RFC5139. Names a leading street direction, (N, W, or SE).", "readonly": false, "type": [ "string", @@ -643,18 +628,20 @@ "versionAdded": "v1_3_0" }, "Location": { - "description": "Room designation or other additional info.", - "longDescription": "The value shall conform the requirements of the LOC field as defined in RFC5139. It is used to provide additional information.", + "deprecated": "This property has been deprecated in favor of the AdditionalInfo property.", + "description": "The room designation or other additional information.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the LOC field. Provides additional information.", "readonly": false, "type": [ "string", "null" ], - "versionAdded": "v1_3_0" + "versionAdded": "v1_3_0", + "versionDeprecated": "v1_7_0" }, "Name": { - "description": "Name.", - "longDescription": "The value shall conform the requirements of the NAM field as defined in RFC5139. It is used to name the occupant.", + "description": "The name.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the NAM field. Names the occupant.", "readonly": false, "type": [ "string", @@ -664,7 +651,7 @@ }, "Neighborhood": { "description": "Neighborhood or block.", - "longDescription": "The value shall conform the requirements of the A5 field as defined in RFC5139. It is used to name a neighborhood or block.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the A5 field. Names a neighborhood or block.", "readonly": false, "type": [ "string", @@ -673,8 +660,8 @@ "versionAdded": "v1_3_0" }, "POBox": { - "description": "Post office box (P.O. box).", - "longDescription": "The value shall conform the requirements of the POBOX field as defined in RFC5139. The value shall be a Post office box (P.O. box).", + "description": "The post office box (PO box).", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the POBOX field. A post office box (PO box).", "readonly": false, "type": [ "string", @@ -683,8 +670,8 @@ "versionAdded": "v1_3_0" }, "PlaceType": { - "description": "A description of the type of place that is addressed.", - "longDescription": "The value shall conform the requirements of the PLC field as defined in RFC5139. Examples include: office, residence,...).", + "description": "The description of the type of place that is addressed.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the PLC field. Examples include office and residence.", "readonly": false, "type": [ "string", @@ -693,8 +680,8 @@ "versionAdded": "v1_3_0" }, "PostalCode": { - "description": "Postal code (or zip code).", - "longDescription": "The value shall conform the requirements of the PC field as defined in RFC5139. The value shall be a Postal code (or zip code).", + "description": "The postal code or zip code.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the PC field. A postal code (or zip code).", "readonly": false, "type": [ "string", @@ -703,8 +690,8 @@ "versionAdded": "v1_3_0" }, "Road": { - "description": "A primary road or street.", - "longDescription": "The value shall conform the requirements of the RD field as defined in RFC5139. The value designates a primary road or street.", + "description": "The primary road or street.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the RD field. Designates a primary road or street.", "readonly": false, "type": [ "string", @@ -713,8 +700,8 @@ "versionAdded": "v1_3_0" }, "RoadBranch": { - "description": "Road branch.", - "longDescription": "The value shall conform the requirements of the RDBR field as defined in RFC5139. The value shall be a Post office box (P.O. box)road branch.", + "description": "The road branch.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDBR field. Shall contain a post office box (PO box) road branch.", "readonly": false, "type": [ "string", @@ -723,8 +710,8 @@ "versionAdded": "v1_3_0" }, "RoadPostModifier": { - "description": "Road post-modifier.", - "longDescription": "The value shall conform the requirements of the POM field as defined in RFC5139. (Extended).", + "description": "The road post-modifier.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the POM field. For example, Extended.", "readonly": false, "type": [ "string", @@ -733,8 +720,8 @@ "versionAdded": "v1_3_0" }, "RoadPreModifier": { - "description": "Road pre-modifier.", - "longDescription": "The value shall conform the requirements of the PRM field as defined in RFC5139. (Old, New).", + "description": "The road pre-modifier.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the PRM field. For example, Old or New.", "readonly": false, "type": [ "string", @@ -743,8 +730,8 @@ "versionAdded": "v1_3_0" }, "RoadSection": { - "description": "Road Section.", - "longDescription": "The value shall conform the requirements of the RDSEC field as defined in RFC5139. The value shall be a road section.", + "description": "The road section.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSEC field. A road section.", "readonly": false, "type": [ "string", @@ -753,8 +740,8 @@ "versionAdded": "v1_3_0" }, "RoadSubBranch": { - "description": "Road sub branch.", - "longDescription": "The value shall conform the requirements of the RDSUBBR field as defined in RFC5139.", + "description": "The road sub branch.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSUBBR field.", "readonly": false, "type": [ "string", @@ -763,8 +750,8 @@ "versionAdded": "v1_3_0" }, "Room": { - "description": "Name or number of the room.", - "longDescription": "The value shall conform the requirements of the ROOM field as defined in RFC5139. The value shall be a name or number of a room used to locate the resource within the unit.", + "description": "The name or number of the room.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the ROOM field. A name or number of a room to locate the Resource within the unit.", "readonly": false, "type": [ "string", @@ -773,8 +760,8 @@ "versionAdded": "v1_3_0" }, "Seat": { - "description": "Seat (desk, cubicle, workstation).", - "longDescription": "The value shall conform the requirements of the SEAT field as defined in RFC5139. The value shall be a name or number of a Seat (desk, cubicle, workstation).", + "description": "The seat, such as the desk, cubicle, or workstation.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the SEAT field. A name or number of a seat, such as the desk, cubicle, or workstation.", "readonly": false, "type": [ "string", @@ -784,7 +771,7 @@ }, "Street": { "description": "Street name.", - "longDescription": "The value shall conform the requirements of the A6 field as defined in RFC5139. It is used to name a street.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the A6 field. Names a street.", "readonly": false, "type": [ "string", @@ -794,7 +781,7 @@ }, "StreetSuffix": { "description": "Avenue, Platz, Street, Circle.", - "longDescription": "The value shall conform the requirements of the STS field as defined in RFC5139. It is used to name a street suffix.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the STS field. Names a street suffix.", "readonly": false, "type": [ "string", @@ -804,7 +791,7 @@ }, "Territory": { "description": "A top-level subdivision within a country.", - "longDescription": "The value shall conform the requirements of the A1 field as defined in RFC5139 when used to name a territory, state, region, province, or prefecture within a country.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the A1 field when it names a territory, state, region, province, or prefecture within a country.", "readonly": false, "type": [ "string", @@ -814,7 +801,7 @@ }, "TrailingStreetSuffix": { "description": "A trailing street suffix.", - "longDescription": "The value shall conform the requirements of the POD field as defined in RFC5139. It is used to name a trailing street suffix.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the POD field. Names a trailing street suffix.", "readonly": false, "type": [ "string", @@ -823,8 +810,8 @@ "versionAdded": "v1_3_0" }, "Unit": { - "description": "Name or number of the unit (apartment, suite).", - "longDescription": "The value shall conform the requirements of the UNIT field as defined in RFC5139. The value shall be a name or number of a unit (apartment, suite) used to locate the resource.", + "description": "The name or number of the apartment unit or suite.", + "longDescription": "The value shall conform to the RFC5139-defined requirements of the UNIT field. The name or number of a unit, such as the apartment or suite, to locate the Resource.", "readonly": false, "type": [ "string", @@ -836,24 +823,24 @@ "type": "object" }, "RackUnits": { - "description": "Defines a rack unit.", + "description": "The type of rack unit in use.", "enum": [ "OpenU", "EIA_310" ], "enumDescriptions": { - "EIA_310": "Defines a rack unit as being equal to 1.75 in (44.45 mm).", - "OpenU": "Defines a rack unit as being equal to 48 mm (1.89 in)." + "EIA_310": "A rack unit that is equal to 1.75 in (44.45 mm).", + "OpenU": "A rack unit that is equal to 48 mm (1.89 in)." }, "enumLongDescriptions": { - "EIA_310": "Rack units shall be specified as defined by the EIA-310 standard.", - "OpenU": "Rack units shall be specifie3d in terms of the Open Compute Open Rack specification." + "EIA_310": "Rack units shall conform to the EIA-310 standard.", + "OpenU": "Rack units shall be specified in terms of the Open Compute Open Rack specification." }, - "longDescription": "Enumeration literals shall name the type of rack units in use.", + "longDescription": "Enumeration literals shall name the type of rack unit in use.", "type": "string" }, "Reference": { - "description": "Defines a reference area for the location of the part.", + "description": "The reference area for the location of the part.", "enum": [ "Top", "Bottom", @@ -864,32 +851,32 @@ "Middle" ], "enumDescriptions": { - "Bottom": "Defines the part as being in the bottom of the unit.", - "Front": "Defines the part as being in the front of the unit.", - "Left": "Defines the part as being in the left of the unit.", - "Middle": "Defines the part as being in the middle of the unit.", - "Rear": "Defines the part as being in the rear of the unit.", - "Right": "Defines the part as being in the right of the unit.", - "Top": "Defines the part as being in the top of the unit." + "Bottom": "The part is in the bottom of the unit.", + "Front": "The part is in the front of the unit.", + "Left": "The part is on the left side of of the unit.", + "Middle": "The part is in the middle of the unit.", + "Rear": "The part is in the rear of the unit.", + "Right": "The part is on the right side of the unit.", + "Top": "The part is in the top of the unit." }, "enumLongDescriptions": { - "Bottom": "Top shall be used to specify the part location is in the bottom of the unit.", - "Front": "Top shall be used to specify the part location is in the front of the unit.", - "Left": "Top shall be used to specify the part location is in the left of the unit.", - "Middle": "Top shall be used to specify the part location is in the middle of the unit.", - "Rear": "Top shall be used to specify the part location is in the rear of the unit.", - "Right": "Top shall be used to specify the part location is in the right of the unit.", - "Top": "Top shall be used to specify the part location is in the top of the unit." + "Bottom": "This value shall be used to indicate the part is in the bottom of the unit.", + "Front": "This value shall be used to indicate the part is in the front of the unit.", + "Left": "This value shall be used to indicate the part is on the left side of of the unit.", + "Middle": "This value shall be used to indicate the part is in the middle of the unit.", + "Rear": "This value shall be used to indicate the part is in the rear of the unit.", + "Right": "This value shall be used to indicate the part is on the right side of the unit.", + "Top": "This value shall be used to indicate the part is in the top of the unit." }, - "longDescription": "Enumeration literals shall name the reference for the part location.", + "longDescription": "The enumerated literals shall name the reference for the part location.", "type": "string" }, "ReferenceableMember": { "additionalProperties": false, - "description": "This is the base type for addressable members of an array.", - "longDescription": "Array members can be referenced using the value returned in the @odata.id property which may or may not be a dereferenceable URL. The @odata.id of this entity shall be the location of this element within an Item.", + "description": "The base type for addressable members of an array.", + "longDescription": "References array members by using the value returned in the @odata.id property, which may be a dereferenceable URL. The @odata.id of this entity shall contain the location of this element within an item.", "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", @@ -904,18 +891,18 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "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." } }, "required": [ @@ -926,9 +913,9 @@ }, "Resource": { "additionalProperties": false, - "description": "This is the base type for resources and referenceable members.", + "description": "The base type for Resources and members that can be linked to.", "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", @@ -943,16 +930,16 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "Description": { "anyOf": [ @@ -975,8 +962,8 @@ }, "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." } }, "required": [ @@ -990,7 +977,7 @@ "ResourceCollection": { "additionalProperties": false, "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", @@ -1005,16 +992,16 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "Description": { "anyOf": [ @@ -1033,8 +1020,8 @@ }, "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 contained in this object shall conform to the Redfish Specification-described requirements." } }, "required": [ @@ -1047,5 +1034,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#Resource.v1_8_0" + "title": "#Resource.v1_8_2" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ResourceBlock/ResourceBlock.json b/static/redfish/v1/JsonSchemas/ResourceBlock/ResourceBlock.json index 43d026544c..d7f937e3b1 100644 --- a/static/redfish/v1/JsonSchemas/ResourceBlock/ResourceBlock.json +++ b/static/redfish/v1/JsonSchemas/ResourceBlock/ResourceBlock.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.v1_3_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.v1_3_2.json", "$ref": "#/definitions/ResourceBlock", "$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." } }, "type": "object" @@ -41,12 +41,12 @@ "Unavailable" ], "enumDescriptions": { - "Composed": "Final successful state of a Resource Block which has participated in composition.", - "ComposedAndAvailable": "Indicates the Resource Block is currently participating in one or more compositions, and is available to be used in more compositions.", + "Composed": "Final successful state of a Resource Block that has participated in composition.", + "ComposedAndAvailable": "The Resource Block is currently participating in one or more compositions, and is available to use in more compositions.", "Composing": "Intermediate state indicating composition is in progress.", "Failed": "The final composition resulted in failure and manual intervention may be required to fix it.", - "Unavailable": "Indicates the Resource Block has been made unavailable by the service, such as due to maintenance being performed on the Resource Block.", - "Unused": "Indicates the Resource Block is free and can participate in composition." + "Unavailable": "The Resource Block has been made unavailable by the service, such as due to maintenance being performed on the Resource Block.", + "Unused": "The Resource Block is free and can participate in composition." }, "enumVersionAdded": { "ComposedAndAvailable": "v1_1_0", @@ -59,7 +59,7 @@ "description": "Composition status of the Resource Block.", "longDescription": "This type shall contain properties that describe the high level composition status of the Resource Block.", "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", @@ -82,13 +82,13 @@ "type": "null" } ], - "description": "This property represents the current state of the Resource Block from a composition perspective.", - "longDescription": "The value of this property shall be an enumerated value describing composition state of the Resource Block.", + "description": "The current state of the Resource Block from a composition perspective.", + "longDescription": "This property shall contain an enumerated value that describes the composition state of the Resource Block.", "readonly": true }, "MaxCompositions": { - "description": "The maximum number of compositions in which this Resource Block is capable of participating simultaneously.", - "longDescription": "The value of this property shall be a number indicating the maximum number of compositions in which this Resource Block is capable of participating simultaneously. Services may have additional constraints that prevent this value from being achieved, such as due to system topology and current composed resource utilization. If SharingCapable is set to false, this value shall be set to 1. The service shall support this property if SharingCapable supported.", + "description": "The maximum number of compositions in which this Resource Block can participate simultaneously.", + "longDescription": "This property shall contain a number indicating the maximum number of compositions in which this Resource Block can participate simultaneously. Services may have additional constraints that prevent this value from being achieved, such as due to system topology and current composed Resource utilization. If SharingCapable is false, this value shall be set to 1. The Service shall support this property if SharingCapable supported.", "minimum": 1, "readonly": true, "type": [ @@ -99,7 +99,7 @@ }, "NumberOfCompositions": { "description": "The number of compositions in which this Resource Block is currently participating.", - "longDescription": "The value of this property shall be the number of compositions in which this Resource Block is currently participating.", + "longDescription": "This property shall contain the number of compositions in which this Resource Block is currently participating.", "minimum": 0, "readonly": true, "type": [ @@ -109,8 +109,8 @@ "versionAdded": "v1_1_0" }, "Reserved": { - "description": "This represents if the Resource Block is reserved by any client.", - "longDescription": "This property shall be a boolean that is set by client once the Resource Block is identified to be composed. It shall provide multiple clients a way to negotiate its ownership. This will help clients to know if a Resource Block is reserved by other client.", + "description": "An indication of whether any client has reserved the Resource Block.", + "longDescription": "This property shall indicate whether any client has reserved the Resource Block. A client sets this property after the Resource Block is identified as composed. It shall provide a way for multiple clients to negotiate the ownership of the Resource Block.", "readonly": false, "type": [ "boolean", @@ -118,8 +118,8 @@ ] }, "SharingCapable": { - "description": "Indicates if this Resource Block is capable of participating in multiple compositions simultaneously.", - "longDescription": "The value of this property shall be a boolean indicating whether this Resource Block is capable of participating in multiple compositions simultaneously. If this property is not provided, it shall be assumed that this Resource Block is not capable of being shared.", + "description": "An indication of whether this Resource Block can participate in multiple compositions simultaneously.", + "longDescription": "This property shall indicate whether this Resource Block can participate in multiple compositions simultaneously. If this property is not provided, it shall be assumed that this Resource Block is not capable of being shared.", "readonly": true, "type": [ "boolean", @@ -128,8 +128,8 @@ "versionAdded": "v1_1_0" }, "SharingEnabled": { - "description": "Indicates if this Resource Block is allowed to participate in multiple compositions simultaneously.", - "longDescription": "The value of this property shall be a boolean indicating whether this Resource Block is allowed to participate in multiple compositions simultaneously. The service shall reject modifications of this property with HTTP 400 Bad Request if this Resource Block already being used as part of a composed resource. If this property is set to false, the service shall not use the ComposedAndAvailable state for this Resource Block.", + "description": "An indication of whether this Resource Block is allowed to participate in multiple compositions simultaneously.", + "longDescription": "This property shall indicate whether this Resource Block can participate in multiple compositions simultaneously. The Service shall reject modifications of this property with HTTP 400 Bad Request if this Resource Block is already being used as part of a composed Resource. If `false`, the service shall not use the ComposedAndAvailable state for this Resource Block.", "readonly": false, "type": [ "boolean", @@ -145,10 +145,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -163,55 +163,55 @@ }, "properties": { "Chassis": { - "description": "An array of references to the Chassis in which this Resource Block is contained.", + "description": "An array of links to the Chassis in which this Resource Block is contained.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" }, - "longDescription": "The value of this property shall be an array of references of type Chassis that represent the physical container associated with this Resource Block.", + "longDescription": "This property shall contain an array of links of the Chassis type that represent the physical container associated with this Resource Block.", "readonly": true, "type": "array" }, "Chassis@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ComputerSystems": { - "description": "An array of references to the Computer Systems that are composed from this Resource Block.", + "description": "An array of links to the computer systems that are composed from this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "The value of this property shall be an array of references of type ComputerSystem that represent the Computer Systems composed from this Resource Block.", + "longDescription": "This property shall contain an array of links of the ComputerSystem type that represent the computer systems composed from this Resource Block.", "readonly": true, "type": "array" }, "ComputerSystems@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "Zones": { - "description": "An array of references to the Zones in which this Resource Block is bound.", + "description": "An array of links to the Zones in which this Resource Block is bound.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Zone.json#/definitions/Zone" }, - "longDescription": "The value of this property shall be an array of references of type Zone that represent the binding constraints associated with this Resource Block.", + "longDescription": "This property shall contain an array of links of the Zone type that represent the binding constraints associated with this Resource Block.", "readonly": true, "type": "array" }, "Zones@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -229,10 +229,10 @@ }, "ResourceBlock": { "additionalProperties": false, - "description": "This schema defines a Resource Block resource.", - "longDescription": "This resource shall be used to represent a Resource Block for a Redfish implementation.", + "description": "The schema definition of the Resource Block, its components, and affinity to composed devices.", + "longDescription": "This Resource shall represent a Resource Block 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", @@ -247,38 +247,38 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "CompositionStatus": { "$ref": "#/definitions/CompositionStatus", - "description": "This property describes the composition status details for this Resource Block.", - "longDescription": "The value of this property shall contain composition status information about this Resource Block." + "description": "The composition status details for this Resource Block.", + "longDescription": "This property shall contain composition status information about this Resource Block." }, "ComputerSystems": { - "description": "An array of references to the Computer Systems available in this Resource Block.", + "description": "An array of links to the computer systems available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" }, - "longDescription": "The value of this property shall be an array of references of type ComputerSystem that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the ComputerSystem type that this Resource Block contains.", "readonly": true, "type": "array" }, "ComputerSystems@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Description": { "anyOf": [ @@ -292,29 +292,29 @@ "readonly": true }, "Drives": { - "description": "An array of references to the Drives available in this Resource Block.", + "description": "An array of links to the Drives available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" }, - "longDescription": "The value of this property shall be an array of references of type Drive that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the Drive type that this Resource Block contains.", "readonly": true, "type": "array", "versionAdded": "v1_3_0" }, "Drives@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "EthernetInterfaces": { - "description": "An array of references to the Ethernet Interfaces available in this Resource Block.", + "description": "An array of links to the Ethernet interfaces available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface" }, - "longDescription": "The value of this property shall be an array of references of type EthernetInterface that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the EthernetInterface type that this Resource Block contains.", "readonly": true, "type": "array" }, "EthernetInterfaces@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -322,91 +322,91 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Memory": { - "description": "An array of references to the Memory available in this Resource Block.", + "description": "An array of links to the memory available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Memory.json#/definitions/Memory" }, - "longDescription": "The value of this property shall be an array of references of type Memory that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the Memory type that this Resource Block contains.", "readonly": true, "type": "array" }, "Memory@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "NetworkInterfaces": { - "description": "An array of references to the Network Interfaces available in this Resource Block.", + "description": "An array of links to the Network Interfaces available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkInterface.json#/definitions/NetworkInterface" }, - "longDescription": "The value of this property shall be an array of references of type NetworkInterface that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the NetworkInterface type that this Resource Block contains.", "readonly": true, "type": "array" }, "NetworkInterfaces@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "Processors": { - "description": "An array of references to the Processors available in this Resource Block.", + "description": "An array of links to the processors available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor" }, - "longDescription": "The value of this property shall be an array of references of type Processor that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the Processor type that this Resource Block contains.", "readonly": true, "type": "array" }, "Processors@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ResourceBlockType": { - "description": "This property represents the types of resources available on this Resource Block.", + "description": "The types of Resources available on this Resource Block.", "items": { "$ref": "#/definitions/ResourceBlockType" }, - "longDescription": "The value of this property shall be an array of enumerated values describing type of resources available.", + "longDescription": "This property shall contain an array of enumerated values that describe the type of Resources available.", "readonly": true, "type": "array" }, "SimpleStorage": { - "description": "An array of references to the Simple Storage available in this Resource Block.", + "description": "An array of links to the simple storage available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/SimpleStorage.json#/definitions/SimpleStorage" }, - "longDescription": "The value of this property shall be an array of references of type SimpleStorage that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of the SimpleStorage type that this Resource Block contains.", "readonly": true, "type": "array" }, "SimpleStorage@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Storage": { - "description": "An array of references to the Storage available in this Resource Block.", + "description": "An array of links to the storage available in this Resource Block.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/Storage" }, - "longDescription": "The value of this property shall be an array of references of type Storage that are in this Resource Block.", + "longDescription": "This property shall contain an array of links of Storage type that this Resource Block contains.", "readonly": true, "type": "array" }, "Storage@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "required": [ @@ -421,10 +421,10 @@ }, "ResourceBlockLimits": { "additionalProperties": false, - "description": "This object specifies the allowable quantities of types of Resource Blocks for a given composition request.", + "description": "This type specifies the allowable quantities of types of Resource Blocks for a composition request.", "longDescription": "This object shall specify the allowable quantities of types of Resource Blocks for a given composition request.", "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", @@ -439,8 +439,8 @@ }, "properties": { "MaxCompute": { - "description": "The minimum number of Resource Blocks of type Compute required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Compute required for the composition request.", + "description": "The maximum number of Resource Blocks of the Compute type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of the Compute type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -450,8 +450,8 @@ "versionAdded": "v1_3_0" }, "MaxComputerSystem": { - "description": "The minimum number of Resource Blocks of type ComputerSystem required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.", + "description": "The maximum number of Resource Blocks of the ComputerSystem type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of the Network type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -461,8 +461,8 @@ "versionAdded": "v1_3_0" }, "MaxExpansion": { - "description": "The minimum number of Resource Blocks of type Expansion required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Expansion required for the composition request.", + "description": "The maximum number of Resource Blocks of the Expansion type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of the Expansion type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -472,8 +472,8 @@ "versionAdded": "v1_3_0" }, "MaxMemory": { - "description": "The minimum number of Resource Blocks of type Memory required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Memory required for the composition request.", + "description": "The maximum number of Resource Blocks of the Memory type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of the Memory type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -483,8 +483,8 @@ "versionAdded": "v1_3_0" }, "MaxNetwork": { - "description": "The minimum number of Resource Blocks of type Network required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.", + "description": "The maximum number of Resource Blocks of the Network type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of the Network type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -494,8 +494,8 @@ "versionAdded": "v1_3_0" }, "MaxProcessor": { - "description": "The minimum number of Resource Blocks of type Processor required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Processor required for the composition request.", + "description": "The maximum number of Resource Blocks of the Processor type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of Processor type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -505,8 +505,8 @@ "versionAdded": "v1_3_0" }, "MaxStorage": { - "description": "The minimum number of Resource Blocks of type Storage required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Storage required for the composition request.", + "description": "The maximum number of Resource Blocks of the Storage type allowed for the composition request.", + "longDescription": "This property shall contain an integer that specifies the maximum number of Resource Blocks of the Storage type allowed for the composition request.", "minimum": 1, "readonly": true, "type": [ @@ -516,8 +516,8 @@ "versionAdded": "v1_3_0" }, "MinCompute": { - "description": "The minimum number of Resource Blocks of type Compute required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Compute required for the composition request.", + "description": "The minimum number of Resource Blocks of the Compute type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Compute type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -527,8 +527,8 @@ "versionAdded": "v1_3_0" }, "MinComputerSystem": { - "description": "The minimum number of Resource Blocks of type ComputerSystem required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.", + "description": "The minimum number of Resource Blocks of the ComputerSystem type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Network type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -538,8 +538,8 @@ "versionAdded": "v1_3_0" }, "MinExpansion": { - "description": "The minimum number of Resource Blocks of type Expansion required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Expansion required for the composition request.", + "description": "The minimum number of Resource Blocks of the Expansion type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Expansion type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -549,8 +549,8 @@ "versionAdded": "v1_3_0" }, "MinMemory": { - "description": "The minimum number of Resource Blocks of type Memory required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Memory required for the composition request.", + "description": "The minimum number of Resource Blocks of the Memory type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Memory type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -560,8 +560,8 @@ "versionAdded": "v1_3_0" }, "MinNetwork": { - "description": "The minimum number of Resource Blocks of type Network required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.", + "description": "The minimum number of Resource Blocks of the Network type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Network type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -571,8 +571,8 @@ "versionAdded": "v1_3_0" }, "MinProcessor": { - "description": "The minimum number of Resource Blocks of type Processor required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Processor required for the composition request.", + "description": "The minimum number of Resource Blocks of the Processor type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Processor type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -582,8 +582,8 @@ "versionAdded": "v1_3_0" }, "MinStorage": { - "description": "The minimum number of Resource Blocks of type Storage required for the composition request.", - "longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Storage required for the composition request.", + "description": "The minimum number of Resource Blocks of the Storage type required for the composition request.", + "longDescription": "This property shall contain an integer that specifies the minimum number of Resource Blocks of the Storage type required for the composition request.", "minimum": 0, "readonly": true, "type": [ @@ -606,13 +606,13 @@ "Expansion" ], "enumDescriptions": { - "Compute": "This Resource Block contains both Processor and Memory resources in a manner that creates a compute complex.", - "ComputerSystem": "This Resource Block contains ComputerSystem resources.", + "Compute": "This Resource Block contains Resources of the Processor type and Memory type in a manner that creates a compute complex.", + "ComputerSystem": "This Resource Block contains Resources of the ComputerSystem type.", "Expansion": "This Resource Block is capable of changing over time based on its configuration. Different types of devices within this Resource Block can be added and removed over time.", - "Memory": "This Resource Block contains Memory resources.", - "Network": "This Resource Block contains Network resources, such as Ethernet Interfaces.", - "Processor": "This Resource Block contains Processor resources.", - "Storage": "This Resource Block contains Storage resources, such as Storage and Simple Storage." + "Memory": "This Resource Block contains Resources of the Memory type.", + "Network": "This Resource Block contains network Resources, such as the EthernetInterface and NetworkInterface types.", + "Processor": "This Resource Block contains Resources of the Processor type.", + "Storage": "This Resource Block contains storage Resources, such as the Storage and SimpleStorage types." }, "enumVersionAdded": { "Expansion": "v1_2_0" @@ -622,5 +622,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#ResourceBlock.v1_3_0.ResourceBlock" + "title": "#ResourceBlock.v1_3_2.ResourceBlock" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Role/Role.json b/static/redfish/v1/JsonSchemas/Role/Role.json index bb045c88c5..5584b8ba34 100644 --- a/static/redfish/v1/JsonSchemas/Role/Role.json +++ b/static/redfish/v1/JsonSchemas/Role/Role.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Role.v1_2_4.json", "$ref": "#/definitions/Role", "$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,18 +25,19 @@ "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" }, "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", @@ -53,10 +55,10 @@ }, "Role": { "additionalProperties": false, - "description": "This resource defines a user role to be used in conjunction with a Manager Account.", - "longDescription": "This resource shall be used to represent resources that represent the user role for the user account.", + "description": "The Role schema contains a Redfish Role to use in conjunction with a manager account.", + "longDescription": "This Resource represents the Redfish Role for the user account.", "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", @@ -71,28 +73,29 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AssignedPrivileges": { - "description": "The redfish privileges that this role includes.", + "description": "The Redfish privileges for this Role.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType" }, - "longDescription": "The value of this property shall be the redfish privileges that the role includes. For pre-defined roles, this property shall be readOnly. For custom roles some implementations may not allow writing this property.", + "longDescription": "This property shall contain the Redfish privileges for this Role. For predefined Roles, this property shall be read-only. For custom Roles, some implementations may not allow writing to this property.", "readonly": false, "type": "array" }, @@ -112,8 +115,8 @@ "readonly": true }, "IsPredefined": { - "description": "This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role.", - "longDescription": "The value of this property shall indicate if the role is a predefined role. .", + "description": "An indication of whether the Role is a Redfish-predefined Role rather than a custom Redfish Role.", + "longDescription": "This property shall indicate whether the Role is a Redfish-predefined Role rather than a custom Redfish Role.", "readonly": true, "type": "boolean" }, @@ -123,23 +126,24 @@ }, "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." }, "OemPrivileges": { - "description": "The OEM privileges that this role includes.", + "description": "The OEM privileges for this Role.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be the OEM privileges that this role includes. For pre-defined roles, this property shall be readOnly. For custom roles some implementations may not allow writing this property.", + "longDescription": "This property shall contain the OEM privileges for this Role. For predefined Roles, this property shall be read-only. For custom Roles, some implementations may not allow writing to this property.", "readonly": false, "type": "array" }, "RoleId": { - "description": "This property contains the name of the Role.", + "description": "The name of the Role.", "longDescription": "This property shall contain the string name of the Role. This property shall contain the same value as the Id property.", "readonly": true, - "type": "string" + "type": "string", + "versionAdded": "v1_2_0" } }, "required": [ @@ -155,5 +159,6 @@ } }, "owningEntity": "DMTF", - "title": "#Role.v1_2_2.Role" + "release": "2017.2", + "title": "#Role.v1_2_4.Role" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Schedule/Schedule.json b/static/redfish/v1/JsonSchemas/Schedule/Schedule.json index 81fee7a0c4..0333c51a75 100644 --- a/static/redfish/v1/JsonSchemas/Schedule/Schedule.json +++ b/static/redfish/v1/JsonSchemas/Schedule/Schedule.json @@ -1,9 +1,10 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Schedule.v1_2_1.json", "$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": { "DayOfWeek": { - "description": "Days of the Week.", + "description": "Days of the week.", "enum": [ "Monday", "Tuesday", @@ -25,9 +26,9 @@ "Wednesday": "Wednesday." }, "enumLongDescriptions": { - "Every": "This value indicates that every day of the week has been selected. When used in array properties (such as for enabling a function on certain days) it shall be the only member in the array." + "Every": "This value indicates that every day of the week has been selected. When used in array properties, such as for enabling a function on certain days, it shall be the only member in the array." }, - "longDescription": "Days of the Week.", + "longDescription": "Days of the week.", "type": "string" }, "MonthOfYear": { @@ -63,7 +64,7 @@ "September": "September." }, "enumLongDescriptions": { - "Every": "This value indicates that every month of the year has been selected. When used in array properties (such as for enabling a function for certain months) it shall be the only member in the array." + "Every": "This value indicates that every month of the year has been selected. When used in array properties, such as for enabling a function for certain months, it shall be the only member in the array." }, "longDescription": "Months of the year.", "type": "string" @@ -71,9 +72,9 @@ "Schedule": { "additionalProperties": false, "description": "Schedule a series of occurrences.", - "longDescription": "The properties of this type shall be used to Schedule a series of occurrences.", + "longDescription": "The properties of this type shall schedule a series of occurrences.", "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", @@ -88,21 +89,21 @@ }, "properties": { "EnabledDaysOfMonth": { - "description": "Days of month when scheduled occurrences are enabled. Zero indicates that every day of the month is enabled.", + "description": "Days of the month when scheduled occurrences are enabled. `0` indicates that every day of the month is enabled.", "items": { "type": [ "integer", "null" ] }, - "longDescription": "Days of month when scheduled occurrences are enabled, for enabled days of week and months of year. If the array contains a single value of zero, or if the property is not present, all days of the month shall be enabled.", + "longDescription": "This property shall contain the days of the month when scheduled occurrences are enabled, for enabled days of week and months of year. If the array contains a single value of `0`, or if the property is not present, all days of the month shall be enabled.", "maximum": 31, "minimum": 0, "readonly": false, "type": "array" }, "EnabledDaysOfWeek": { - "description": "Days of the week when scheduled occurrences are enabled, for enabled days of month and months of year.", + "description": "Days of the week when scheduled occurrences are enabled, for enabled days of the month and months of the year. If not present, all days of the week are enabled.", "items": { "anyOf": [ { @@ -113,7 +114,7 @@ } ] }, - "longDescription": "Days of the week when scheduled occurrences are enabled. If not present, all days of the week shall be enabled.", + "longDescription": "Days of the week when scheduled occurrences are enabled. If not present, all days of the week shall be enabled.", "readonly": false, "type": "array" }, @@ -127,10 +128,11 @@ }, "longDescription": "Each value shall be an ISO 8601 conformant interval specifying when occurences are enabled.", "readonly": false, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "EnabledMonthsOfYear": { - "description": "Months of year when scheduled occurrences are enabled.", + "description": "The months of the year when scheduled occurrences are enabled. If not present, all months of the year are enabled.", "items": { "anyOf": [ { @@ -141,14 +143,14 @@ } ] }, - "longDescription": "Months of year when scheduled occurrences are enabled, for enabled days of week and days of month. If not present, all months of the year shall be enabled.", + "longDescription": "This property shall contain the months of the year when scheduled occurrences are enabled, for enabled days of week and days of month. If not present, all months of the year shall be enabled.", "readonly": false, "type": "array" }, "InitialStartTime": { - "description": "Time for initial occurrence.", + "description": "The date and time when the initial occurrence is scheduled to occur.", "format": "date-time", - "longDescription": "The value shall be a date and time of day on which the initial occurrence is scheduled to occur.", + "longDescription": "This property shall contain the date and time when the initial occurrence is scheduled to occur.", "readonly": false, "type": [ "string", @@ -157,7 +159,7 @@ }, "Lifetime": { "description": "The time after provisioning when the schedule as a whole expires.", - "longDescription": "The value shall be a Redfish Duration describing the time after provisioning when the schedule expires.", + "longDescription": "This property shall contain a Redfish Duration that describes the time after provisioning when the schedule expires.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -166,8 +168,8 @@ ] }, "MaxOccurrences": { - "description": "Maximum number of scheduled occurrences.", - "longDescription": "Maximum number of scheduled occurrences.", + "description": "The maximum number of scheduled occurrences.", + "longDescription": "This property shall contain the maximum number of scheduled occurrences.", "readonly": false, "type": [ "integer", @@ -175,8 +177,8 @@ ] }, "Name": { - "description": "The Schedule name.", - "longDescription": "The name of the Schedule. It should be constructed as OrgID:ScheduleName. Examples: ACME:Daily, ACME:Weekly, ACME:FirstTuesday.", + "description": "The schedule name.", + "longDescription": "The name of the schedule, which is constructed as OrgID:ScheduleName. Examples include ACME:Daily, ACME:Weekly, and ACME:FirstTuesday.", "readonly": false, "type": [ "string", @@ -184,8 +186,8 @@ ] }, "RecurrenceInterval": { - "description": "Distance until the next occurrences.", - "longDescription": "The value shall be a Redfish Duration describing the time until the next occurrence.", + "description": "The amount of time until the next occurrence occurs.", + "longDescription": "This property shall contain a Redfish Duration that describes the time until the next occurrence.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -198,5 +200,6 @@ } }, "owningEntity": "DMTF", - "title": "#Schedule.v1_2_0" + "release": "2018.2", + "title": "#Schedule.v1_2_1" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json b/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json index ebc037ad19..7da70a4083 100644 --- a/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json +++ b/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/SecureBoot.v1_0_6.json", "$ref": "#/definitions/SecureBoot", "$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", @@ -27,18 +28,18 @@ }, "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." } }, "type": "object" }, "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", @@ -56,8 +57,8 @@ }, "ResetKeys": { "additionalProperties": false, - "description": "This action is used to reset the Secure Boot keys.", - "longDescription": "This action shall perform a reset of the Secure Boot key databases. The ResetAllKeysToDefault value shall reset the UEFI Secure Boot key databases to their default values. The DeleteAllKeys value shall delete the content of the UEFI Secure Boot key databases. The DeletePK value shall delete the content of the PK Secure boot key.", + "description": "This action resets the Secure Boot keys.", + "longDescription": "This action shall reset of the Secure Boot key databases. The ResetAllKeysToDefault value shall reset the UEFI Secure Boot key databases to their default values. The DeleteAllKeys value shall delete the content of the UEFI Secure Boot key databases. The DeletePK value shall delete the content of the PK Secure Boot key.", "parameters": { "ResetKeysType": { "$ref": "#/definitions/ResetKeysType", @@ -67,7 +68,7 @@ } }, "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", @@ -83,7 +84,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -100,18 +101,18 @@ "DeletePK" ], "enumDescriptions": { - "DeleteAllKeys": "Delete the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX). This puts the system in Setup Mode.", - "DeletePK": "Delete the content of the PK UEFI Secure Boot database. This puts the system in Setup Mode.", + "DeleteAllKeys": "Delete the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX). This puts the system in Setup Mode.", + "DeletePK": "Delete the content of the PK UEFI Secure Boot database. This puts the system in Setup Mode.", "ResetAllKeysToDefault": "Reset the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX) to their default values." }, "type": "string" }, "SecureBoot": { "additionalProperties": false, - "description": "This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.", - "longDescription": "This resource shall be used to represent a UEFI Secure Boot resource for a Redfish implementation.", + "description": "The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system.", + "longDescription": "This Resource contains a UEFI Secure Boot Resource 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", @@ -126,21 +127,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -163,8 +164,8 @@ }, "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." }, "SecureBootCurrentBoot": { "anyOf": [ @@ -176,12 +177,12 @@ } ], "description": "Secure Boot state during the current boot cycle.", - "longDescription": "The value of this property shall indicate the UEFI Secure Boot state during the current boot cycle.", + "longDescription": "This property shall indicate the UEFI Secure Boot state during the current boot cycle.", "readonly": true }, "SecureBootEnable": { - "description": "Enable or disable UEFI Secure Boot (takes effect on next boot).", - "longDescription": "Setting this property to true enables UEFI Secure Boot, and setting it to false disables it. This property can be enabled only in UEFI boot mode.", + "description": "An indication of whether UEFI Secure Boot is enabled.", + "longDescription": "This property shall indicate whether the UEFI Secure Boot takes effect on next boot. This property can be enabled in UEFI boot mode only.", "readonly": false, "type": [ "boolean", @@ -238,5 +239,6 @@ } }, "owningEntity": "DMTF", - "title": "#SecureBoot.v1_0_4.SecureBoot" + "release": "2016.1", + "title": "#SecureBoot.v1_0_6.SecureBoot" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Sensor/Sensor.json b/static/redfish/v1/JsonSchemas/Sensor/Sensor.json index 29a9ebf56f..603c1e6ca6 100644 --- a/static/redfish/v1/JsonSchemas/Sensor/Sensor.json +++ b/static/redfish/v1/JsonSchemas/Sensor/Sensor.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Sensor.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Sensor.v1_0_2.json", "$ref": "#/definitions/Sensor", "$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", @@ -28,8 +28,8 @@ }, "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." } }, "type": "object" @@ -55,16 +55,16 @@ "Total" ], "enumDescriptions": { - "Line1": "The circuits sharing L1 current-carrying conductor.", + "Line1": "The circuits that share the L1 current-carrying conductor.", "Line1ToLine2": "The circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.", "Line1ToNeutral": "The circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.", "Line1ToNeutralAndL1L2": "The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.", - "Line2": "The circuits sharing L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire. TwoPhase4Wire, or ThreePhase5Wire.", + "Line2": "The circuits that share the L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire, TwoPhase4Wire, or ThreePhase5Wire.", "Line2ToLine3": "The circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", "Line2ToNeutral": "The circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.", "Line2ToNeutralAndL1L2": "The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.", "Line2ToNeutralAndL2L3": "The circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.", - "Line3": "The circuits sharing L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", + "Line3": "The circuits that share the L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", "Line3ToLine1": "The circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", "Line3ToNeutral": "The circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.", "Line3ToNeutralAndL3L1": "The circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.", @@ -74,16 +74,16 @@ "Total": "The circuits formed by all current-carrying conductors for any PhaseWiringType." }, "enumLongDescriptions": { - "Line1": "This property shall contain the circuits sharing L1 current-carrying conductor when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.", + "Line1": "This property shall contain the circuits that share the L1 current-carrying conductor when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.", "Line1ToLine2": "This property shall contain the circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.", "Line1ToNeutral": "This property shall contain the circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.", "Line1ToNeutralAndL1L2": "This property shall contain the circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.", - "Line2": "This property shall contain the circuits sharing L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire. TwoPhase4Wire, or ThreePhase5Wire.", + "Line2": "This property shall contain the circuits that share the L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire, TwoPhase4Wire, or ThreePhase5Wire.", "Line2ToLine3": "This property shall contain the circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", "Line2ToNeutral": "This property shall contain the circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.", "Line2ToNeutralAndL1L2": "This property shall contain the circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.", "Line2ToNeutralAndL2L3": "This property shall contain the circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.", - "Line3": "This property shall contain the circuits sharing L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", + "Line3": "This property shall contain the circuits that share the L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", "Line3ToLine1": "This property shall contain the circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.", "Line3ToNeutral": "This property shall contain the circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.", "Line3ToNeutralAndL3L1": "This property shall contain the circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.", @@ -96,10 +96,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", @@ -136,10 +136,10 @@ "enumDescriptions": { "AirFlow": "Airflow.", "Altitude": "Altitude.", - "Barometric": "Barometric Pressure.", + "Barometric": "Barometric pressure.", "Current": "Current.", - "EnergyJoules": "Energy consumption (Joules).", - "EnergykWh": "Energy consumption (kW/h).", + "EnergyJoules": "Energy (Joules).", + "EnergykWh": "Energy (kWh).", "Frequency": "Frequency.", "Humidity": "Relative Humidity.", "LiquidFlow": "Liquid flow.", @@ -151,31 +151,31 @@ "Voltage": "Voltage (AC or DC)." }, "enumLongDescriptions": { - "AirFlow": "The value of the Reading property shall be a measurement of a volume of gas per unit of time that flows through a particular junction. The ReadingUnits shall be 'cft_i/min'.", - "Altitude": "The value of the Reading property shall be a measurement of altitude in meter units and the ReadingUnits value shall be 'm'.", - "Barometric": "the value of the Reading property shall be a measurement of barometric pressure in millimeters of a mercury column and the ReadingUnits value shall be 'mm[Hg]'.", - "Current": "The value of the Reading property shall be a measurement of the root mean square (RMS) of instantaneous current calculated over an integer number of line cycles for a circuit. Current is expressed in Amperes units and the ReadingUnits value shall be 'A'.", - "EnergyJoules": "The value of the Reading property shall indicate the energy consumption (integral of Real Power over time) of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in Joule units and the ReadingUnits value shall be 'J'. This type is used for device-level energy consumption measurements, while EnergykWh is used for large-scale consumption measurements.", - "EnergykWh": "The value of the Reading property shall indicate the energy consumption (integral of Real Power over time) of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in kilowatt-hour units and the ReadingUnits value shall be 'kW'. This type is used for large-scale energy consumption measurements, while EnergyJoules is used for device-level consumption measurements.", - "Frequency": "The value of the Reading property shall be a frequency measurement in Hertz units and the ReadingUnits value shall be 'Hz'.", - "Humidity": "The value of the Reading property shall be a relative humidity measurement in percent units and the ReadingUnits value shall be '%'.", - "LiquidFlow": "The value of the Reading property shall be a measurement of a volume of liquid per unit of time that flows through a particular junction. The ReadingUnits shall be 'L/s'.", - "LiquidLevel": "The value of the Reading property shall be a measurement of fluid height relative to a specified vertical datum and the ReadingUnits value shall be 'cm'.", - "Power": "The value of the Reading property shall be the arithmetic mean of product terms of instantaneous voltage and current values measured over integer number of line cycles for a circuit in Watt units and the ReadingUnits value shall be 'W'.", - "Pressure": "The value of the Reading property shall be a measurement of force applied perpendicular to the surface of an object per unit area over which that force is distributed. The ReadingUnits shall be 'Pa'.", - "Rotational": "The value of the Reading property shall be a measurement of rotational frequency in Revolutions per Minute unit and the ReadingUnits value shall be 'RPM'.", - "Temperature": "The value of the Reading property shall be a temperature measurement in degrees Celsius units and the ReadingUnits value shall be 'Cel'.", - "Voltage": "The value of the Reading property shall be a measurement of the root mean square (RMS) of instantaneous voltage calculated over an integer number of line cycles for a circuit. Voltage is expressed in Volts units and the ReadingUnits value shall be 'V'." + "AirFlow": "This value shall indicate a measurement of a volume of gas per unit of time that flows through a particular junction. The ReadingUnits shall be `cft_i/min`.", + "Altitude": "This value shall indicate a measurement of altitude, in meter units, and the ReadingUnits value shall be `m`.", + "Barometric": "This value shall indicate a measurement of barometric pressure, in millimeters, of a mercury column, and the ReadingUnits value shall be `mm[Hg]`.", + "Current": "This value shall indicate a measurement of the root mean square (RMS) of instantaneous current calculated over an integer number of line cycles for a circuit. Current is expressed in Amperes units and the ReadingUnits value shall be `A`.", + "EnergyJoules": "This value shall indicate the energy, integral of real power over time, of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in Joule units and the ReadingUnits value shall be `J`. This value is used for device-level energy consumption measurements, while EnergykWh is used for large-scale consumption measurements.", + "EnergykWh": "This value shall indicate the energy, integral of real power over time, of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in kilowatt-hour units and the ReadingUnits value shall be `kW.h`. This value is used for large-scale energy consumption measurements, while EnergyJoules is used for device-level consumption measurements.", + "Frequency": "This value shall indicate a frequency measurement, in Hertz units, and the ReadingUnits value shall be `Hz`.", + "Humidity": "This value shall indicate a relative humidity measurement, in percent units, and the ReadingUnits value shall be '%'.", + "LiquidFlow": "This value shall indicate a measurement of a volume of liquid per unit of time that flows through a particular junction. The ReadingUnits shall be `L/s`.", + "LiquidLevel": "This value shall indicate a measurement of fluid height relative to a specified vertical datum and the ReadingUnits value shall be `cm`.", + "Power": "This value shall indicate the arithmetic mean of product terms of instantaneous voltage and current values measured over integer number of line cycles for a circuit, in Watt units, and the ReadingUnits value shall be 'W'.", + "Pressure": "This value shall indicate a measurement of force applied perpendicular to the surface of an object per unit area over which that force is distributed. The ReadingUnits shall be `Pa`.", + "Rotational": "This value shall indicate a measurement of rotational frequency, in revolutions per minute unit, and the ReadingUnits value shall be `RPM`.", + "Temperature": "This value shall indicate a temperature measurement, in degrees Celsius units, and the ReadingUnits value shall be 'Cel'.", + "Voltage": "This value shall indicate a measurement of the root mean square (RMS) of instantaneous voltage calculated over an integer number of line cycles for a circuit. Voltage is expressed in Volts units and the ReadingUnits value shall be `V`." }, "type": "string" }, "ResetStatistics": { "additionalProperties": false, - "description": "This action is used to reset statistics related to this sensor.", - "longDescription": "This action shall perform a reset of any time intervals or counted values for this sensor.", + "description": "Resets statistics related to this sensor.", + "longDescription": "This action shall reset any time intervals or counted values for this sensor.", "parameters": {}, "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", @@ -191,7 +191,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -203,10 +203,10 @@ }, "Sensor": { "additionalProperties": false, - "description": "This schema defines a Sensor to be used in conjunction with data center equipment.", - "longDescription": "This resource shall be used to represent resources that represent the sensor data.", + "description": "The Sensor schema describes a sensor and its properties.", + "longDescription": "This Resource represents a Sensor 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", @@ -221,34 +221,35 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "Accuracy": { - "description": "Estimated percent error of measured vs. actual values.", - "longDescription": "The value of this property shall be the percent error +/- of the measured vs. actual values.", + "description": "The estimated percent error of measured versus actual values.", + "longDescription": "This property shall contain the percent error +/- of the measured versus actual values of the Reading property.", "readonly": true, "type": [ "number", "null" - ] + ], + "units": "%" }, "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." }, "AdjustedMaxAllowableOperatingValue": { - "description": "Adjusted maximum allowable operating value for this equipment based on the current environmental conditions present.", - "longDescription": "The value of this property shall indicate the adjusted maximum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", + "description": "The adjusted maximum allowable operating value for this equipment based on the environmental conditions.", + "longDescription": "This property shall contain the adjusted maximum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both. The value is adjusted based on environmental conditions. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", "readonly": true, "type": [ "number", @@ -256,8 +257,8 @@ ] }, "AdjustedMinAllowableOperatingValue": { - "description": "Adjusted minimum allowable operating value for this equipment based on the current environmental conditions present.", - "longDescription": "The value of this property shall indicate the adjusted minimum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", + "description": "The adjusted minimum allowable operating value for this equipment based on the environmental conditions.", + "longDescription": "This property shall contain the adjusted minimum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both. This value is adjusted based on environmental conditions. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", "readonly": true, "type": [ "number", @@ -265,9 +266,9 @@ ] }, "ApparentVA": { - "description": "The product of Voltage and Current for an AC circuit, in Volt-Amperes units.", + "description": "The product of voltage and current for an AC circuit, in Volt-Amperes units.", "excerpt": "SensorPower", - "longDescription": "This property shall indicate the product of VoltageRMS multiplied by CurrentRMS for a circuit. PowerApparentVA is expressed in Volt-Amperes units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall contain the product of VoltageRMS multiplied by CurrentRMS for a circuit. PowerApparentVA is expressed in Volt-Amperes units by using the ReadingUnits `V` value. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "readonly": true, "type": [ "number", @@ -295,7 +296,7 @@ } ], "description": "The combination of current-carrying conductors.", - "longDescription": "This property shall represent the combination of current-carrying conductors that are utilized to distribute power.", + "longDescription": "This property shall represent the combination of current-carrying conductors that distribute power.", "readonly": true }, "Id": { @@ -303,30 +304,24 @@ "readonly": true }, "LoadPercent": { - "description": "The power load utilization for this Sensor.", + "description": "The power load utilization for this sensor.", "excerpt": "SensorPower", - "longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall indicate the power load utilization percent for this sensor. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "readonly": true, "type": [ "number", "null" - ] + ], + "units": "%" }, "Location": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location" - }, - { - "type": "null" - } - ], - "description": "The location information for this Sensor.", - "longDescription": "This property shall indicate the location information of this Sensor." + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", + "description": "The location information for this sensor.", + "longDescription": "This property shall indicate the location information for this sensor." }, "MaxAllowableOperatingValue": { - "description": "Maximum allowable operating value for this equipment.", - "longDescription": "The value of this property shall indicate the maximum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination.", + "description": "The maximum allowable operating value for this equipment.", + "longDescription": "This property shall contain the maximum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both.", "readonly": true, "type": [ "number", @@ -334,8 +329,8 @@ ] }, "MinAllowableOperatingValue": { - "description": "Minimum allowable operating value for this equipment.", - "longDescription": "The value of this property shall indicate the minimum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination.", + "description": "The minimum allowable operating value for this equipment.", + "longDescription": "This property shall contain the minimum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both.", "readonly": true, "type": [ "number", @@ -349,13 +344,13 @@ }, "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." }, "PeakReading": { - "description": "The peak reading value for this sensor.", + "description": "The peak sensor value.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be the peak value of the Reading for this sensor during the last interval.", + "longDescription": "This property shall contain the peak sensor value since the last ResetStatistics action was performed or the service last reset the time-based property values.", "readonly": true, "type": [ "number", @@ -363,9 +358,9 @@ ] }, "PeakReadingTime": { - "description": "The time at which the Peak Reading value occurred.", + "description": "The time when the peak sensor value occurred.", "format": "date-time", - "longDescription": "The value of this property shall the timestamp when the Peak Reading value was observed.", + "longDescription": "This property shall contain the date and time when the peak sensor value was observed.", "readonly": true, "type": [ "string", @@ -381,9 +376,9 @@ "type": "null" } ], - "description": "Describes the area or device to which this sensor measurement applies.", + "description": "The area or device to which this sensor measurement applies.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be a description of the affected component or region within the equipment to which this sensor measurement applies.", + "longDescription": "This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies.", "readonly": true }, "PhysicalSubContext": { @@ -395,15 +390,15 @@ "type": "null" } ], - "description": "Describes the usage or location within a device to which this sensor measurement applies.", + "description": "The usage or location within a device to which this sensor measurement applies.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property is generally used to differentiate multiple sensors within the same instance of a PhysicalContext.", + "longDescription": "This property shall contain a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property generally differentiates multiple sensors within the same PhysicalContext instance.", "readonly": true }, "PowerFactor": { - "description": "The power factor for this Sensor.", + "description": "The power factor for this sensor.", "excerpt": "SensorPower", - "longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "maximum": 1, "minimum": 0, "readonly": true, @@ -413,8 +408,8 @@ ] }, "Precision": { - "description": "Number of significant digits in the Reading.", - "longDescription": "The value of this property shall specify the number of significant digits in the Reading.", + "description": "The number of significant digits in the reading.", + "longDescription": "This property shall contain the number of significant digits in the Reading property.", "readonly": true, "type": [ "number", @@ -422,9 +417,9 @@ ] }, "ReactiveVAR": { - "description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, expressed in VAR units.", + "description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in VAR units.", "excerpt": "SensorPower", - "longDescription": "This property shall indicate the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. PowerReactiveVAR is expressed in VAR units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall contain the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. PowerReactiveVAR is expressed in VAR units by using the ReadingUnits `V` value. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "readonly": true, "type": [ "number", @@ -432,9 +427,9 @@ ] }, "Reading": { - "description": "The present value for this Sensor.", + "description": "The sensor value.", "excerpt": "Sensor", - "longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred.", + "longDescription": "This property shall contain the sensor value.", "readonly": true, "type": [ "number", @@ -442,8 +437,8 @@ ] }, "ReadingRangeMax": { - "description": "The maximum value of Reading possible for this Sensor.", - "longDescription": "This property shall indicate the Max Reading Range information of this Sensor. This is the range of valid readings for this sensor. Values outside this range are discarded as reading errors.", + "description": "The maximum possible value for this sensor.", + "longDescription": "This property shall indicate the maximum possible value of the Reading property for this sensor. This value is the range of valid readings for this sensor. Values outside this range are discarded as reading errors.", "readonly": true, "type": [ "number", @@ -451,8 +446,8 @@ ] }, "ReadingRangeMin": { - "description": "The minimum value of Reading possible for this Sensor.", - "longDescription": "This property shall indicate the Min Reading Range information of this Sensor. This is the range of valid readings for this sensor. Values outside this range are discarded as reading errors.", + "description": "The minimum possible value for this sensor.", + "longDescription": "This property shall indicate the minimum possible value of the Reading property for this sensor. This value is the range of valid readings for this sensor. Values outside this range are discarded as reading errors.", "readonly": true, "type": [ "number", @@ -468,14 +463,14 @@ "type": "null" } ], - "description": "The kind of sensor being represented.", - "longDescription": "This property shall indicate the type of the sensor being represented.", + "description": "The type of sensor.", + "longDescription": "This property shall contain the type of the sensor.", "readonly": true }, "ReadingUnits": { - "description": "Units in which the reading and thresholds are measured.", + "description": "The units of the reading and thresholds.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be the units in which the sensor's reading and thresholds are measured.", + "longDescription": "This property shall contain the units of the sensor's reading and thresholds.", "readonly": true, "type": [ "string", @@ -484,7 +479,7 @@ }, "SensingFrequency": { "description": "The time interval between readings of the physical sensor.", - "longDescription": "The value of this property shall the time interval between reading the physical sensor.", + "longDescription": "This property shall contain the time interval between readings of the physical sensor.", "readonly": true, "type": [ "number", @@ -492,9 +487,9 @@ ] }, "SensorResetTime": { - "description": "The time at which the time-based properties were last reset.", + "description": "The date and time when the time-based properties were last reset.", "format": "date-time", - "longDescription": "The value of this property shall be the timestamp when the time-based property values were last reset by the user or the service.", + "longDescription": "This property shall contain the date and time when the ResetStatistics action was last performed or the service last reset the time-based property values.", "readonly": true, "type": [ "string", @@ -503,21 +498,14 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", "excerpt": "Sensor", - "longDescription": "This property shall contain any status or health properties of the resource." + "longDescription": "This property shall contain the status and health of the Resource and its children." }, "Thresholds": { - "anyOf": [ - { - "$ref": "#/definitions/Thresholds" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/Thresholds", "description": "The set of thresholds defined for this sensor.", - "longDescription": "This property shall contain the set of thresholds that are used to derive a sensor's health and operational range." + "longDescription": "This property shall contain the set of thresholds that derive a sensor's health and operational range." }, "VoltageType": { "anyOf": [ @@ -528,8 +516,8 @@ "type": "null" } ], - "description": "The voltage type (AC or DC) for this sensor.", - "longDescription": "This property shall represent the type of input voltage the sensor monitors. Please use AC for alternating current and DC for direct current.", + "description": "The voltage type for this sensor.", + "longDescription": "This property shall represent the type of input voltage the sensor monitors.", "readonly": true } }, @@ -543,11 +531,11 @@ }, "SensorExcerpt": { "additionalProperties": false, - "description": "This schema defines a Sensor to be used in conjunction with data center equipment.", + "description": "The Sensor schema describes a sensor and its properties.", "excerpt": "Sensor", - "longDescription": "This resource shall be used to represent resources that represent the sensor data.", + "longDescription": "This Resource represents a Sensor 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", @@ -562,10 +550,10 @@ }, "properties": { "DataSourceUri": { - "description": "A link to the resource that provides the data for this object.", + "description": "The link to the Resource that provides the data for this sensor.", "excerptCopyOnly": true, - "format": "uri", - "longDescription": "This property shall contain a URI to the resource that provides the source of the schema Excerpt contained within this copy.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI to the Resource that provides the source of the Excerpt contained within this copy.", "readonly": true, "type": [ "string", @@ -578,9 +566,9 @@ "readonly": true }, "PeakReading": { - "description": "The peak reading value for this sensor.", + "description": "The peak sensor value.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be the peak value of the Reading for this sensor during the last interval.", + "longDescription": "This property shall contain the peak sensor value since the last ResetStatistics action was performed or the service last reset the time-based property values.", "readonly": true, "type": [ "number", @@ -596,9 +584,9 @@ "type": "null" } ], - "description": "Describes the area or device to which this sensor measurement applies.", + "description": "The area or device to which this sensor measurement applies.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be a description of the affected component or region within the equipment to which this sensor measurement applies.", + "longDescription": "This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies.", "readonly": true }, "PhysicalSubContext": { @@ -610,15 +598,15 @@ "type": "null" } ], - "description": "Describes the usage or location within a device to which this sensor measurement applies.", + "description": "The usage or location within a device to which this sensor measurement applies.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property is generally used to differentiate multiple sensors within the same instance of a PhysicalContext.", + "longDescription": "This property shall contain a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property generally differentiates multiple sensors within the same PhysicalContext instance.", "readonly": true }, "Reading": { - "description": "The present value for this Sensor.", + "description": "The sensor value.", "excerpt": "Sensor", - "longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred.", + "longDescription": "This property shall contain the sensor value.", "readonly": true, "type": [ "number", @@ -626,9 +614,9 @@ ] }, "ReadingUnits": { - "description": "Units in which the reading and thresholds are measured.", + "description": "The units of the reading and thresholds.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be the units in which the sensor's reading and thresholds are measured.", + "longDescription": "This property shall contain the units of the sensor's reading and thresholds.", "readonly": true, "type": [ "string", @@ -637,9 +625,9 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", "excerpt": "Sensor", - "longDescription": "This property shall contain any status or health properties of the resource." + "longDescription": "This property shall contain the status and health of the Resource and its children." } }, "required": [ @@ -649,11 +637,11 @@ }, "SensorPowerExcerpt": { "additionalProperties": false, - "description": "This schema defines a Sensor to be used in conjunction with data center equipment.", + "description": "The Sensor schema describes a sensor and its properties.", "excerpt": "SensorPower", - "longDescription": "This resource shall be used to represent resources that represent the sensor data.", + "longDescription": "This Resource represents a Sensor 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", @@ -668,9 +656,9 @@ }, "properties": { "ApparentVA": { - "description": "The product of Voltage and Current for an AC circuit, in Volt-Amperes units.", + "description": "The product of voltage and current for an AC circuit, in Volt-Amperes units.", "excerpt": "SensorPower", - "longDescription": "This property shall indicate the product of VoltageRMS multiplied by CurrentRMS for a circuit. PowerApparentVA is expressed in Volt-Amperes units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall contain the product of VoltageRMS multiplied by CurrentRMS for a circuit. PowerApparentVA is expressed in Volt-Amperes units by using the ReadingUnits `V` value. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "readonly": true, "type": [ "number", @@ -678,10 +666,10 @@ ] }, "DataSourceUri": { - "description": "A link to the resource that provides the data for this object.", + "description": "The link to the Resource that provides the data for this sensor.", "excerptCopyOnly": true, - "format": "uri", - "longDescription": "This property shall contain a URI to the resource that provides the source of the schema Excerpt contained within this copy.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI to the Resource that provides the source of the Excerpt contained within this copy.", "readonly": true, "type": [ "string", @@ -689,14 +677,15 @@ ] }, "LoadPercent": { - "description": "The power load utilization for this Sensor.", + "description": "The power load utilization for this sensor.", "excerpt": "SensorPower", - "longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall indicate the power load utilization percent for this sensor. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "readonly": true, "type": [ "number", "null" - ] + ], + "units": "%" }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -704,9 +693,9 @@ "readonly": true }, "PeakReading": { - "description": "The peak reading value for this sensor.", + "description": "The peak sensor value.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be the peak value of the Reading for this sensor during the last interval.", + "longDescription": "This property shall contain the peak sensor value since the last ResetStatistics action was performed or the service last reset the time-based property values.", "readonly": true, "type": [ "number", @@ -722,9 +711,9 @@ "type": "null" } ], - "description": "Describes the area or device to which this sensor measurement applies.", + "description": "The area or device to which this sensor measurement applies.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be a description of the affected component or region within the equipment to which this sensor measurement applies.", + "longDescription": "This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies.", "readonly": true }, "PhysicalSubContext": { @@ -736,15 +725,15 @@ "type": "null" } ], - "description": "Describes the usage or location within a device to which this sensor measurement applies.", + "description": "The usage or location within a device to which this sensor measurement applies.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property is generally used to differentiate multiple sensors within the same instance of a PhysicalContext.", + "longDescription": "This property shall contain a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property generally differentiates multiple sensors within the same PhysicalContext instance.", "readonly": true }, "PowerFactor": { - "description": "The power factor for this Sensor.", + "description": "The power factor for this sensor.", "excerpt": "SensorPower", - "longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "maximum": 1, "minimum": 0, "readonly": true, @@ -754,9 +743,9 @@ ] }, "ReactiveVAR": { - "description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, expressed in VAR units.", + "description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in VAR units.", "excerpt": "SensorPower", - "longDescription": "This property shall indicate the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. PowerReactiveVAR is expressed in VAR units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.", + "longDescription": "This property shall contain the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. PowerReactiveVAR is expressed in VAR units by using the ReadingUnits `V` value. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.", "readonly": true, "type": [ "number", @@ -764,9 +753,9 @@ ] }, "Reading": { - "description": "The present value for this Sensor.", + "description": "The sensor value.", "excerpt": "Sensor", - "longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred.", + "longDescription": "This property shall contain the sensor value.", "readonly": true, "type": [ "number", @@ -774,9 +763,9 @@ ] }, "ReadingUnits": { - "description": "Units in which the reading and thresholds are measured.", + "description": "The units of the reading and thresholds.", "excerpt": "Sensor", - "longDescription": "The value of this property shall be the units in which the sensor's reading and thresholds are measured.", + "longDescription": "This property shall contain the units of the sensor's reading and thresholds.", "readonly": true, "type": [ "string", @@ -785,9 +774,9 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", "excerpt": "Sensor", - "longDescription": "This property shall contain any status or health properties of the resource." + "longDescription": "This property shall contain the status and health of the Resource and its children." } }, "required": [ @@ -797,10 +786,10 @@ }, "Threshold": { "additionalProperties": false, - "description": "A threshold definition for a sensor.", + "description": "The threshold definition for a sensor.", "longDescription": "This type shall contain the properties for an individual threshold for this sensor.", "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", @@ -824,12 +813,12 @@ } ], "description": "The direction of crossing that activates this threshold.", - "longDescription": "This property shall indicate the direction of crossing of the Reading value for this Sensor that triggers the threshold.", + "longDescription": "This property shall indicate the direction of crossing of the reading for this sensor that activates the threshold.", "readonly": false }, "DwellTime": { - "description": "The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.", - "longDescription": "This property shall indicate the time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.", + "description": "The duration the sensor value must violate the threshold before the threshold is activated.", + "longDescription": "This property shall indicate the duration the sensor value must violate the threshold before the threshold is activated.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -839,7 +828,7 @@ }, "Reading": { "description": "The threshold value.", - "longDescription": "This property shall indicate the Reading value of this Sensor that triggers the threshold. The units of this property shall follow the Reading and ReadingUnits of this sensor.", + "longDescription": "This property shall indicate the reading for this sensor that activates the threshold. The value of the property shall use the same units as the Reading property.", "readonly": false, "type": [ "number", @@ -861,18 +850,18 @@ "Increasing": "Value increases above the threshold." }, "enumLongDescriptions": { - "Decreasing": "This threshold is activated when the value of Reading changes from a value higher than the threshold to a value lower than the threshold.", - "Either": "This threshold is activated when either the Increasing or Decreasing conditions are met.", - "Increasing": "This threshold is activated when the value of Reading changes from a value lower than the threshold to a value higher than the threshold." + "Decreasing": "This threshold is activated when the reading changes from a value higher than the threshold to a value lower than the threshold.", + "Either": "This threshold is activated when either the increasing or decreasing conditions are met.", + "Increasing": "This threshold is activated when the reading changes from a value lower than the threshold to a value higher than the threshold." }, "type": "string" }, "Thresholds": { "additionalProperties": false, "description": "The set of thresholds defined for a sensor.", - "longDescription": "This object shall contain the set of thresholds that are used to derive a sensor's health and operational range.", + "longDescription": "This object shall contain the set of thresholds that derive a sensor's health and operational range.", "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", @@ -887,76 +876,34 @@ }, "properties": { "LowerCaution": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Below normal range.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is below normal range.", + "longDescription": "This property shall contain the value at which the Reading property is below normal range. The value of the property shall use the same units as the Reading property." }, "LowerCritical": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Below normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range and but is not yet fatal. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is below normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the Reading property is below the normal range but is not yet fatal. The value of the property shall use the same units as the Reading property." }, "LowerFatal": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Below normal range and fatal.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range and is fatal. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is below normal range and fatal.", + "longDescription": "This property shall contain the value at which the Reading property is below the normal range and is fatal. The value of the property shall use the same units as the Reading property." }, "UpperCaution": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Above normal range.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is above normal range.", + "longDescription": "This property shall contain the value at which the Reading property is above the normal range. The value of the property shall use the same units as the Reading property." }, "UpperCritical": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Above normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range and but is not yet fatal. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is above normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the Reading property is above the normal range but is not yet fatal. The value of the property shall use the same units as the Reading property." }, "UpperFatal": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Above normal range and fatal.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range and is fatal. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is above normal range and fatal.", + "longDescription": "This property shall contain the value at which the Reading property is above the normal range and is fatal. The value of the property shall use the same units as the Reading property." } }, "type": "object" @@ -967,13 +914,13 @@ "DC" ], "enumDescriptions": { - "AC": "Alternating Current.", - "DC": "Direct Current." + "AC": "Alternating current.", + "DC": "Direct durrent." }, "type": "string" } }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#Sensor.v1_0_0.Sensor" + "title": "#Sensor.v1_0_2.Sensor" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/SerialInterface/SerialInterface.json b/static/redfish/v1/JsonSchemas/SerialInterface/SerialInterface.json index 58810c4d12..6a9607070e 100644 --- a/static/redfish/v1/JsonSchemas/SerialInterface/SerialInterface.json +++ b/static/redfish/v1/JsonSchemas/SerialInterface/SerialInterface.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/SerialInterface.v1_1_5.json", "$ref": "#/definitions/SerialInterface", "$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" @@ -88,10 +90,10 @@ "8" ], "enumDescriptions": { - "5": "5 bits of data following the start bit.", - "6": "6 bits of data following the start bit.", - "7": "7 bits of data following the start bit.", - "8": "8 bits of data following the start bit." + "5": "Five bits of data following the start bit.", + "6": "Six bits of data following the start bit.", + "7": "Seven bits of data following the start bit.", + "8": "Eight bits of data following the start bit." }, "type": "string" }, @@ -102,7 +104,7 @@ "Hardware" ], "enumDescriptions": { - "Hardware": "Out of band flow control imposed.", + "Hardware": "Out-of-band flow control imposed.", "None": "No flow control imposed.", "Software": "XON/XOFF in-band flow control imposed." }, @@ -110,10 +112,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", @@ -153,18 +155,18 @@ "Digi" ], "enumDescriptions": { - "Cisco": "The Cisco pin configuration.", - "Cyclades": "The Cyclades pin configuration.", - "Digi": "The Digi pin configuration." + "Cisco": "The Cisco pinout configuration.", + "Cyclades": "The Cyclades pinout configuration.", + "Digi": "The Digi pinout configuration." }, "type": "string" }, "SerialInterface": { "additionalProperties": false, - "description": "This schema defines an asynchronous serial interface resource.", - "longDescription": "This resource shall be used to represent serial resources as part of the Redfish specification.", + "description": "The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.", + "longDescription": "This Resource contains SerialInterface Resources as part of the Redfish Specification.", "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", @@ -179,21 +181,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "BitRate": { "$ref": "#/definitions/BitRate", @@ -204,12 +207,12 @@ "ConnectorType": { "$ref": "#/definitions/ConnectorType", "description": "The type of connector used for this interface.", - "longDescription": "This property shall indicate the type of phyiscal connector used for this serial connection.", + "longDescription": "This property shall indicate the type of physical connector used for this serial connection.", "readonly": true }, "DataBits": { "$ref": "#/definitions/DataBits", - "description": "The number of data bits that will follow the start bit over the serial connection.", + "description": "The number of data bits that follow the start bit over the serial connection.", "longDescription": "This property shall indicate number of data bits for the serial connection.", "readonly": false }, @@ -226,7 +229,7 @@ }, "FlowControl": { "$ref": "#/definitions/FlowControl", - "description": "The type of flow control, if any, that will be imposed on the serial connection.", + "description": "The type of flow control, if any, that is imposed on the serial connection.", "longDescription": "This property shall indicate the flow control mechanism for the serial connection.", "readonly": false }, @@ -235,8 +238,8 @@ "readonly": true }, "InterfaceEnabled": { - "description": "This indicates whether this interface is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled.", + "description": "An indication of whether this interface is enabled.", + "longDescription": "This property shall indicate whether this interface is enabled.", "readonly": false, "type": [ "boolean", @@ -249,12 +252,12 @@ }, "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." }, "Parity": { "$ref": "#/definitions/Parity", - "description": "The type of parity used by the sender and receiver in order to detect errors over the serial connection.", + "description": "The type of parity used by the sender and receiver to detect errors over the serial connection.", "longDescription": "This property shall indicate parity information for a serial connection.", "readonly": false }, @@ -267,14 +270,14 @@ "type": "null" } ], - "description": "The physical pin configuration needed for a serial connector.", - "longDescription": "This property shall indicate the physical pin out for the serial connection.", + "description": "The physical pinout configuration for a serial connector.", + "longDescription": "This property shall indicate the physical pinout for the serial connector.", "readonly": true }, "SignalType": { "$ref": "#/definitions/SignalType", - "description": "The type of signal used for the communication connection - RS232 or RS485.", - "longDescription": "This property shall indicate the type of serial signalling that will be utilized for the serial connection.", + "description": "The type of signal used for the communication connection.", + "longDescription": "This property shall contain the type of serial signalling in use for the serial connection.", "readonly": true }, "StopBits": { @@ -309,12 +312,13 @@ "2" ], "enumDescriptions": { - "1": "1 stop bit following the data bits.", - "2": "2 stop bits following the data bits." + "1": "One stop bit following the data bits.", + "2": "Two stop bits following the data bits." }, "type": "string" } }, "owningEntity": "DMTF", - "title": "#SerialInterface.v1_1_3.SerialInterface" + "release": "2017.1", + "title": "#SerialInterface.v1_1_5.SerialInterface" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json b/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json index b76c7a134e..a49ab4328c 100644 --- a/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json +++ b/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ServiceRoot.v1_5_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ServiceRoot.v1_5_2.json", "$ref": "#/definitions/ServiceRoot", "$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": { "Expand": { "additionalProperties": false, - "description": "Contains information about the use of $expand in the service.", - "longDescription": "This type, as described by the Redfish Specification, shall contain information about the support of the $expand query parameter by the service.", + "description": "The information about the use of $expand in the service.", + "longDescription": "This type shall contain information about the support of the $expand query parameter by the service.", "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,29 +24,29 @@ }, "properties": { "ExpandAll": { - "description": "This indicates whether the $expand support of asterisk (expand all entries) is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of asterisk (expand all entries) as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether the service supports the asterisk (`*`) option of the $expand query parameter.", + "longDescription": "This property shall indicate whether this service supports the asterisk (`*`) option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "Levels": { - "description": "This indicates whether the expand support of the $levels qualifier is supported by the service.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of $levels as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether the service supports the $levels option of the $expand query parameter.", + "longDescription": "This property shall indicate whether the service supports the $levels option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "Links": { - "description": "This indicates whether the $expand support of tilde (expand only entries in the Links section) is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of tilde (expand only entries in the Links section) as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether this service supports the tilde (`~`) option of the $expand query parameter.", + "longDescription": "This property shall indicate whether this service supports the supports the tilde (~) option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "MaxLevels": { - "description": "This indicates the maximum number value of the $levels qualifier in $expand operations.", - "longDescription": "The value of this property shall be the maximum value of the $levels qualifier supported by the service and shall only be included if the value of the Levels property is true.", + "description": "The maximum $levels option value in the $expand query parameter.", + "longDescription": "This property shall contain the maximum $levels option value in the $expand query parameter. Shall be included only if $levels is true.", "maximum": 6, "minimum": 1, "readonly": true, @@ -54,8 +54,8 @@ "versionAdded": "v1_3_0" }, "NoLinks": { - "description": "This indicates whether the $expand support of period (expand only entries not in the Links section) is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of period (expand only entries not in the Links section) as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether the service supports the period (`.`) option of the $expand query parameter.", + "longDescription": "This property shall indicate whether the service supports the period (`.`) option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" @@ -65,10 +65,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -84,13 +84,13 @@ "properties": { "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." }, "Sessions": { "$ref": "http://redfish.dmtf.org/schemas/v1/SessionCollection.json#/definitions/SessionCollection", - "description": "Link to a collection of Sessions.", - "longDescription": "This property shall contain the link to a collection of Sessions.", + "description": "The link to a collection of Sessions.", + "longDescription": "This property shall contain a link to a Resource Collection of type SessionCollection.", "readonly": true } }, @@ -101,10 +101,10 @@ }, "ProtocolFeaturesSupported": { "additionalProperties": false, - "description": "Contains information about protocol features supported by the service.", - "longDescription": "This type contains information about protocol features supported by the service.", + "description": "The information about protocol features that the service supports.", + "longDescription": "This type shall contain information about protocol features that the service 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", @@ -119,35 +119,35 @@ }, "properties": { "ExcerptQuery": { - "description": "This indicates whether the 'excerpt' query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the 'excerpt' query parameter as described by the specification.", + "description": "An indication of whether the service supports the excerpt query parameter.", + "longDescription": "This property shall indicate whether this service supports the excerpt query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_4_0" }, "ExpandQuery": { "$ref": "#/definitions/Expand", - "description": "Contains information about the use of $expand in the service.", - "longDescription": "This type, as described by the Redfish Specification, shall contain information about the support of the $expand query parameter by the service.", + "description": "The information about the use of $expand in the service.", + "longDescription": "This property shall contain information about the support of the $expand query parameter by the service.", "versionAdded": "v1_3_0" }, "FilterQuery": { - "description": "This indicates whether the $filter query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the $filter query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "OnlyMemberQuery": { - "description": "This indicates whether the 'only' query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the 'only' query parameter as described by the specification.", + "description": "An indication of whether the service supports the only query parameter.", + "longDescription": "This property shall indicate whether this service supports the only query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_4_0" }, "SelectQuery": { - "description": "This indicates whether the $select query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the $select query parameter as described by the specification.", + "description": "An indication of whether the service supports the $select query parameter.", + "longDescription": "This property shall indicate whether this service supports the $select query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" @@ -157,10 +157,10 @@ }, "ServiceRoot": { "additionalProperties": false, - "description": "This object represents the root Redfish service.", - "longDescription": "This object represents the root Redfish service. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification.", + "description": "The ServiceRoot schema describes the root of the Redfish Service, located at the '/redfish/v1' URI. All other Resources accessible through the Redfish interface on this device are linked directly or indirectly from the Service Root.", + "longDescription": "This Resource represents the root Redfish Service. All values that this schema describes for Resources shall comply with the Redfish Specification-described requirements.", "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", @@ -175,40 +175,40 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "AccountService": { "$ref": "http://redfish.dmtf.org/schemas/v1/AccountService.json#/definitions/AccountService", - "description": "This is a link to the Account Service.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the AccountService schema.", + "description": "The link to the Account Service.", + "longDescription": "This property shall contain a link to a Resource of type AccountService.", "readonly": true }, "CertificateService": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateService.json#/definitions/CertificateService", - "description": "This is a link to the CertificateService.", - "longDescription": "The value shall be a link to the CertificateService.", + "description": "The link to the Certificate Service.", + "longDescription": "This property shall contain a link to a Resource of type CertificateService.", "readonly": true, "versionAdded": "v1_5_0" }, "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/ChassisCollection.json#/definitions/ChassisCollection", - "description": "This is a link to a collection of Chassis.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the Chassis schema.", + "description": "The link to a collection of chassis.", + "longDescription": "This property shall contain a link to a Resource Collection of type ChassisCollection.", "readonly": true }, "CompositionService": { "$ref": "http://redfish.dmtf.org/schemas/v1/CompositionService.json#/definitions/CompositionService", - "description": "This is a link to the CompositionService.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the CompositionService schema.", + "description": "The link to the Composition Service.", + "longDescription": "This property shall contain a link to a Resource of type CompositionService.", "readonly": true, "versionAdded": "v1_2_0" }, @@ -225,14 +225,14 @@ }, "EventService": { "$ref": "http://redfish.dmtf.org/schemas/v1/EventService.json#/definitions/EventService", - "description": "This is a link to the EventService.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the EventService schema.", + "description": "The link to the Event Service.", + "longDescription": "This property shall contain a link to a Resource of type EventService.", "readonly": true }, "Fabrics": { "$ref": "http://redfish.dmtf.org/schemas/v1/FabricCollection.json#/definitions/FabricCollection", - "description": "A link to a collection of all fabric entities.", - "longDescription": "The referenced collection shall contain references to all Fabric instances.", + "description": "The link to a collection of all fabric entities.", + "longDescription": "This property shall contain a link to a Resource Collection of type FabricCollection.", "readonly": true, "versionAdded": "v1_1_0" }, @@ -242,26 +242,26 @@ }, "JobService": { "$ref": "http://redfish.dmtf.org/schemas/v1/JobService.json#/definitions/JobService", - "description": "This is a link to the JobService.", - "longDescription": "The classes structure shall only contain a reference to a resource that conforms to the JobService schema.", + "description": "The link to the JobService.", + "longDescription": "This property shall contain a link to a Resource of type JobService.", "readonly": true, "versionAdded": "v1_4_0" }, "JsonSchemas": { "$ref": "http://redfish.dmtf.org/schemas/v1/JsonSchemaFileCollection.json#/definitions/JsonSchemaFileCollection", - "description": "This is a link to a collection of Json-Schema files.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the SchemaFile schema where the files are Json-Schema files.", + "description": "The link to a collection of JSON Schema files.", + "longDescription": "This property shall contain a link to a Resource Collection of type JsonSchemaFileCollection.", "readonly": true }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "Managers": { "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerCollection.json#/definitions/ManagerCollection", - "description": "This is a link to a collection of Managers.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the Managers schema.", + "description": "The link to a collection of managers.", + "longDescription": "This property shall contain a link to a Resource Collection of type ManagerCollection.", "readonly": true }, "Name": { @@ -270,12 +270,12 @@ }, "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." }, "Product": { - "description": "The product associated with this Redfish service.", - "longDescription": "The value of this string shall include the name of the product represented by this Redfish service.", + "description": "The product associated with this Redfish Service.", + "longDescription": "This property shall include the name of the product represented by this Redfish Service.", "readonly": true, "type": [ "string", @@ -285,66 +285,66 @@ }, "ProtocolFeaturesSupported": { "$ref": "#/definitions/ProtocolFeaturesSupported", - "description": "Contains information about protocol features supported by the service.", - "longDescription": "This type contains information about protocol features supported by the service.", + "description": "The information about protocol features that the service supports.", + "longDescription": "This property shall contain information about protocol features that the service supports.", "versionAdded": "v1_3_0" }, "RedfishVersion": { - "description": "The version of the Redfish service.", - "longDescription": "The value of this string shall represent the version of the Redfish service. 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 version of the Redfish Service.", + "longDescription": "This property shall represent the Redfish protocol version, as specified in the Protocol Version clause of the Redfish Specification, to which this Service conforms.", "pattern": "^\\d+\\.\\d+\\.\\d+$", "readonly": true, "type": "string" }, "Registries": { "$ref": "http://redfish.dmtf.org/schemas/v1/MessageRegistryFileCollection.json#/definitions/MessageRegistryFileCollection", - "description": "This is a link to a collection of Registries.", - "longDescription": "This object shall contain a reference to Message Registry.", + "description": "The link to a collection of Registries.", + "longDescription": "This property shall contain a link to a Resource Collection of type MessageRegistryFileCollection.", "readonly": true }, "ResourceBlocks": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlockCollection.json#/definitions/ResourceBlockCollection", - "description": "A link to a collection of all resource block entities. This collection is intended for implementations that do not contain a Composition Service, but will expose resources to an orchestrator that implements a Composition Service.", - "longDescription": "The referenced collection shall contain references to all Resource Block instances.", + "description": "The link to a collection of all Resource Block Resources. This collection is intended for implementations that do not contain a Composition Service but that expose Resources to an orchestrator that implements a Composition Service.", + "longDescription": "This property shall contain a link to a Resource Collection of type ResourceBlockCollection.", "readonly": true, "versionAdded": "v1_5_0" }, "SessionService": { "$ref": "http://redfish.dmtf.org/schemas/v1/SessionService.json#/definitions/SessionService", - "description": "This is a link to the Sessions Service.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the SessionService schema.", + "description": "The link to the Sessions Service.", + "longDescription": "This property shall contain a link to a Resource of type SessionService.", "readonly": true }, "StorageServices": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageServiceCollection.json#/definitions/StorageServiceCollection", - "description": "A link to a collection of all storage service entities.", - "longDescription": "The referenced collection shall contain references to all StorageService instances.", + "description": "The link to a collection of all storage service entities.", + "longDescription": "This property shall contain a link to a Resource Collection of type StorageServiceCollection.", "readonly": true, "versionAdded": "v1_1_0" }, "StorageSystems": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageSystemCollection.json#/definitions/StorageSystemCollection", - "description": "This is a link to a collection of storage systems.", - "longDescription": "The referenced collection shall contain computer systems that act as storage servers. The HostingRoles attribute of each such computer system shall have an entry for StorageServer.", + "description": "The link to a collection of storage systems.", + "longDescription": "This property shall contain a link to a Resource Collection of type StorageSystemCollection. This collection shall contain computer systems that act as storage servers. The HostingRoles attribute of each such computer system shall have a StorageServer entry.", "readonly": true, "versionAdded": "v1_1_0" }, "Systems": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystemCollection.json#/definitions/ComputerSystemCollection", - "description": "This is a link to a collection of Systems.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the Systems schema.", + "description": "The link to a collection of systems.", + "longDescription": "This property shall contain a link to a Resource Collection of type ComputerSystemCollection.", "readonly": true }, "Tasks": { "$ref": "http://redfish.dmtf.org/schemas/v1/TaskService.json#/definitions/TaskService", - "description": "This is a link to the Task Service.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the TaskService schema.", + "description": "The link to the Task Service.", + "longDescription": "This property shall contain a link to a Resource of type TaskService.", "readonly": true }, "TelemetryService": { "$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryService.json#/definitions/TelemetryService", - "description": "This is a link to the TelemetryService.", - "longDescription": "The value shall be a link to the TelemetryService.", + "description": "The link to the Telemetry Service.", + "longDescription": "This property shall contain a link to a Resource of type TelemetryService.", "readonly": true, "versionAdded": "v1_4_0" }, @@ -357,20 +357,20 @@ "type": "null" } ], - "description": "Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.", - "longDescription": "The value of this string shall represent the id of the Redfish service instance. The format of this string shall be a 32-byte value in the form 8-4-4-4-12. If SSDP is used, this value shall be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery. RFC4122 describes methods that can be used to create a UUID value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", + "description": "Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200 OK from an SSDP M-SEARCH request during discovery.", + "longDescription": "This property shall represent the id of the Redfish Service instance. The format of this string shall contain a 32-byte value in the form 8-4-4-4-12. If SSDP is used, this value shall be an exact match of the UUID value returned in a 200 OK from an SSDP M-SEARCH request during discovery. RFC4122 describes methods to use to create a UUID value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", "readonly": true }, "UpdateService": { "$ref": "http://redfish.dmtf.org/schemas/v1/UpdateService.json#/definitions/UpdateService", - "description": "This is a link to the UpdateService.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the UpdateService schema.", + "description": "The link to the Update Service.", + "longDescription": "This property shall contain a link to a Resource of type UpdateService.", "readonly": true, "versionAdded": "v1_1_0" }, "Vendor": { - "description": "The vendor or manufacturer associated with this Redfish service.", - "longDescription": "The value of this string shall include the name of the manufacturer or vendor represented by this Redfish service. If this property is supported, the vendor name shall not be included in the value of the Product property.", + "description": "The vendor or manufacturer associated with this Redfish Service.", + "longDescription": "This property shall include the name of the manufacturer or vendor represented by this Redfish Service. If this property is supported, the vendor name shall not be included in the Product property value.", "readonly": true, "type": [ "string", @@ -391,5 +391,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#ServiceRoot.v1_5_0.ServiceRoot" + "title": "#ServiceRoot.v1_5_2.ServiceRoot" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Session/Session.json b/static/redfish/v1/JsonSchemas/Session/Session.json index 85a7276a74..1478ea5f72 100644 --- a/static/redfish/v1/JsonSchemas/Session/Session.json +++ b/static/redfish/v1/JsonSchemas/Session/Session.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Session.v1_2_1.json", "$ref": "#/definitions/Session", "$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,18 +25,19 @@ "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" }, "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", @@ -53,10 +55,10 @@ }, "Session": { "additionalProperties": false, - "description": "The Session resource describes a single connection (session) between a client and a Redfish service instance.", - "longDescription": "This resource shall be used to represent a session for a Redfish implementation.", + "description": "The Session Resource describes a single connection (session) between a client and a Redfish Service instance.", + "longDescription": "This Resource shall represent a session 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", @@ -71,21 +73,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": [ @@ -108,21 +111,45 @@ }, "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." + }, + "OemSessionType": { + "description": "The active OEM-defined session type.", + "longDescription": "When SessionType is reported as OEM, this property should report the OEM-specific session type. Thus, this property shall represent the type of OEM session that is currently active.", + "readonly": true, + "type": [ + "string", + "null" + ], + "versionAdded": "v1_2_0" }, "Password": { - "description": "This property is used in a POST to specify a password when creating a new session. This property is null on a GET.", - "longDescription": "The value of this property shall be the password for this session. The value shall be null for GET requests.", + "description": "The password for this session. The value is `null` in responses.", + "longDescription": "This property shall contain the password for this session. The value shall be `null` in responses.", "readonly": true, "type": [ "string", "null" ] }, + "SessionType": { + "anyOf": [ + { + "$ref": "#/definitions/SessionTypes" + }, + { + "type": "null" + } + ], + "description": "The active session type.", + "longDescription": "This property shall represent the type of session that is currently active.", + "readonly": true, + "versionAdded": "v1_2_0" + }, "UserName": { "description": "The UserName for the account for this session.", - "longDescription": "The value of this property shall be the UserName that matches a registered account identified by a ManagerAccount resource registered with the Account Service.", + "longDescription": "This property shall contain the user name that matches an account recognized by the Account Service.", "readonly": true, "type": [ "string", @@ -141,8 +168,32 @@ "Password" ], "type": "object" + }, + "SessionTypes": { + "enum": [ + "HostConsole", + "ManagerConsole", + "IPMI", + "KVMIP", + "OEM", + "Redfish", + "VirtualMedia", + "WebUI" + ], + "enumDescriptions": { + "HostConsole": "The host's console, which could be connected through Telnet, SSH, or other protocol.", + "IPMI": "Intelligent Platform Management Interface.", + "KVMIP": "Keyboard-Video-Mouse over IP Session.", + "ManagerConsole": "The manager's console, which could be connected through Telnet, SSH, SM CLP, or other protocol.", + "OEM": "OEM Type. For OEM session types, see the OemSessionType property.", + "Redfish": "A Redfish session.", + "VirtualMedia": "Virtual media.", + "WebUI": "A non-Redfish web user interface session, such as a graphical interface or another web-based protocol." + }, + "type": "string" } }, "owningEntity": "DMTF", - "title": "#Session.v1_1_1.Session" + "release": "2019.1", + "title": "#Session.v1_2_1.Session" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/SessionService/SessionService.json b/static/redfish/v1/JsonSchemas/SessionService/SessionService.json index 488092ccbf..e597bfd43e 100644 --- a/static/redfish/v1/JsonSchemas/SessionService/SessionService.json +++ b/static/redfish/v1/JsonSchemas/SessionService/SessionService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/SessionService.v1_1_6.json", "$ref": "#/definitions/SessionService", "$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", @@ -23,26 +24,20 @@ }, "properties": { "Oem": { - "anyOf": [ - { - "$ref": "#/definitions/OemActions" - }, - { - "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." + "$ref": "#/definitions/OemActions", + "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" }, "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", @@ -60,10 +55,10 @@ }, "SessionService": { "additionalProperties": false, - "description": "This is the schema definition for the Session Service. It represents the properties for the service itself and has links to the actual list of sessions.", - "longDescription": "This resource shall be used to represent the Session Service Properties for a Redfish implementation.", + "description": "The SessionService schema describes the Session Service and its properties, with links to the actual list of sessions.", + "longDescription": "This Resource contains the Session Service properties 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", @@ -78,21 +73,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": [ @@ -115,12 +111,12 @@ }, "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." }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled. If set to false, the Session Service is disabled, and new sessions cannot be created, old sessions cannot be deleted, and established sessions may continue operating.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled. If disabled, new sessions shall not be created, old sessions shall not be deleted, and established sessions may continue operating.", + "description": "An indication of whether this service is enabled. If `true`, this service is enabled. If `false`, it is disabled, and new sessions cannot be created, old sessions cannot be deleted, and established sessions may continue operating.", + "longDescription": "This property shall indicate whether this service is enabled. If `true`, this service is enabled. If `false`, it is disabled, and new sessions shall not be created, old sessions shall not be deleted, and established sessions may continue operating.", "readonly": false, "type": [ "boolean", @@ -128,8 +124,8 @@ ] }, "SessionTimeout": { - "description": "This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity.", - "longDescription": "This property shall reference the threshold of time in seconds between requests on a specific session at which point the session service shall close the session due to inactivity. The session service shall support any value between the Validation.Minimum and Validation.Maximum.", + "description": "The number of seconds of inactivity that a session may have before the Session Service closes the session due to inactivity.", + "longDescription": "This property shall contain the threshold of time in seconds between requests on a specific session at which point the Session Service shall close the session due to inactivity. The Session Service shall support any value between the Validation.Minimum and Validation.Maximum.", "maximum": 86400, "minimum": 30, "readonly": false, @@ -138,14 +134,14 @@ }, "Sessions": { "$ref": "http://redfish.dmtf.org/schemas/v1/SessionCollection.json#/definitions/SessionCollection", - "description": "Link to a collection of Sessions.", - "longDescription": "This property shall contain the link to a collection of Sessions.", + "description": "The link to a collection of sessions.", + "longDescription": "This property shall contain the link to a Resource Collection of type SessionCollection.", "readonly": true }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -158,5 +154,6 @@ } }, "owningEntity": "DMTF", - "title": "#SessionService.v1_1_4.SessionService" + "release": "2016.2", + "title": "#SessionService.v1_1_6.SessionService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Settings/Settings.json b/static/redfish/v1/JsonSchemas/Settings/Settings.json index f823060954..40a1df4195 100644 --- a/static/redfish/v1/JsonSchemas/Settings/Settings.json +++ b/static/redfish/v1/JsonSchemas/Settings/Settings.json @@ -1,6 +1,7 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Settings.v1_2_2.json", "$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": { "ApplyTime": { "enum": [ @@ -16,19 +17,19 @@ "OnReset": "Apply on a reset." }, "enumLongDescriptions": { - "AtMaintenanceWindowStart": "This ApplyTime value shall be used to indicate the values within the Settings resource are applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window.", - "Immediate": "This ApplyTime value shall be used to indicate the values within the Settings resource are applied immediately.", - "InMaintenanceWindowOnReset": "This ApplyTime value shall be used to indicate the values within the Settings resource are applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window.", - "OnReset": "This ApplyTime value shall be used to indicate the values within the Settings resource are applied when the system or service is reset." + "AtMaintenanceWindowStart": "This value shall indicate the values within the Settings Resource are applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window.", + "Immediate": "This value shall indicate the values within the Settings Resource are applied immediately.", + "InMaintenanceWindowOnReset": "This value shall indicate the values within the Settings Resource are applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window.", + "OnReset": "This value shall indicate the values within Settings Resource are applied when the system or service is reset." }, "type": "string" }, "MaintenanceWindow": { "additionalProperties": false, - "description": "This object indicates if a given resource has a maintenance window assignment for applying settings or operations.", - "longDescription": "This object shall indicate if a given resource has a maintenance window assignment for applying settings or operations. Other resources may reference this object in order to convey a common control surface for the configuration of the maintenance window.", + "description": "The maintenance window assignment for applying settings or operations to a Resource.", + "longDescription": "This type shall indicate that a Resource has a maintenance window assignment for applying settings or operations. Other Resources may link to this object to convey a common control surface for the configuration of the maintenance window.", "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", @@ -43,19 +44,21 @@ }, "properties": { "MaintenanceWindowDurationInSeconds": { - "description": "The value of this property as specified by client indicates the expiry time of maintenance window in seconds.", - "longDescription": "The value of this property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property.", + "description": "The expiry time of maintenance window in seconds.", + "longDescription": "This property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property.", "minimum": 0, "readonly": false, "type": "integer", - "units": "s" + "units": "s", + "versionAdded": "v1_2_0" }, "MaintenanceWindowStartTime": { - "description": "The value of this property as specified by client to indicate the start time of a maintenance window.", + "description": "The start time of a maintenance window.", "format": "date-time", - "longDescription": "The value of this property shall indicate the date and time as to when the service is allowed to start applying the requested settings or operation as part of a maintenance window.", + "longDescription": "This property shall indicate the date and time when the service can start to apply the requested settings or operation as part of a maintenance window.", "readonly": false, - "type": "string" + "type": "string", + "versionAdded": "v1_2_0" } }, "required": [ @@ -64,33 +67,12 @@ ], "type": "object" }, - "OperationApplyTime": { - "enum": [ - "Immediate", - "OnReset", - "AtMaintenanceWindowStart", - "InMaintenanceWindowOnReset" - ], - "enumDescriptions": { - "AtMaintenanceWindowStart": "Apply the requested operation during a maintenance window as specified by an administrator.", - "Immediate": "Apply the requested operation immediately.", - "InMaintenanceWindowOnReset": "Apply the requested operation after a reset but within maintenance window as specified by an adminstrator.", - "OnReset": "Apply the requested operation on a reset." - }, - "enumLongDescriptions": { - "AtMaintenanceWindowStart": "This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window.", - "Immediate": "This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied immediately.", - "InMaintenanceWindowOnReset": "This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window.", - "OnReset": "This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied when the system or service is reset." - }, - "type": "string" - }, "OperationApplyTimeSupport": { "additionalProperties": false, - "description": "This object indicates if a client is allowed to request for a specific apply time of a Create, Delete, or Action operation of a given resource.", - "longDescription": "This object shall specify the support a service has for a client to request a specific apply time of a Create, Delete, or Action operation of a given resource.", + "description": "The client can request a specific apply time of a create, delete, or action operation of a Resource.", + "longDescription": "This type shall indicate that a client can request a specific apply time of a create, delete, or action operation of a 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", @@ -105,34 +87,38 @@ }, "properties": { "MaintenanceWindowDurationInSeconds": { - "description": "The value of this property as specified by client indicates the expiry time of maintenance window in seconds.", - "longDescription": "The value of this property shall be the same as the MaintenanceWindowDurationInSeconds property found in the MaintenanceWindow structure on the MaintenanceWindowResource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "description": "The expiry time of maintenance window in seconds.", + "longDescription": "This property shall contain the same as the MaintenanceWindowDurationInSeconds property found in the MaintenanceWindow structure on the MaintenanceWindowResource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", "minimum": 0, "readonly": true, "type": "integer", - "units": "s" + "units": "s", + "versionAdded": "v1_2_0" }, "MaintenanceWindowResource": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", - "description": "The value of this property is used to indicate the location of the maintenance window settings.", - "longDescription": "The value of this property shall be a reference to a resource that contains the @Redfish.MaintenanceWindow property which governs this resource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", - "readonly": true + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", + "description": "The location of the maintenance window settings.", + "longDescription": "This property shall contain a link to a Resource that contains the @Redfish.MaintenanceWindow property that governs this Resource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "readonly": true, + "versionAdded": "v1_2_0" }, "MaintenanceWindowStartTime": { - "description": "The value of this property as specified by client to indicate the start time of a maintenance window.", + "description": "The start time of a maintenance window.", "format": "date-time", - "longDescription": "The value of this property shall be the same as the MaintenanceWindowStartTime property found in the MaintenanceWindow structure on the MaintenanceWindowResource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "longDescription": "This property shall contain the same as the MaintenanceWindowStartTime property found in the MaintenanceWindow structure on the MaintenanceWindowResource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", "readonly": true, - "type": "string" + "type": "string", + "versionAdded": "v1_2_0" }, "SupportedValues": { - "description": "This property indicates the types of apply times the client is allowed request when performing a Create, Delete, or Action operation.", + "description": "The types of apply times that the client can request when performing a create, delete, or action operation.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTime" }, - "longDescription": "The value of this property shall indicate the types of apply times the client is allowed request when performing a Create, Delete, or Action operation.", + "longDescription": "This property shall indicate the types of apply times the client can request when performing a create, delete, or action operation.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" } }, "required": [ @@ -142,10 +128,10 @@ }, "PreferredApplyTime": { "additionalProperties": false, - "description": "This object indicates when the future configuration (i.e. Settings resource) should be applied.", - "longDescription": "This object shall be specified by client in a request to indicate its preference on when to apply the values in this Settings resource.", + "description": "The preferred time to apply configuration settings.", + "longDescription": "This type shall be specified by client to indicate the preferred time to apply the configuration settings.", "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", @@ -161,34 +147,37 @@ "properties": { "ApplyTime": { "$ref": "#/definitions/ApplyTime", - "description": "This property indicates when the future configuration (i.e. Settings resource) should be applied.", - "longDescription": "The value of this property shall indicate the preference on to when to apply the values in this Settings resource.", - "readonly": false + "description": "The time when to apply the settings.", + "longDescription": "This property shall indicate when to apply the values in this Settings Resource.", + "readonly": false, + "versionAdded": "v1_1_0" }, "MaintenanceWindowDurationInSeconds": { - "description": "The value of this property as specified by client indicates the expiry time of maintenance window in seconds.", - "longDescription": "The value of this property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property. This property shall be required if the ApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "description": "The expiry time of maintenance window in seconds.", + "longDescription": "This property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property. This property shall be required if the ApplyTime property is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`.", "minimum": 0, "readonly": false, "type": "integer", - "units": "s" + "units": "s", + "versionAdded": "v1_1_0" }, "MaintenanceWindowStartTime": { - "description": "The value of this property as specified by client to indicate the start time of a maintenance window.", + "description": "The start time of a maintenance window.", "format": "date-time", - "longDescription": "The value of this property shall indicate the date and time as to when the service is allowed to start applying the future configuration as part of a maintenance window. This property shall be required if the ApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "longDescription": "This property shall indicate the date and time when the service can start to apply the future configuration as part of a maintenance window. This property shall be required if the ApplyTime property is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`.", "readonly": false, - "type": "string" + "type": "string", + "versionAdded": "v1_1_0" } }, "type": "object" }, "Settings": { "additionalProperties": false, - "description": "This type describes the settings of a resouce.", - "longDescription": "This type shall describe any attributes of a resouce.", + "description": "The Resource settings.", + "longDescription": "This type shall describe any settings of a 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", @@ -203,8 +192,8 @@ }, "properties": { "ETag": { - "description": "The ETag of the resource to which the settings were applied, after the application.", - "longDescription": "The value of this property shall be the ETag of the resource to which the settings were applied, after the application. This is here so that the client can check it against the ETag of the current resource to see if any other changes have also happened to the resource.", + "description": "The entity tag (ETag) of the Resource to which the settings were applied, after the application.", + "longDescription": "This property shall contain the entity tag (ETag) of the Resource to which the settings were applied, after the application. The client can check this value against the ETag of this Resource to determine whether the Resource had other changes.", "readonly": true, "type": [ "string", @@ -212,38 +201,40 @@ ] }, "MaintenanceWindowResource": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", - "description": "The value of this property is used to indicate the location of the maintenance window settings.", - "longDescription": "The value of this property shall be a reference to a resource that contains the @Redfish.MaintenanceWindow property which governs this resource. This property should be supported if the SupportedApplyTimes property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", - "readonly": true + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", + "description": "The location of the maintenance window settings.", + "longDescription": "This property shall contain a link to a Resource that contains the @Redfish.MaintenanceWindow property that governs this Resource. This property should be supported if the SupportedApplyTimes property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "readonly": true, + "versionAdded": "v1_2_0" }, "Messages": { - "description": "This is an array of messages associated with the task.", + "description": "An array of messages associated with the settings.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message" }, - "longDescription": "The value of this property shall be an array of messages associated with the task.", + "longDescription": "This property shall contain an array of messages associated with the settings.", "type": "array" }, "SettingsObject": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef", - "description": "Reference to the resource the client may PUT/PATCH to in order to change this resource.", - "longDescription": "The value of this property shall be the URI of the resource to which a client must do a PUT or PATCH in order to modify this resource.", + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", + "description": "The link to the Resource that the client may PUT or PATCH to modify the Resource.", + "longDescription": "This property shall contain the URI of the Resource that the client may PUT or PATCH to modify the Resource.", "readonly": true }, "SupportedApplyTimes": { - "description": "This property indicates when a Settings resource can be applied.", + "description": "The time when the settings can be applied.", "items": { "$ref": "#/definitions/ApplyTime" }, - "longDescription": "A service shall advertise its applytime capabilities using this property as to when a Setting resource can be applied.", + "longDescription": "A service shall advertise its applytime capabilities by using this property to set the time when the settings can be applied.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "Time": { - "description": "Indicates the time the settings were applied.", + "description": "The time when the settings were applied.", "format": "date-time", - "longDescription": "The value of this property shall indicate the time that the settings object was applied to the resource.", + "longDescription": "This property shall indicate the time when the settings were applied to the Resource.", "readonly": true, "type": [ "string", @@ -255,5 +246,6 @@ } }, "owningEntity": "DMTF", - "title": "#Settings.v1_2_1" + "release": "2018.1", + "title": "#Settings.v1_2_2" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/SimpleStorage/SimpleStorage.json b/static/redfish/v1/JsonSchemas/SimpleStorage/SimpleStorage.json index d14dade66e..f91ad8e42b 100644 --- a/static/redfish/v1/JsonSchemas/SimpleStorage/SimpleStorage.json +++ b/static/redfish/v1/JsonSchemas/SimpleStorage/SimpleStorage.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/SimpleStorage.v1_2_3.json", "$ref": "#/definitions/SimpleStorage", "$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,18 +25,19 @@ "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_2_0" } }, "type": "object" }, "Device": { "additionalProperties": false, - "description": "A storage device such as a disk drive or optical media device.", - "longDescription": "This type shall describe a storage device visible to SimpleStorage.", + "description": "A storage device, such as a disk drive or optical media device.", + "longDescription": "This type shall describe a storage device visible to simple storage.", "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,15 +52,16 @@ }, "properties": { "CapacityBytes": { - "description": "The size of the storage device.", - "longDescription": "The value of this property shall represent the size (in bytes) of the Storage Device.", + "description": "The size, in bytes, of the storage device.", + "longDescription": "This property shall represent the size, in bytes, of the storage device.", "minimum": 0, "readonly": true, "type": [ "integer", "null" ], - "units": "By" + "units": "By", + "versionAdded": "v1_1_0" }, "Manufacturer": { "description": "The name of the manufacturer of this device.", @@ -79,20 +82,20 @@ ] }, "Name": { - "description": "The name of the resource or array element.", - "longDescription": "This object represents the Name property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification. The value of this string shall be of the format for the reserved word *Name*.", + "description": "The name of the Resource or array member.", + "longDescription": "This object represents the name of this Resource or array member. The Resource values shall comply with the Redfish Specification-described requirements. This string value shall be of the 'Name' reserved word format.", "readonly": true, "type": "string" }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -102,10 +105,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -121,24 +124,25 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the Chassis which contains this Simple Storage.", - "longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Simple Storage.", - "readonly": true + "description": "The link to the chassis that contains this simple storage.", + "longDescription": "This property shall contain a link to a Resource of type Chassis that represents the physical container associated with this Resource.", + "readonly": true, + "versionAdded": "v1_2_0" }, "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." } }, "type": "object" }, "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", @@ -156,10 +160,10 @@ }, "SimpleStorage": { "additionalProperties": false, - "description": "This is the schema definition for the Simple Storage resource. It represents the properties of a storage controller and its directly-attached devices.", - "longDescription": "This resource shall be used to represent a storage controller and its directly-attached devices.", + "description": "The SimpleStorage schema represents the properties of a storage controller and its directly-attached devices.", + "longDescription": "This Resource contains a storage controller and its directly-attached devices.", "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", @@ -174,21 +178,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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_2_0" }, "Description": { "anyOf": [ @@ -202,11 +207,11 @@ "readonly": true }, "Devices": { - "description": "The storage devices associated with this resource.", + "description": "The storage devices.", "items": { "$ref": "#/definitions/Device" }, - "longDescription": "This property shall contain a list of storage devices associated with this resource.", + "longDescription": "This property shall contain a list of storage devices related to this Resource.", "type": "array" }, "Id": { @@ -215,8 +220,9 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", + "versionAdded": "v1_2_0" }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -224,17 +230,17 @@ }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UefiDevicePath": { - "description": "The UEFI device path used to access this storage controller.", - "longDescription": "This property shall contain the UEFI device path used to identify and locate the specific storage controller.", + "description": "The UEFI device path to access this storage controller.", + "longDescription": "This property shall contain the UEFI device path that identifies and locates the specific storage controller.", "readonly": true, "type": [ "string", @@ -252,5 +258,6 @@ } }, "owningEntity": "DMTF", - "title": "#SimpleStorage.v1_2_1.SimpleStorage" + "release": "2017.1", + "title": "#SimpleStorage.v1_2_3.SimpleStorage" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json b/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json index 56c7936365..5504647d25 100644 --- a/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json +++ b/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.v1_2_3.json", "$ref": "#/definitions/SoftwareInventory", "$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,18 +25,18 @@ "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." } }, "type": "object" }, "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", @@ -53,10 +54,10 @@ }, "SoftwareInventory": { "additionalProperties": false, - "description": "This schema defines an inventory of software components.", - "longDescription": "This resource shall be used to represent a single software component managed by this Redfish Service.", + "description": "The SoftwareInventory schema contains an inventory of software components. This can include software components such as BIOS, BMC firmware, firmware for other devices, system drivers, or provider software.", + "longDescription": "This Resource contains a single software component that this Redfish Service manages.", "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", @@ -71,21 +72,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -103,22 +104,24 @@ "readonly": true }, "LowestSupportedVersion": { - "description": "A string representing the lowest supported version of this software.", - "longDescription": "The value of this property shall be a string representing the lowest supported version of this software. This string is formatted using the same format used for the Version property.", + "description": "The lowest supported version of this software.", + "longDescription": "This property shall represent the lowest supported version of this software. This string is formatted using the same format used for the Version property.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionAdded": "v1_1_0" }, "Manufacturer": { - "description": "A string representing the manufacturer/producer of this software.", - "longDescription": "The value of this property shall be a string representing the name of the manufacturer/producer of this software.", + "description": "The manufacturer or producer of this software.", + "longDescription": "This property shall represent the name of the manufacturer or producer of this software.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionAdded": "v1_2_0" }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -126,57 +129,61 @@ }, "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." }, "RelatedItem": { - "description": "The ID(s) of the resources associated with this software inventory item.", + "description": "The IDs of the Resources associated with this software inventory item.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is associated with this software inventory item.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is associated with this software inventory item.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ReleaseDate": { - "description": "Release date of this software.", + "description": "The release date of this software.", "format": "date-time", - "longDescription": "The value of this property shall be the date of release or production for this software. The time of day portion of the property shall be '00:00:00Z' if the time of day is unknown.", + "longDescription": "This property shall contain the date of release or production for this software. If the time of day is unknown, the time of day portion of the property shall contain `00:00:00Z`.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionAdded": "v1_2_0" }, "SoftwareId": { - "description": "A string representing the implementation-specific ID for identifying this software.", - "longDescription": "The value of this property shall be a string representing an implementation-specific ID for identifying this software. This string is used for correlation to a component repository or database.", + "description": "The implementation-specific label that identifies this software.", + "longDescription": "This property shall represent an implementation-specific label that identifies this software. This string correlates with a component repository or database.", "readonly": true, - "type": "string" + "type": "string", + "versionAdded": "v1_1_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UefiDevicePaths": { - "description": "A list of strings representing the UEFI Device Path(s) of the component(s) associated with this software inventory item.", + "description": "The list of UEFI device paths of the components associated with this software inventory item.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall be a list of strings representing the UEFI Device Path(s) of the component(s) associated with this software inventory item. The UEFI Device Path string(s) shall be formatted as defined by the UEFI Specification.", + "longDescription": "This property shall contain a list UEFI device paths of the components associated with this software inventory item. The UEFI device paths shall be formatted as defined by the UEFI Specification.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "Updateable": { - "description": "Indicates whether this software can be updated by the update service.", - "longDescription": "The value of this property shall be a boolean indicating whether this software can be updated by the update service. If false, this software is for reporting purpose only.", + "description": "An indication of whether the Update Service can update this software.", + "longDescription": "This property shall indicate whether the Update Service can update this software. If `true`, the Service can update this software. If `false`, the Service cannot update this software and the software is for reporting purposes only.", "readonly": true, "type": [ "boolean", @@ -184,8 +191,8 @@ ] }, "Version": { - "description": "A string representing the version of this software.", - "longDescription": "The value of this property shall be a string representing the version of this software.", + "description": "The version of this software.", + "longDescription": "This property shall contain the version of this software.", "readonly": true, "type": [ "string", @@ -203,5 +210,6 @@ } }, "owningEntity": "DMTF", - "title": "#SoftwareInventory.v1_2_1.SoftwareInventory" + "release": "2018.1", + "title": "#SoftwareInventory.v1_2_3.SoftwareInventory" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Storage/Storage.json b/static/redfish/v1/JsonSchemas/Storage/Storage.json index e3efbd10c8..581dd05e36 100644 --- a/static/redfish/v1/JsonSchemas/Storage/Storage.json +++ b/static/redfish/v1/JsonSchemas/Storage/Storage.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Storage.v1_6_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Storage.v1_7_1.json", "$ref": "#/definitions/Storage", "$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", @@ -28,18 +28,18 @@ }, "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." } }, "type": "object" }, "CacheSummary": { "additionalProperties": false, - "description": "This object describes the cache memory of the storage controller in general detail.", - "longDescription": "This type shall contain properties which describe the cache memory for a storage controller.", + "description": "This type describes the cache memory of the storage controller in general detail.", + "longDescription": "This type shall contain properties that describe the cache memory for a storage controller.", "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", @@ -55,7 +55,7 @@ "properties": { "PersistentCacheSizeMiB": { "description": "The portion of the cache memory that is persistent, measured in MiB.", - "longDescription": "This property shall contain the amount of cache memory that is persistent as measured in mebibytes. This size shall be less than or equal to the TotalCacheSizeMib.", + "longDescription": "This property shall contain the amount of cache memory that is persistent as measured in mebibytes. This size shall be less than or equal to the TotalCacheSizeMib.", "minimum": 0, "readonly": true, "type": [ @@ -67,8 +67,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource.", + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource.", "versionAdded": "v1_5_0" }, "TotalCacheSizeMiB": { @@ -91,10 +91,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -109,31 +109,31 @@ }, "properties": { "Enclosures": { - "description": "An array of references to the chassis to which this storage subsystem is attached.", + "description": "An array of links to the chassis to which this storage subsystem is attached.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" }, - "longDescription": "The value of this property shall reference a resource of type Chassis that represents the physical containers attached to this resource.", + "longDescription": "This property shall link to a Resource of type Chassis that represents the physical containers attached to this Resource.", "readonly": true, "type": "array" }, "Enclosures@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." } }, "type": "object" }, "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", @@ -149,20 +149,78 @@ "properties": {}, "type": "object" }, + "Rates": { + "additionalProperties": false, + "description": "This type describes the various controller rates used for processes such as Volume Rebuild or Consistency Checks.", + "longDescription": "This type shall contain all the rate settings available on the controller.", + "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": { + "ConsistencyCheckRatePercent": { + "description": "The percentage of controller Resources used for performing a data consistency check on volumes.", + "longDescription": "This property shall contain the percentage of controller Resources used for checking data consistency on Volumes.", + "maximum": 100, + "minimum": 0, + "readonly": false, + "type": [ + "integer", + "null" + ], + "versionAdded": "v1_7_0" + }, + "RebuildRatePercent": { + "description": "The percentage of controller Resources used for rebuilding/repairing volumes.", + "longDescription": "This property shall contain the percentage of controller Resources used for rebuilding Volumes.", + "maximum": 100, + "minimum": 0, + "readonly": false, + "type": [ + "integer", + "null" + ], + "versionAdded": "v1_7_0" + }, + "TransformationRatePercent": { + "description": "The percentage of controller Resources used for transforming volumes from one configuration to another.", + "longDescription": "This property shall contain the percentage of controller Resources used for transforming Volumes.", + "maximum": 100, + "minimum": 0, + "readonly": false, + "type": [ + "integer", + "null" + ], + "versionAdded": "v1_7_0" + } + }, + "type": "object" + }, "SetEncryptionKey": { "additionalProperties": false, - "description": "This action is used to set the encryption key for the storage subsystem.", + "description": "This action sets the encryption key for the storage subsystem.", "longDescription": "This action shall set the encryption key for the storage subsystem.", "parameters": { "EncryptionKey": { - "description": "The encryption key to set on the storage subsytem.", + "description": "The encryption key to set on the storage subsystem.", "longDescription": "This parameter shall contain the encryption key to set on the storage subsystem.", "requiredParameter": true, "type": "string" } }, "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", @@ -178,7 +236,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -190,10 +248,10 @@ }, "Storage": { "additionalProperties": false, - "description": "This schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as volumes that can be accessed from that subsystem.", - "longDescription": "This resource shall be used to represent resources that represent a storage subsystem in the Redfish specification.", + "description": "The Storage schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of physical or virtual storage controllers and the Resources, such as volumes, that can be accessed from that subsystem.", + "longDescription": "This Resource shall represent a storage subsystem in the Redfish Specification.", "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", @@ -208,21 +266,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -236,16 +294,16 @@ "readonly": true }, "Drives": { - "description": "The set of drives attached to the storage controllers represented by this resource.", + "description": "The set of drives attached to the storage controllers that this Resource represents.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" }, - "longDescription": "A collection that indicates all the drives attached to the storage controllers that this resource represents.", + "longDescription": "This property shall contain a set of the drives attached to the storage controllers that this Resource represents.", "readonly": true, "type": "array" }, "Drives@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -253,8 +311,8 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -262,8 +320,8 @@ }, "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." }, "Redundancy": { "autoExpand": true, @@ -275,30 +333,30 @@ "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "StorageControllers": { "autoExpand": true, - "description": "The set of storage controllers represented by this resource.", + "description": "The set of storage controllers that this Resource represents.", "items": { "$ref": "#/definitions/StorageController" }, - "longDescription": "A collection that indicates all the storage controllers that this resource represents.", + "longDescription": "This property shall contain a set of the storage controllers that this Resource represents.", "readonly": true, "type": "array" }, "StorageControllers@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Volumes": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/VolumeCollection.json#/definitions/VolumeCollection", - "description": "The set of volumes produced by the storage controllers represented by this resource.", - "longDescription": "A collection that indicates all the volumes produced by the storage controllers that this resource represents.", + "description": "The set of volumes that the storage controllers produce.", + "longDescription": "This property shall contain a link to a Resource of type VolumeCollection.", "readonly": true } }, @@ -312,10 +370,10 @@ }, "StorageController": { "additionalProperties": false, - "description": "This schema defines a storage controller and its respective properties. A storage controller represents a storage device (physical or virtual) that produces Volumes.", - "longDescription": "This resource shall be used to represent a resource that represents a storage controller in the Redfish specification.", + "description": "The StorageController schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes.", + "longDescription": "This Resource shall represent a Resource that represents a storage controller in the Redfish Specification.", "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", @@ -330,24 +388,24 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/StorageControllerActions", - "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_2_0" }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this Storage Controller.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to the assembly associated with this storage controller.", + "longDescription": "This property shall contain a link to a Resource of type Assembly.", "readonly": true, "versionAdded": "v1_4_0" }, "AssetTag": { - "description": "The user assigned asset tag for this storage controller.", - "longDescription": "The value of this property shall be an identifying string used to track the storage controller for inventory purposes.", + "description": "The user-assigned asset tag for this storage controller.", + "longDescription": "This property shall track the storage controller for inventory purposes.", "readonly": false, "type": [ "string", @@ -356,12 +414,18 @@ }, "CacheSummary": { "$ref": "#/definitions/CacheSummary", - "description": "This object describes the cache memory of the storage controller in general detail.", - "longDescription": "This object shall contain properties which describe the cache memory for the current resource.", + "description": "The cache memory of the storage controller in general detail.", + "longDescription": "This property shall contain properties that describe the cache memory for this Resource.", "versionAdded": "v1_5_0" }, + "ControllerRates": { + "$ref": "#/definitions/Rates", + "description": "This property describes the various controller rates used for processes such as Volume Rebuild or Consistency Checks.", + "longDescription": "This object shall contain all the rate settings available on the controller.", + "versionAdded": "v1_7_0" + }, "FirmwareVersion": { - "description": "The firmware version of this storage Controller.", + "description": "The firmware version of this storage controller.", "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the associated storage controller.", "readonly": true, "type": [ @@ -379,19 +443,19 @@ }, "Links": { "$ref": "#/definitions/StorageControllerLinks", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource.", "versionAdded": "v1_1_0" }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the storage controller.", + "description": "The location of the storage controller.", "longDescription": "This property shall contain location information of the associated storage controller.", "versionAdded": "v1_4_0" }, "Manufacturer": { - "description": "This is the manufacturer of this storage controller.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the storage controller. This organization might be the entity from whom the storage controller is purchased, but this is not necessarily true.", + "description": "The manufacturer of this storage controller.", + "longDescription": "This property shall contain the name of the organization responsible for producing the storage controller. This organization might be the entity from which the storage controller is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -399,14 +463,14 @@ ] }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "Model": { - "description": "This is the model number for the storage controller.", - "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the storage controller.", + "description": "The model number for the storage controller.", + "longDescription": "This property shall contain the name by which the manufacturer generally refers to the storage controller.", "readonly": true, "type": [ "string", @@ -415,7 +479,7 @@ }, "Name": { "description": "The name of the Storage Controller.", - "longDescription": "The value of this property shall be the name of the Storage Controller.", + "longDescription": "This property shall contain the name of the Storage Controller.", "readonly": true, "type": [ "string", @@ -425,34 +489,34 @@ }, "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." }, "PCIeInterface": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface" - }, - { - "type": "null" - } - ], + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface", "description": "The PCIe interface details for this controller.", - "longDescription": "This object shall contain details on the PCIe interface used to connect this PCIe-based controller to its host.", + "longDescription": "This property shall contain details on the PCIe interface that connects this PCIe-based controller to its host.", "versionAdded": "v1_5_0" }, "PartNumber": { "description": "The part number for this storage controller.", - "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the storage controller.", + "longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the storage controller.", "readonly": true, "type": [ "string", "null" ] }, + "Ports": { + "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection", + "description": "The link to the collection of Ports that exist on the storage controller.", + "longDescription": "This property shall contain a link to a Resource Collection of type PortCollection.", + "readonly": true, + "versionAdded": "v1_7_0" + }, "SKU": { - "description": "This is the SKU for this storage controller.", - "longDescription": "The value of this property shall be the stock-keeping unit number for this storage storage controller.", + "description": "The SKU for this storage controller.", + "longDescription": "This property shall contain the stock-keeping unit number for this storage storage controller.", "readonly": true, "type": [ "string", @@ -461,7 +525,7 @@ }, "SerialNumber": { "description": "The serial number for this storage controller.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the storage controller.", + "longDescription": "This property shall contain a manufacturer-allocated number that identifies the storage controller.", "readonly": true, "type": [ "string", @@ -470,7 +534,7 @@ }, "SpeedGbps": { "description": "The maximum speed of the storage controller's device interface.", - "longDescription": "The value of this property shall represent the maximum supported speed of the Storage bus interface (in Gigabits per second). The interface specified connects the controller to the storage devices, not the controller to a host (e.g. SAS bus, not PCIe host bus).", + "longDescription": "This property shall represent the maximum supported speed of the storage bus interface, in Gigabits per second. The specified interface connects the controller to the storage devices, not the controller to a host. For example, SAS bus not PCIe host bus.", "minimum": 0, "readonly": true, "type": [ @@ -481,29 +545,29 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SupportedControllerProtocols": { - "description": "This represents the protocols by which this storage controller can be communicated to.", + "description": "The supported set of protocols for communicating to this storage controller.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol" }, - "longDescription": "The value of this property shall be the set of protocols this storage controller can be communicated to.", + "longDescription": "This property shall contain the supported set of protocols for communicating to this storage controller.", "readonly": true, "type": "array" }, "SupportedDeviceProtocols": { - "description": "This represents the protocols which the storage controller can use to communicate with attached devices.", + "description": "The protocols that the storage controller can use to communicate with attached devices.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol" }, - "longDescription": "The value of this property shall be the set of protocols this storage controller can use to communicate with attached devices.", + "longDescription": "This property shall contain the set of protocols this storage controller can use to communicate with attached devices.", "readonly": true, "type": "array" }, "SupportedRAIDTypes": { - "description": "This object describes the RAID Types supported by the storage controller.", + "description": "The set of RAID types supported by the storage controller.", "items": { "anyOf": [ { @@ -514,7 +578,7 @@ } ] }, - "longDescription": "This object shall contain all the RAIDType values supported by the current resource.", + "longDescription": "This property shall contain an array of all the RAID types supported by this controller.", "readonly": true, "type": "array", "versionAdded": "v1_6_0" @@ -528,10 +592,10 @@ }, "StorageControllerActions": { "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", @@ -547,8 +611,8 @@ "properties": { "Oem": { "$ref": "#/definitions/StorageControllerOemActions", - "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_2_0" } }, @@ -556,10 +620,10 @@ }, "StorageControllerLinks": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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", @@ -574,43 +638,55 @@ }, "properties": { "Endpoints": { - "description": "An array of references to the endpoints that connect to this controller.", + "description": "An array of links to the endpoints that connect to this controller.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be a reference to the resources that this controller is associated with and shall reference a resource of type Endpoint.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this controller is associated.", "type": "array", "versionAdded": "v1_1_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." + }, + "PCIeFunctions": { + "description": "An array of links to the PCIe functions that the stroage controller produces.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction" + }, + "longDescription": "This property shall link to a Resource of type PCIeFunction that represents the PCIe functions associated with this Resource.", + "type": "array", + "versionAdded": "v1_7_0" + }, + "PCIeFunctions@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "StorageServices": { - "description": "An array of references to the StorageServices that connect to this controller.", + "description": "An array of links to the Storage Services that connect to this controller.", "items": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageService.json#/definitions/StorageService" }, - "longDescription": "The value of this property shall be a reference to the resources that this controller is associated with and shall reference a resource of type StorageService.", + "longDescription": "This property shall contain a link to the Resources of the StorageService type with which this controller is associated.", "type": "array", "versionAdded": "v1_4_0" }, "StorageServices@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "StorageControllerOemActions": { "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", @@ -628,6 +704,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#Storage.v1_6_0.Storage" + "release": "2019.1", + "title": "#Storage.v1_7_1.Storage" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Switch/Switch.json b/static/redfish/v1/JsonSchemas/Switch/Switch.json index 77838309b5..0792058e2e 100644 --- a/static/redfish/v1/JsonSchemas/Switch/Switch.json +++ b/static/redfish/v1/JsonSchemas/Switch/Switch.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Switch.v1_2_0.json", "$ref": "#/definitions/Switch", "$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", @@ -27,18 +28,18 @@ }, "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." } }, "type": "object" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -54,36 +55,36 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the chassis which contains this switch.", - "longDescription": "The value of this property shall be a reference to the resources that this switch is associated with and shall reference a resource of type Chassis.", + "description": "The link to the chassis that contains this switch.", + "longDescription": "This property shall contain a link to the Resource of type Chassis with which this switch is associated.", "readonly": true }, "ManagedBy": { - "description": "An array of references to the managers that manage this switch.", + "description": "An array of links to the managers that manage this switch.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "The value of this property shall be a reference to the resources that this switch is associated with and shall reference a resource of type Manager.", + "longDescription": "This property shall contain a link to the Resource of type Manager with which this switch is associated.", "readonly": true, "type": "array" }, "ManagedBy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." } }, "type": "object" }, "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", @@ -101,17 +102,17 @@ }, "Reset": { "additionalProperties": false, - "description": "This action is used to reset this switch.", - "longDescription": "This action shall perform a reset of this switch.", + "description": "This action resets this switch.", + "longDescription": "This action shall reset this switch.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", - "description": "The type of reset to be performed.", - "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset." + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without this parameter and can complete an implementation-specific default reset." } }, "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", @@ -127,7 +128,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -139,10 +140,10 @@ }, "Switch": { "additionalProperties": false, - "description": "Switch contains properties describing a simple fabric switch.", - "longDescription": "This resource shall be used to represent a simple switch for a Redfish implementation.", + "description": "The Switch schema contains properties that describe a fabric switch.", + "longDescription": "This Resource contains a switch 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", @@ -157,25 +158,25 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "AssetTag": { - "description": "The user assigned asset tag for this switch.", - "longDescription": "The value of this property shall be an identifying string used to track the drive for inventory purposes.", + "description": "The user-assigned asset tag for this switch.", + "longDescription": "This property shall contain the user-assigned asset tag, which is an identifying string that tracks the drive for inventory purposes.", "readonly": false, "type": [ "string", @@ -194,14 +195,24 @@ "readonly": true }, "DomainID": { - "description": "The Domain ID for this switch.", - "longDescription": "The value of this property shall have a scope of uniqueness within the fabric of which the switch is a member.", + "description": "The domain ID for this switch.", + "longDescription": "This property shall contain The domain ID for this switch. This property has a scope of uniqueness within the fabric of which the switch is a member.", "readonly": true, "type": [ "integer", "null" ] }, + "FirmwareVersion": { + "description": "The firmware version of this switch.", + "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the associated switch.", + "readonly": true, + "type": [ + "string", + "null" + ], + "versionAdded": "v1_2_0" + }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true @@ -215,13 +226,13 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify the switch.", - "longDescription": "This value of this property shall contain the indicator light state for the indicator light associated with this switch.", + "description": "The state of the indicator LED, which identifies the switch.", + "longDescription": "This property shall contain the state of the indicator light associated with this switch.", "readonly": false }, "IsManaged": { - "description": "This indicates whether the switch is in a managed or unmanaged state.", - "longDescription": "The value of this property shall be a boolean indicating whether this switch is in a managed or unmanaged state.", + "description": "An indication of whether the switch is in a managed or unmanaged state.", + "longDescription": "This property shall indicate whether this switch is in a managed or unmanaged state.", "readonly": false, "type": [ "boolean", @@ -230,30 +241,24 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the switch.", - "longDescription": "This property shall contain location information of the associated switch." + "description": "The location of the switch.", + "longDescription": "This property shall contain location information of the associated switch.", + "versionAdded": "v1_1_0" }, "LogServices": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection" - }, - { - "type": "null" - } - ], - "description": "A reference to the collection of Log Services associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type LogServiceCollection.", + "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection", + "description": "The link to the collection of Log Services associated with this switch.", + "longDescription": "This property shall contain a link to a Resource Collection of type LogServiceCollection.", "readonly": true }, "Manufacturer": { - "description": "This is the manufacturer of this switch.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the switch. This organization might be the entity from whom the switch is purchased, but this is not necessarily true.", + "description": "The manufacturer of this switch.", + "longDescription": "This property shall contain the name of the organization responsible for producing the switch. This organization might be the entity from which the switch is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -262,7 +267,7 @@ }, "Model": { "description": "The product model number of this switch.", - "longDescription": "This property shall indicate the model information as provided by the manufacturer of this switch.", + "longDescription": "This property shall contain the manufacturer-provided model information of this switch.", "readonly": true, "type": [ "string", @@ -275,12 +280,12 @@ }, "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." }, "PartNumber": { "description": "The part number for this switch.", - "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the switch.", + "longDescription": "This property shall contain the manufacturer-provided part number for the switch.", "readonly": true, "type": [ "string", @@ -289,8 +294,8 @@ }, "Ports": { "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection", - "description": "A collection of references to the ports for this switch.", - "longDescription": "The value of this property shall be a reference to the resources that this switch contains and shall reference a resource of type Port.", + "description": "The link to the collection ports for this switch.", + "longDescription": "This property shall contain a link to a Resource Collection of type PortCollection.", "readonly": true }, "PowerState": { @@ -302,8 +307,8 @@ "type": "null" } ], - "description": "This is the current power state of the switch.", - "longDescription": "The value of this property shall contain the power state of the switch.", + "description": "The current power state of the switch.", + "longDescription": "This property shall contain the power state of the switch.", "readonly": true }, "Redundancy": { @@ -312,15 +317,15 @@ "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show how this switch is grouped with other switches for form redundancy sets.", + "longDescription": "This property shall contain an array that shows how this switch is grouped with other switches for form redundancy sets.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SKU": { - "description": "This is the SKU for this switch.", - "longDescription": "The value of this property shall be the stock-keeping unit number for this switch.", + "description": "The SKU for this switch.", + "longDescription": "This property shall contain the SKU number for this switch.", "readonly": true, "type": [ "string", @@ -329,7 +334,7 @@ }, "SerialNumber": { "description": "The serial number for this switch.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the switch.", + "longDescription": "This property shall contain a manufacturer-allocated number that identifies the switch.", "readonly": true, "type": [ "string", @@ -338,8 +343,8 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SwitchType": { "anyOf": [ @@ -350,13 +355,13 @@ "type": "null" } ], - "description": "The protocol being sent over this switch.", - "longDescription": "The value of this property shall contain the type of switch being represented by this simple switch.", + "description": "The type of switch.", + "longDescription": "This property shall contain the type of switch.", "readonly": true }, "TotalSwitchWidth": { "description": "The total number of lanes, phys, or other physical transport links that this switch contains.", - "longDescription": "The value of this property shall be the number of physical transport lanes, phys, or other physical transport links that this switch contains. For PCIe, this shall be lane count.", + "longDescription": "This property shall contain the number of physical transport lanes, phys, or other physical transport links that this switch contains. For PCIe, this value shall be the lane count.", "readonly": true, "type": [ "integer", @@ -374,5 +379,6 @@ } }, "owningEntity": "DMTF", - "title": "#Switch.v1_1_1.Switch" + "release": "2019.2", + "title": "#Switch.v1_2_0.Switch" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Task/Task.json b/static/redfish/v1/JsonSchemas/Task/Task.json index f0c266ecad..9253c44eff 100644 --- a/static/redfish/v1/JsonSchemas/Task/Task.json +++ b/static/redfish/v1/JsonSchemas/Task/Task.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Task.v1_4_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Task.v1_4_2.json", "$ref": "#/definitions/Task", "$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 @@ }, "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", @@ -56,9 +56,9 @@ "Payload": { "additionalProperties": false, "description": "The HTTP and JSON payload details for this Task.", - "longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this Task.", + "longDescription": "This type shall contain information detailing the HTTP and JSON payload information for executing this Task.", "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", @@ -73,33 +73,33 @@ }, "properties": { "HttpHeaders": { - "description": "This represents the HTTP headers used in the operation of this Task.", + "description": "An array of HTTP headers that this task includes.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be an array of HTTP headers used in the execution of this Task.", + "longDescription": "This property shall contain an array of HTTP headers that this task includes.", "readonly": true, "type": "array", "versionAdded": "v1_3_0" }, "HttpOperation": { - "description": "The HTTP operation to perform to execute this Task.", - "longDescription": "This property shall contain the HTTP operation to execute for this Task.", + "description": "The HTTP operation to perform to execute this task.", + "longDescription": "This property shall contain the HTTP operation to execute for this task.", "readonly": true, "type": "string", "versionAdded": "v1_3_0" }, "JsonBody": { - "description": "This property contains the JSON payload to use in the execution of this Task.", - "longDescription": "The value of this property shall be JSON formatted payload used for this Task.", + "description": "The JSON payload to use in the execution of this task.", + "longDescription": "This property shall contain JSON formatted payload used for this task.", "readonly": true, "type": "string", "versionAdded": "v1_3_0" }, "TargetUri": { "description": "The URI of the target for this task.", - "format": "uri", - "longDescription": "This property shall contain a URI referencing a location to be used as the target for an HTTP operation.", + "format": "uri-reference", + "longDescription": "This property shall contain a link to the location to use as the target for an HTTP operation.", "readonly": true, "type": "string", "versionAdded": "v1_3_0" @@ -109,10 +109,10 @@ }, "Task": { "additionalProperties": false, - "description": "This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service.", - "longDescription": "This resource shall be used to represent a task for a Redfish implementation.", + "description": "The Task schema contains information about a task that the Redfish Task Service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait.", + "longDescription": "This Resource contains a Task 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", @@ -127,21 +127,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": { @@ -156,15 +156,15 @@ "readonly": true }, "EndTime": { - "description": "The date-time stamp that the task was last completed.", + "description": "The date and time when the task was completed. This property will only appear when the task is complete.", "format": "date-time", - "longDescription": "The value of this property shall indicate the time the task was completed.", + "longDescription": "This property shall indicate the date and time when the task was completed. This property shall not appear if the task is running or otherwise has not been completed. This property shall appear only if the TaskState is Completed, Killed, Cancelled, or Exception.", "readonly": true, "type": "string" }, "HidePayload": { - "description": "Indicates that the contents of the Payload should be hidden from view after the Task has been created. When set to True, the Payload object will not be returned on GET.", - "longDescription": "This property shall be set to True if the Payload object shall not be returned on GET operations, and set to False if the contents can be returned normally. If this property is not specified when the Task is created, the default value shall be False.", + "description": "An indication of whether the contents of the payload should be hidden from view after the task has been created. If `true`, responses do not return the payload. If `false`, responses return the payload. If this property is not present when the task is created, the default is `false`.", + "longDescription": "This property shall indicate whether the contents of the payload should be hidden from view after the task has been created. If `true`, responses shall not return the Payload property. If `false`, responses shall return the Payload property. If this property is not present when the task is created, the default is `false`.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" @@ -174,11 +174,11 @@ "readonly": true }, "Messages": { - "description": "This is an array of messages associated with the task.", + "description": "An array of messages associated with the task.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message" }, - "longDescription": "The value of this property shall be an array of messages associated with the task.", + "longDescription": "This property shall contain an array of messages associated with the task.", "type": "array" }, "Name": { @@ -187,18 +187,18 @@ }, "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." }, "Payload": { "$ref": "#/definitions/Payload", "description": "The HTTP and JSON payload details for this task.", - "longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this task. This object shall not be included in the response if the HidePayload property is set to True.", + "longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this task. This object shall not be included in the response if the HidePayload property is `true`.", "versionAdded": "v1_3_0" }, "PercentComplete": { - "description": "The completion percentage of this Task.", - "longDescription": "The value of this property shall indicate the completion progress of the task, reported in percent of completion. If the task has not been started, the value shall be zero.", + "description": "The completion percentage of this task.", + "longDescription": "This property shall indicate the completion progress of the task, reported in percent of completion. If the task has not been started, the value shall be zero.", "readonly": true, "type": [ "integer", @@ -208,15 +208,15 @@ "versionAdded": "v1_4_0" }, "StartTime": { - "description": "The date-time stamp that the task was last started.", + "description": "The date and time when the task was started.", "format": "date-time", - "longDescription": "The value of this property shall indicate the time the task was started.", + "longDescription": "This property shall indicate the date and time when the task was started.", "readonly": true, "type": "string" }, "TaskMonitor": { "description": "The URI of the Task Monitor for this task.", - "format": "uri", + "format": "uri-reference", "longDescription": "This property shall contain a URI to Task Monitor as defined in the Redfish Specification.", "readonly": true, "type": "string", @@ -225,13 +225,13 @@ "TaskState": { "$ref": "#/definitions/TaskState", "description": "The state of the task.", - "longDescription": "The value of this property shall indicate the state of the task. New shall be used to indicate that the task is a new task which has just been instantiated and is in the initial state and indicates it has never been started. Starting shall be used to indicate that the task is moving from the New, Suspended, or Service states into the Running state. Running shall be used to indicate that the Task is running. Suspended shall be used to indicate that the Task is stopped (e.g., by a user), but can be restarted in a seamless manner. Interrupted shall be used to indicate that the Task was interrupted (e.g., by a server crash) in the middle of processing, and the user should either re-run/restart the Task. Pending shall be used to indicate that the Task has been queued and will be scheduled for processing as soon as resources are available to handle the request. Stopping shall be used to indicate that the Task is in the process of moving to a Completed, Killed, or Exception state. Completed shall be used to indicate that the task has completed normally. Killed shall be used to indicate that the task has been stopped by a Kill state change request (non-graceful shutdown). Exception shall be used to indicate that the Task is in an abnormal state that might be indicative of an error condition. Service shall be used to indicate that the Task is in a state that supports problem discovery, or resolution, or both. This state is used when a corrective action is possible.", + "longDescription": "This property shall indicate the state of the task.", "readonly": true }, "TaskStatus": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health", - "description": "This is the completion status of the task.", - "longDescription": "The value of this property shall be the completion status of the task, as defined in the Status section of the Redfish specification and shall not be set until the task has completed.", + "description": "The completion status of the task.", + "longDescription": "This property shall contain the completion status of the task, as defined in the Status section of the Redfish Specification and shall not be set until the task completes.", "readonly": true } }, @@ -260,12 +260,12 @@ "Cancelled" ], "enumDeprecated": { - "Killed": "This value has been deprecated and is being replaced by the value Cancelled which has more determinate semantics." + "Killed": "This value has been deprecated and is being replaced by the Cancelled value, which has more determinate semantics." }, "enumDescriptions": { "Cancelled": "Task has been cancelled by an operator or internal process.", "Cancelling": "Task is in the process of being cancelled.", - "Completed": "Task has completed.", + "Completed": "Task was completed.", "Exception": "Task has stopped due to an exception condition.", "Interrupted": "Task has been interrupted.", "Killed": "Task was terminated.", @@ -278,19 +278,19 @@ "Suspended": "Task has been suspended." }, "enumLongDescriptions": { - "Cancelled": "This value shall represent that the operation was cancelled either through a Delete on a Task Monitor or Task Resource or by an internal process.", - "Cancelling": "This value shall represent that the operation is in the process of being cancelled.", - "Completed": "This value shall represent that the operation is complete and completed sucessfully or with warnings.", - "Exception": "This value shall represent that the operation is complete and completed with errors.", - "Interrupted": "This value shall represent that the operation has been interrupted but is expected to restart and is therefore not complete.", - "Killed": "This value shall represent that the operation is complete because the task was killed by an operator.", - "New": "This value shall represent that this task is newly created but the operation has not yet started.", - "Pending": "This value shall represent that the operation is pending some condition and has not yet begun to execute.", - "Running": "This value shall represent that the operation is executing.", - "Service": "This value shall represent that the operation is now running as a service and expected to continue operation until stopped or killed.", - "Starting": "This value shall represent that the operation is starting.", - "Stopping": "This value shall represent that the operation is stopping but is not yet complete.", - "Suspended": "This value shall represent that the operation has been suspended but is expected to restart and is therefore not complete." + "Cancelled": "This value shall represent that either a DELETE operation on a Task Monitor or Task Resource or by an internal process cancelled the task.", + "Cancelling": "This value shall represent that the task is in the process of being cancelled.", + "Completed": "This value shall represent that the task completed sucessfully or with warnings.", + "Exception": "This value shall represent that the task completed with errors.", + "Interrupted": "This value shall represent that the task has been interrupted but is expected to restart and is therefore not complete.", + "Killed": "This value shall represent that the task is complete because an operator killed it.", + "New": "This value shall represent that the task is newly created, but has not started.", + "Pending": "This value shall represent that the task is pending some condition and has not yet begun to execute.", + "Running": "This value shall represent that the task is executing.", + "Service": "This value shall represent that the task is now running as a service and expected to continue operation until stopped or killed.", + "Starting": "This value shall represent that the task is starting.", + "Stopping": "This value shall represent that the task is stopping but is not yet complete.", + "Suspended": "This value shall represent that the task has been suspended but is expected to restart and is therefore not complete." }, "enumVersionAdded": { "Cancelled": "v1_2_0", @@ -304,5 +304,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#Task.v1_4_0.Task" + "title": "#Task.v1_4_2.Task" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/TaskService/TaskService.json b/static/redfish/v1/JsonSchemas/TaskService/TaskService.json index c1685f58f9..2ce0c3532b 100644 --- a/static/redfish/v1/JsonSchemas/TaskService/TaskService.json +++ b/static/redfish/v1/JsonSchemas/TaskService/TaskService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/TaskService.v1_1_4.json", "$ref": "#/definitions/TaskService", "$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,18 +25,19 @@ "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" }, "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", @@ -64,10 +66,10 @@ }, "TaskService": { "additionalProperties": false, - "description": "This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks.", - "longDescription": "This resource shall be used to represent a task service for a Redfish implementation.", + "description": "The TaskService schema describes a Task Service that enables management of long-duration operations, includes the properties for the Task Service itself, and has links to the actual Resource Collection of Tasks.", + "longDescription": "This Resource contains a Task Service 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", @@ -82,32 +84,33 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "CompletedTaskOverWritePolicy": { "$ref": "#/definitions/OverWritePolicy", - "description": "Overwrite policy of completed tasks.", - "longDescription": "The value of this property shall indicate how completed tasks are handled should the task service need to track more tasks.", + "description": "The overwrite policy for completed tasks. This property indicates whether the Task Service overwrites completed task information.", + "longDescription": "This property shall indicate how the Task Service shall handle completed tasks if the service must track more tasks. This property indicates whether the Task Service overwrites completed task information.", "readonly": true }, "DateTime": { - "description": "The current DateTime (with offset) setting that the task service is using.", + "description": "The current date and time, with UTC offset, setting that the Task Service uses.", "format": "date-time", - "longDescription": "The value of this property shall represent the current DateTime value for the TaskService, with offset from UTC, in Redfish Timestamp format.", + "longDescription": "This property shall represent the current DateTime value for the Task Service, with UTC offset, in Redfish Timestamp format.", "readonly": true, "type": [ "string", @@ -130,8 +133,8 @@ "readonly": true }, "LifeCycleEventOnTaskStateChange": { - "description": "Send an Event upon Task State Change.", - "longDescription": "The value of this property, if set to true, shall indicate that the service shall send a Life cycle event to Event Destinations Subscriptions registered for such events upon change of task state. Life cycle events are defined in the Eventing section of the Redfish Specification.", + "description": "An indication of whether a task state change sends an event.", + "longDescription": "This property shall indicate whether a task state change sends an event. The Eventing section of the Redfish Specification defines life-cycle events.", "readonly": true, "type": "boolean" }, @@ -141,12 +144,12 @@ }, "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." }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -155,13 +158,13 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Tasks": { "$ref": "http://redfish.dmtf.org/schemas/v1/TaskCollection.json#/definitions/TaskCollection", - "description": "References to the Tasks collection.", - "longDescription": "The value of this property shall be a link to a resource of type TaskCollection.", + "description": "The links to the Tasks collection.", + "longDescription": "This property shall contain a link to a Resource of type TaskCollection.", "readonly": true } }, @@ -175,5 +178,6 @@ } }, "owningEntity": "DMTF", - "title": "#TaskService.v1_1_2.TaskService" + "release": "2017.1", + "title": "#TaskService.v1_1_4.TaskService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json b/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json index 1e4ae88e46..783e010b4d 100644 --- a/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json +++ b/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_1_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_1_2.json", "$ref": "#/definitions/TelemetryService", "$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", @@ -28,8 +28,8 @@ }, "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." } }, "type": "object" @@ -56,7 +56,7 @@ "description": "A metric value.", "longDescription": "A metric value in the context of a Metric.", "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", @@ -72,14 +72,14 @@ "properties": { "MetricDefinition": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition", - "description": "A link to the Metric Definition.", - "longDescription": "The value shall be reference to the Metric Definition resource that describes what this Metric Report is capturing.", + "description": "The link to the metric.", + "longDescription": "The link to the Metric Definition Resource that describes what this metric report captures.", "readonly": true, "versionAdded": "v1_1_0" }, "MetricId": { "description": "The metric definitions identifier for this metric.", - "longDescription": "The value shall be the same as the Id property of the source metric within the associated MetricDefinition.", + "longDescription": "This property shall contain the same as the Id property of the source metric within the associated MetricDefinition.", "readonly": true, "type": [ "string", @@ -89,8 +89,8 @@ }, "MetricProperty": { "description": "The URI for the property from which this metric is derived.", - "format": "uri", - "longDescription": "The value shall be URI to the a property following the JSON fragment notation, as defined by RFC6901, to identify an individual property in a Redfish resource.", + "format": "uri-reference", + "longDescription": "This property shall contain the URI to the property, which follows the RFC6901-defined JSON fragment notation, to identify an individual property in a Redfish Resource.", "readonly": true, "type": [ "string", @@ -99,8 +99,8 @@ "versionAdded": "v1_1_0" }, "MetricValue": { - "description": "The value identifies this resource.", - "longDescription": "The value of the metric represented as a string.", + "description": "The metric value, as a string.", + "longDescription": "This property shall contain the metric value, as a string.", "readonly": true, "type": [ "string", @@ -109,9 +109,9 @@ "versionAdded": "v1_1_0" }, "Timestamp": { - "description": "The time when the value of the metric is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.", + "description": "The time when the metric value is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.", "format": "date-time", - "longDescription": "The value shall time when the metric value was obtained. Note that this may be different from the time when this instance is created.", + "longDescription": "This property shall contain the time when the metric value was obtained. Note that this may be different from the time when this instance is created.", "readonly": true, "type": [ "string", @@ -124,10 +124,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", @@ -145,8 +145,8 @@ }, "SubmitTestMetricReport": { "additionalProperties": false, - "description": "This action is used to generate a metric report.", - "longDescription": "This action shall cause the event service to immediately generate the metric report, as an Alert Event. This message should then be sent to any appropriate ListenerDestination targets.", + "description": "This action generates a metric report.", + "longDescription": "This action shall cause the Event Service to immediately generate the metric report as an alert event. Then, this message should be sent to any appropriate event destinations.", "parameters": { "GeneratedMetricReportValues": { "description": "The content of the MetricReportValues in the generated metric report.", @@ -159,21 +159,21 @@ "versionAdded": "v1_1_0" }, "MetricReportName": { - "description": "The Name property of the metric report in generated metric report.", - "longDescription": "This parameter shall be the value of the Name property in the generated metric report.", + "description": "The name of the metric report in generated metric report.", + "longDescription": "This parameter shall contain the name of the generated metric report.", "requiredParameter": true, "type": "string" }, "MetricReportValues": { - "deprecated": "This property has been Deprecated in favor of using the property 'GeneratedMetricReportValues'.", - "description": "The content of MetricReportValues array in generated metric report.", + "deprecated": "This property has been deprecated in favor of using the property 'GeneratedMetricReportValues'.", + "description": "The contents of MetricReportValues array in the generated metric report.", "longDescription": "This parameter shall contain the contents of the MetricReportValues array property in the generated metric report.", "type": "string", "versionDeprecated": "v1_1_0" } }, "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", @@ -189,7 +189,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -201,10 +201,10 @@ }, "TelemetryService": { "additionalProperties": false, - "description": "This is the schema definition for the Metrics Service. It represents the properties for the service itself and has links to collections of metric definitions and metric report definitions.", - "longDescription": "This resource shall be used to represent an Metrics Service for a Redfish implementation. It represents the properties that affect the service itself.", + "description": "The TelemetryService schema describes a Telemetry Service. The Telemetry Service is used to for collecting and reporting metric data within the Redfish Service.", + "longDescription": "This Resource contains a Telemetry Service 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", @@ -219,21 +219,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -252,13 +252,13 @@ }, "LogService": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService", - "description": "This is a reference to a Log Service used by the Telemetry Service.", - "longDescription": "The value of this property shall contain a reference to a LogService for the use by this Telemetry Service.", + "description": "The link to a Log Service that the Telemetry Service uses. This service may be a dedicated Log Service or a pointer a Log Service under another entity, such as Manager.", + "longDescription": "This property shall contain a link to a Log Service that this Telemetry Service uses.", "readonly": true }, "MaxReports": { - "description": "The maximum number of metric reports supported by this service.", - "longDescription": "The value shall be the maximum number of metric reports supported by this service.", + "description": "The maximum number of metric reports that this service supports.", + "longDescription": "This property shall contain the maximum number of metric reports that this service supports.", "readonly": true, "type": [ "integer", @@ -267,25 +267,25 @@ }, "MetricDefinitions": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinitionCollection.json#/definitions/MetricDefinitionCollection", - "description": "A link to the collection of Metric Definitions.", - "longDescription": "The entries of shall be resources of type MetricDefinitionCollection.", + "description": "The link to the collection of metric definitions.", + "longDescription": "This property shall contain a link to a Resource Collection of type MetricDefinitionCollection.", "readonly": true }, "MetricReportDefinitions": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinitionCollection.json#/definitions/MetricReportDefinitionCollection", - "description": "A link to the collection of Metric Report Definitions.", - "longDescription": "The value shall be a link to a resource of type MetricReportDefinitionCollection.", + "description": "The link to the collection of metric report definitions.", + "longDescription": "This property shall contain a link to a Resource Collection of type MetricReportDefinitionCollection.", "readonly": true }, "MetricReports": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportCollection.json#/definitions/MetricReportCollection", - "description": "A link to the collection of Metric Reports.", - "longDescription": "The value shall be a link to a resource of type MetricReportCollection.", + "description": "The link to the collection of metric reports.", + "longDescription": "This property shall contain a link to a Resource Collection of type MetricReportCollection.", "readonly": true }, "MinCollectionInterval": { - "description": "The minimum time interval between collections supported by this service.", - "longDescription": "The value shall be the minimum time interval between collections supported by this service. The value shall conform to the Duration format.", + "description": "The minimum time interval between gathering metric data that this service allows.", + "longDescription": "This property shall contain the minimum time interval between gathering metric data that this service allows.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": true, "type": [ @@ -299,13 +299,13 @@ }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SupportedCollectionFunctions": { "description": "The functions that can be performed over each metric.", @@ -319,14 +319,14 @@ } ] }, - "longDescription": "The value shall define the function to apply over the collection duration.", + "longDescription": "This property shall contain the function to apply over the collection duration.", "readonly": false, "type": "array" }, "Triggers": { "$ref": "http://redfish.dmtf.org/schemas/v1/TriggersCollection.json#/definitions/TriggersCollection", - "description": "A link to the collection of Triggers, which apply to metrics.", - "longDescription": "The value shall be a link to a resource of type TriggersCollection.", + "description": "The link to the collection of triggers, which apply to metrics.", + "longDescription": "This property shall contain a link to a Resource Collection of type TriggersCollection.", "readonly": true } }, @@ -341,5 +341,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#TelemetryService.v1_1_0.TelemetryService" + "title": "#TelemetryService.v1_1_2.TelemetryService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Thermal/Thermal.json b/static/redfish/v1/JsonSchemas/Thermal/Thermal.json index 4fb9acfa40..8da51ffbc0 100644 --- a/static/redfish/v1/JsonSchemas/Thermal/Thermal.json +++ b/static/redfish/v1/JsonSchemas/Thermal/Thermal.json @@ -1,13 +1,13 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Thermal.v1_5_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Thermal.v1_5_3.json", "$ref": "#/definitions/Thermal", "$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": { "Fan": { "additionalProperties": false, "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", @@ -22,33 +22,35 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/FanActions", - "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_3_0" }, "Assembly": { "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", - "description": "A reference to the Assembly resource associated with this fan.", - "longDescription": "The value of this property shall be a link to a resource of type Assembly.", + "description": "The link to the assembly associated with this fan.", + "longDescription": "This property shall contain a link to a Resource of type Assembly.", "readonly": true, "versionAdded": "v1_4_0" }, "FanName": { - "description": "Name of the fan.", - "longDescription": "The value of this property shall be the name of the fan.", + "deprecated": "This property has been deprecated in favor of the Name property.", + "description": "The name of the fan.", + "longDescription": "This property shall contain the name of the fan.", "readonly": true, "type": [ "string", "null" - ] + ], + "versionDeprecated": "v1_1_0" }, "HotPluggable": { - "description": "Indicates if this device can be inserted or removed while the equipment is in operation.", - "longDescription": "The value of this property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.", + "description": "An indication of whether this device can be inserted or removed while the equipment is in operation.", + "longDescription": "This property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Hot-pluggable devices can become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be not hot-pluggable.", "readonly": true, "type": [ "boolean", @@ -65,20 +67,20 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify this Fan.", - "longDescription": "The value of this property shall contain the indicator light state for the indicator light associated with this fan.", + "description": "The state of the indicator LED, which identifies this fan.", + "longDescription": "This property shall contain the state of the indicator light associated with this fan.", "readonly": false, "versionAdded": "v1_2_0" }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the fan.", + "description": "The location of the fan.", "longDescription": "This property shall contain location information of the associated fan.", "versionAdded": "v1_4_0" }, "LowerThresholdCritical": { - "description": "Below normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range but is not yet fatal. The units shall be the same units as the related Reading property.", + "description": "The value at which the reading is below normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the Reading property is below the normal range but is not yet fatal. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -86,8 +88,8 @@ ] }, "LowerThresholdFatal": { - "description": "Below normal range and is fatal.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range and is fatal. The units shall be the same units as the related Reading property.", + "description": "The value at which the reading is below normal range and fatal.", + "longDescription": "This property shall contain the value at which the Reading property is below the normal range and is fatal. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -95,8 +97,8 @@ ] }, "LowerThresholdNonCritical": { - "description": "Below normal range.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range but is not critical. The units shall be the same units as the related Reading property.", + "description": "The value at which the reading is below normal range.", + "longDescription": "This property shall contain the value at which the Reading property is below normal range. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -104,8 +106,8 @@ ] }, "Manufacturer": { - "description": "This is the manufacturer of this Fan.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the fan. This organization might be the entity from whom the fan is purchased, but this is not necessarily true.", + "description": "The manufacturer of this fan.", + "longDescription": "This property shall contain the name of the organization responsible for producing the fan. This organization might be the entity from whom the fan is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -114,8 +116,8 @@ "versionAdded": "v1_2_0" }, "MaxReadingRange": { - "description": "Maximum value for Reading.", - "longDescription": "The value of this property shall indicate the highest possible value for Reading. The units shall be the same units as the related Reading property.", + "description": "Maximum value for this sensor.", + "longDescription": "This property shall indicate the highest possible value for the Reading property. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -123,14 +125,14 @@ ] }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "MinReadingRange": { - "description": "Minimum value for Reading.", - "longDescription": "The value of this property shall indicate the lowest possible value for Reading. The units shall be the same units as the related Reading property.", + "description": "Minimum value for this sensor.", + "longDescription": "This property shall indicate the lowest possible value for the Reading property. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -138,7 +140,7 @@ ] }, "Model": { - "description": "The model number for this Fan.", + "description": "The model number for this fan.", "longDescription": "This property shall contain the model information as defined by the manufacturer for the associated fan.", "readonly": true, "type": [ @@ -149,7 +151,7 @@ }, "Name": { "description": "Name of the fan.", - "longDescription": "The value of this property shall be the name of the fan.", + "longDescription": "This property shall contain the name of the fan.", "readonly": true, "type": [ "string", @@ -159,11 +161,11 @@ }, "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." }, "PartNumber": { - "description": "The part number for this Fan.", + "description": "The part number for this fan.", "longDescription": "This property shall contain the part number as defined by the manufacturer for the associated fan.", "readonly": true, "type": [ @@ -174,13 +176,13 @@ }, "PhysicalContext": { "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext", - "description": "Describes the area or device associated with this fan.", - "longDescription": "The value of this property shall be a description of the affected device or region within the chassis to which this fan is associated.", + "description": "The area or device associated with this fan.", + "longDescription": "This property shall contain a description of the affected device or region within the chassis with which this fan is associated.", "readonly": true }, "Reading": { - "description": "Current fan speed.", - "longDescription": "The value of this property shall be the current value of the fan sensor's reading.", + "description": "The fan speed.", + "longDescription": "This property shall contain the fan sensor reading.", "readonly": true, "type": [ "integer", @@ -196,37 +198,37 @@ "type": "null" } ], - "description": "Units in which the reading and thresholds are measured.", - "longDescription": "The value of this property shall be the units in which the fan's reading and thresholds are measured.", + "description": "The units in which the fan reading and thresholds are measured.", + "longDescription": "This property shall contain the units in which the fan reading and thresholds are measured.", "readonly": true, "versionAdded": "v1_0_1" }, "Redundancy": { - "description": "This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups.", + "description": "The set of redundancy groups for this fan.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show redundancy for fans and other elements in this resource. The use of IDs within these arrays shall reference the members of the redundancy groups.", + "longDescription": "This property shall contain an array of links to the redundancy groups to which this fan belongs.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "RelatedItem": { - "description": "The ID(s) of the resources serviced with this fan.", + "description": "An array of IDs of the Resources that this fan services.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that are being serviced by this fan.", + "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resources that this fan services.", "readonly": true, "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SensorNumber": { - "description": "A numerical identifier to represent the fan speed sensor.", - "longDescription": "The value of this property shall be a numerical identifier for this fan speed sensor that is unique within this resource.", + "description": "The numerical identifier for this fan speed sensor.", + "longDescription": "This property shall contain a numerical identifier for this fan speed sensor that is unique within this Resource.", "readonly": true, "type": [ "integer", @@ -235,7 +237,7 @@ "versionAdded": "v1_5_0" }, "SerialNumber": { - "description": "The serial number for this Fan.", + "description": "The serial number for this fan.", "longDescription": "This property shall contain the serial number as defined by the manufacturer for the associated fan.", "readonly": true, "type": [ @@ -245,7 +247,7 @@ "versionAdded": "v1_2_0" }, "SparePartNumber": { - "description": "The spare part number for this Fan.", + "description": "The spare part number for this fan.", "longDescription": "This property shall contain the spare or replacement part number as defined by the manufacturer for the associated fan.", "readonly": true, "type": [ @@ -256,12 +258,12 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UpperThresholdCritical": { - "description": "Above normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range but is not yet fatal. The units shall be the same units as the related Reading property.", + "description": "The value at which the reading is above normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the Reading property is above the normal range but is not yet fatal. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -269,8 +271,8 @@ ] }, "UpperThresholdFatal": { - "description": "Above normal range and is fatal.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range and is fatal. The units shall be the same units as the related Reading property.", + "description": "The value at which the reading is above normal range and fatal.", + "longDescription": "This property shall contain the value at which the Reading property is above the normal range and is fatal. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -278,8 +280,8 @@ ] }, "UpperThresholdNonCritical": { - "description": "Above normal range.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range but is not critical. The units shall be the same units as the related Reading property.", + "description": "The value at which the reading is above normal range.", + "longDescription": "This property shall contain the value at which the Reading property is above the normal range. The value of the property shall use the same units as the Reading property.", "readonly": true, "type": [ "integer", @@ -295,10 +297,10 @@ }, "FanActions": { "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", @@ -314,8 +316,8 @@ "properties": { "Oem": { "$ref": "#/definitions/FanOemActions", - "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_3_0" } }, @@ -323,10 +325,10 @@ }, "FanOemActions": { "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", @@ -348,15 +350,15 @@ "Percent" ], "enumDescriptions": { - "Percent": "Indicates that the fan reading and thresholds are measured in percentage.", - "RPM": "Indicates that the fan reading and thresholds are measured in rotations per minute." + "Percent": "The fan reading and thresholds are measured as a percentage.", + "RPM": "The fan reading and thresholds are measured in rotations per minute." }, "type": "string" }, "Temperature": { "additionalProperties": false, "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", @@ -371,17 +373,17 @@ }, "properties": { "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "Actions": { "$ref": "#/definitions/TemperatureActions", - "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_3_0" }, "AdjustedMaxAllowableOperatingValue": { "description": "Adjusted maximum allowable operating temperature for this equipment based on the current environmental conditions present.", - "longDescription": "The value of this property shall indicate the adjusted maximum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", + "longDescription": "This property shall indicate the adjusted maximum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", "readonly": true, "type": [ "integer", @@ -392,7 +394,7 @@ }, "AdjustedMinAllowableOperatingValue": { "description": "Adjusted minimum allowable operating temperature for this equipment based on the current environmental conditions present.", - "longDescription": "The value of this property shall indicate the adjusted minimum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", + "longDescription": "This property shall indicate the adjusted minimum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.", "readonly": true, "type": [ "integer", @@ -403,14 +405,14 @@ }, "DeltaPhysicalContext": { "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext", - "description": "Describes the area or device to which the DeltaReadingCelsius temperature measurement applies, relative to PhysicalContext.", - "longDescription": "The value of this property shall be a description of the affected device or region within the chassis to which the DeltaReadingCelsius temperature measurement applies, relative to PhysicalContext.", + "description": "The area or device to which the DeltaReadingCelsius temperature measurement applies, relative to PhysicalContext.", + "longDescription": "This property shall contain a description of the affected device or region within the chassis to which the DeltaReadingCelsius temperature measurement applies, relative to PhysicalContext.", "readonly": true, "versionAdded": "v1_4_0" }, "DeltaReadingCelsius": { "description": "Delta Temperature reading.", - "longDescription": "The value of this property shall be the delta of the values of the temperature readings across this sensor and the sensor at DeltaPhysicalContext.", + "longDescription": "This property shall contain the delta of the values of the temperature readings across this sensor and the sensor at DeltaPhysicalContext.", "readonly": true, "type": [ "number", @@ -420,8 +422,8 @@ "versionAdded": "v1_4_0" }, "LowerThresholdCritical": { - "description": "Below normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the ReadingCelsius is below the normal range but is not yet fatal. The units shall be the same units as the related ReadingCelsius property.", + "description": "The value at which the reading is below normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the ReadingCelsius property is below the normal range but is not yet fatal. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -430,8 +432,8 @@ "units": "Cel" }, "LowerThresholdFatal": { - "description": "Below normal range and is fatal.", - "longDescription": "The value of this property shall indicate the ReadingCelsius is below the normal range and is fatal. The units shall be the same units as the related ReadingCelsius property.", + "description": "The value at which the reading is below normal range and fatal.", + "longDescription": "This property shall contain the value at which the ReadingCelsius property is below the normal range and is fatal. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -440,8 +442,8 @@ "units": "Cel" }, "LowerThresholdNonCritical": { - "description": "Below normal range.", - "longDescription": "The value of this property shall indicate the ReadingCelsius is below the normal range but is not critical. The units shall be the same units as the related ReadingCelsius property.", + "description": "The value at which the reading is below normal range.", + "longDescription": "This property shall contain the value at which the ReadingCelsius property is below normal range. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -451,7 +453,7 @@ }, "MaxAllowableOperatingValue": { "description": "Maximum allowable operating temperature for this equipment.", - "longDescription": "The value of this property shall indicate the maximum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination.", + "longDescription": "This property shall indicate the maximum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination.", "readonly": true, "type": [ "integer", @@ -461,8 +463,8 @@ "versionAdded": "v1_4_0" }, "MaxReadingRangeTemp": { - "description": "Maximum value for ReadingCelsius.", - "longDescription": "The value of this property shall indicate the highest possible value for ReadingCelsius. The units shall be the same units as the related ReadingCelsius property.", + "description": "Maximum value for this sensor.", + "longDescription": "This property shall indicate the highest possible value for the ReadingCelsius property. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -471,14 +473,14 @@ "units": "Cel" }, "MemberId": { - "description": "This is the identifier for the member within the collection.", - "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "description": "The identifier for the member within the collection.", + "longDescription": "This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "MinAllowableOperatingValue": { "description": "Minimum allowable operating temperature for this equipment.", - "longDescription": "The value of this property shall indicate the minimum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination.", + "longDescription": "This property shall indicate the minimum allowable operating temperature for the equipment monitored by this temperature sensor, as specified by a standards body, manufacturer, or a combination.", "readonly": true, "type": [ "integer", @@ -488,8 +490,8 @@ "versionAdded": "v1_4_0" }, "MinReadingRangeTemp": { - "description": "Minimum value for ReadingCelsius.", - "longDescription": "The value of this property shall indicate the lowest possible value for ReadingCelsius. The units shall be the same units as the related ReadingCelsius property.", + "description": "Minimum value for this sensor.", + "longDescription": "This property shall indicate the lowest possible value for the ReadingCelsius property. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -498,8 +500,8 @@ "units": "Cel" }, "Name": { - "description": "Temperature sensor name.", - "longDescription": "The value of this property shall be the name of the temperature sensor.", + "description": "The temperature sensor name.", + "longDescription": "This property shall contain the name of the temperature sensor.", "readonly": true, "type": [ "string", @@ -508,18 +510,18 @@ }, "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." }, "PhysicalContext": { "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext", - "description": "Describes the area or device to which this temperature measurement applies.", - "longDescription": "The value of this property shall be a description of the affected device or region within the chassis to which this temperature measurement applies.", + "description": "The area or device to which this temperature measurement applies.", + "longDescription": "This property shall contain a description of the affected device or region within the chassis to which this temperature applies.", "readonly": true }, "ReadingCelsius": { - "description": "Temperature.", - "longDescription": "The value of this property shall be the current value of the temperature sensor's reading.", + "description": "The temperature in degrees Celsius.", + "longDescription": "This property shall contain the temperature in Celsius degrees.", "readonly": true, "type": [ "number", @@ -528,20 +530,20 @@ "units": "Cel" }, "RelatedItem": { - "description": "Describes the areas or devices to which this temperature measurement applies.", + "description": "The areas or devices to which this temperature applies.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" }, - "longDescription": "The value of this property shall the array of IDs of areas or devices to which this temperature measurement applies.", + "longDescription": "This array property shall contain the IDs of areas or devices to which this temperature applies.", "readonly": true, "type": "array" }, "RelatedItem@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "SensorNumber": { - "description": "A numerical identifier to represent the temperature sensor.", - "longDescription": "The value of this property shall be a numerical identifier for this temperature sensor that is unique within this resource.", + "description": "The numerical identifier of the temperature sensor.", + "longDescription": "This property shall contain a numerical identifier for this temperature sensor that is unique within this Resource.", "readonly": true, "type": [ "integer", @@ -550,12 +552,12 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "UpperThresholdCritical": { - "description": "Above normal range but not yet fatal.", - "longDescription": "The value of this property shall indicate the ReadingCelsius is above the normal range but is not yet fatal. The units shall be the same units as the related ReadingCelsius property.", + "description": "The value at which the reading is above normal range but not yet fatal.", + "longDescription": "This property shall contain the value at which the ReadingCelsius property is above the normal range but is not yet fatal. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -564,8 +566,8 @@ "units": "Cel" }, "UpperThresholdFatal": { - "description": "Above normal range and is fatal.", - "longDescription": "The value of this property shall indicate the ReadingCelsius is above the normal range and is fatal. The units shall be the same units as the related ReadingCelsius property.", + "description": "The value at which the reading is above normal range and fatal.", + "longDescription": "This property shall contain the value at which the ReadingCelsius property is above the normal range and is fatal. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -574,8 +576,8 @@ "units": "Cel" }, "UpperThresholdNonCritical": { - "description": "Above normal range.", - "longDescription": "The value of this property shall indicate the ReadingCelsius is above the normal range but is not critical. The units shall be the same units as the related ReadingCelsius property.", + "description": "The value at which the reading is above normal range.", + "longDescription": "This property shall contain the value at which the ReadingCelsius property is above the normal range. The value of the property shall use the same units as the ReadingCelsius property.", "readonly": true, "type": [ "number", @@ -592,10 +594,10 @@ }, "TemperatureActions": { "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", @@ -611,8 +613,8 @@ "properties": { "Oem": { "$ref": "#/definitions/TemperatureOemActions", - "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_3_0" } }, @@ -620,10 +622,10 @@ }, "TemperatureOemActions": { "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", @@ -641,10 +643,10 @@ }, "Thermal": { "additionalProperties": false, - "description": "This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.", - "longDescription": "This resource shall be used to represent a thermal metrics resource for a Redfish implementation.", + "description": "The Thermal schema describes temperature monitoring and thermal management subsystems, such as cooling fans, for a computer system or similiar devices contained within a chassis.", + "longDescription": "This Resource shall contain the thermal management properties for temperature monitoring and management of cooling fans 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", @@ -659,21 +661,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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/ThermalActions", - "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_3_0" }, "Description": { @@ -689,16 +691,16 @@ }, "Fans": { "autoExpand": true, - "description": "This is the definition for fans.", + "description": "The set of fans for this chassis.", "items": { "$ref": "#/definitions/Fan" }, - "longDescription": "These properties shall be the definition for fans for a Redfish implementation.", + "longDescription": "This property shall contain the set of fans for this chassis.", "readonly": false, "type": "array" }, "Fans@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -710,38 +712,38 @@ }, "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." }, "Redundancy": { "autoExpand": true, - "description": "This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups.", + "description": "The redundancy information for the set of fans in this chassis.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show redundancy for fans and other elements in this resource. The use of IDs within these arrays shall reference the members of the redundancy groups.", + "longDescription": "This property shall contain redundancy information for the fans in this chassis.", "type": "array" }, "Redundancy@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "Temperatures": { "autoExpand": true, - "description": "This is the definition for temperature sensors.", + "description": "The set of temperature sensors for this chassis.", "items": { "$ref": "#/definitions/Temperature" }, - "longDescription": "These properties shall be the definition for temperature sensors for a Redfish implementation.", + "longDescription": "This property shall contain the set of temperature sensors for this chassis.", "readonly": false, "type": "array" }, "Temperatures@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "required": [ @@ -754,10 +756,10 @@ }, "ThermalActions": { "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", @@ -773,8 +775,8 @@ "properties": { "Oem": { "$ref": "#/definitions/ThermalOemActions", - "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_3_0" } }, @@ -782,10 +784,10 @@ }, "ThermalOemActions": { "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", @@ -804,5 +806,5 @@ }, "owningEntity": "DMTF", "release": "2018.2", - "title": "#Thermal.v1_5_1.Thermal" + "title": "#Thermal.v1_5_3.Thermal" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Triggers/Triggers.json b/static/redfish/v1/JsonSchemas/Triggers/Triggers.json index 69fcecd358..595f22560b 100644 --- a/static/redfish/v1/JsonSchemas/Triggers/Triggers.json +++ b/static/redfish/v1/JsonSchemas/Triggers/Triggers.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/Triggers.v1_0_1.json", + "$id": "http://redfish.dmtf.org/schemas/v1/Triggers.v1_1_1.json", "$ref": "#/definitions/Triggers", "$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,23 +25,23 @@ "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." } }, "type": "object" }, "DirectionOfCrossingEnum": { - "description": "The direction of crossing which corresponds to a trigger.", + "description": "The direction of crossing that corresponds to a trigger.", "enum": [ "Increasing", "Decreasing" ], "enumDescriptions": { - "Decreasing": "A trigger occurs when the metric value crosses the trigger value while decreasing.", - "Increasing": "A trigger occurs when the metric value crosses the trigger value while increasing." + "Decreasing": "A trigger is met when the metric value crosses the trigger value while decreasing.", + "Increasing": "A trigger condition is met when the metric value crosses the trigger value while increasing." }, - "longDescription": "The value shall indicate the direction of crossing which corresponds to a trigger.", + "longDescription": "The value shall indicate the direction of crossing that corresponds to a trigger.", "type": "string" }, "DiscreteTrigger": { @@ -49,7 +49,7 @@ "description": "The characteristics of the discrete trigger.", "longDescription": "This object shall contain the characteristics of the discrete trigger.", "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", @@ -64,8 +64,8 @@ }, "properties": { "DwellTime": { - "description": "This time the trigger occurance persists before a trigger event has occurred.", - "longDescription": "This property shall contain the time that a trigger occurance persists before the MetricAction is performed.", + "description": "The amount of time that a trigger event persists before the metric action is performed.", + "longDescription": "This property shall contain the amount of time that a trigger event persists before the MetricAction is performed.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -91,13 +91,13 @@ "type": "null" } ], - "description": "This property contains the value of the Severity property in the Event message.", - "longDescription": "The value of this property shall be used for the Severity property in the Event message.", + "description": "The severity of the event message.", + "longDescription": "This property shall contain the Severity property to be used in the Event message.", "readonly": false }, "Value": { - "description": "The value of the discrete metric that constitutes a trigger occurance.", - "longDescription": "This property shall contain the value discrete metric that constitutes a trigger event. The DwellTimeMilliSeconds shall be measured from this point in time.", + "description": "The discrete metric value that constitutes a trigger event.", + "longDescription": "This property shall contain the value discrete metric that constitutes a trigger event. The DwellTime shall be measured from this point in time.", "readonly": false, "type": [ "string", @@ -108,20 +108,60 @@ "type": "object" }, "DiscreteTriggerConditionEnum": { - "description": "Specifies the condition, in relationship to the discrete trigger values, which constitutes a trigger.", + "description": "The condition, in relationship to the discrete trigger values, which constitutes a trigger.", "enum": [ "Specified", "Changed" ], "enumDescriptions": { - "Changed": "A discrete trigger occures whenever the value of the metric changes.", - "Specified": "A discrete trigger occurs when the value of the metric becomes one of the values listed in the DiscreteTriggers property." + "Changed": "A discrete trigger condition is met whenever the metric value changes.", + "Specified": "A discrete trigger condition is met when the metric value becomes one of the values that the DiscreteTriggers property lists." }, - "longDescription": "The value shall specify the condition, in relationship to the discrete trigger values, which constitutes a trigger.", + "longDescription": "This type shall specify the condition, in relationship to the discrete trigger values, which constitutes a trigger.", "type": "string" }, + "Links": { + "additionalProperties": false, + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource.", + "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": { + "MetricReportDefinitions": { + "description": "The metric report definitions that generate new metric reports when a trigger condition is met and when the TriggerActions property contains `RedfishMetricReport`.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinition.json#/definitions/MetricReportDefinition" + }, + "longDescription": "This property shall contain a set of links to metric report definitions that generate new metric reports when a trigger condition is met and when the TriggerActions property contains `RedfishMetricReport`.", + "readonly": false, + "type": "array", + "versionAdded": "v1_1_0" + }, + "MetricReportDefinitions@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" + }, + "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." + } + }, + "type": "object" + }, "MetricTypeEnum": { - "description": "Specifies the type of metric for which the trigger is configured.", + "description": "The type of metric for which the trigger is configured.", "enum": [ "Numeric", "Discrete" @@ -130,15 +170,15 @@ "Discrete": "The trigger is for a discrete sensor.", "Numeric": "The trigger is for numeric sensor." }, - "longDescription": "The value shall specify the type of metric for which the trigger is configured.", + "longDescription": "This type shall specify the type of metric for which the trigger is configured.", "type": "string" }, "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", @@ -159,7 +199,7 @@ "description": "A threshold definition for a sensor.", "longDescription": "This type shall contain the properties for an individual threshold for this sensor.", "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", @@ -183,12 +223,12 @@ } ], "description": "The direction of crossing that activates this threshold.", - "longDescription": "This property shall indicate the direction of crossing of the Reading value for this Sensor that triggers the threshold.", + "longDescription": "This property shall indicate the direction of crossing of the reading for this sensor that activates the threshold.", "readonly": false }, "DwellTime": { - "description": "The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.", - "longDescription": "This property shall indicate the time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.", + "description": "The duration the sensor value must violate the threshold before the threshold is activated.", + "longDescription": "This property shall indicate the duration the sensor value must violate the threshold before the threshold is activated.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": false, "type": [ @@ -198,7 +238,7 @@ }, "Reading": { "description": "The threshold value.", - "longDescription": "This property shall indicate the Reading value of this Sensor that triggers the threshold. The units of this property shall follow the same units as the property described by MetricProperties.", + "longDescription": "This property shall indicate the reading for this sensor that activates the threshold. The value of the property shall use the same units as the MetricProperties property.", "readonly": false, "type": [ "number", @@ -220,18 +260,18 @@ "Increasing": "Value increases above the threshold." }, "enumLongDescriptions": { - "Decreasing": "This threshold is activated when the value of Reading changes from a value higher than the threshold to a value lower than the threshold.", + "Decreasing": "This threshold is activated when the reading changes from a value higher than the threshold to a value lower than the threshold.", "Either": "This threshold is activated when either the Increasing or Decreasing conditions are met.", - "Increasing": "This threshold is activated when the value of Reading changes from a value lower than the threshold to a value higher than the threshold." + "Increasing": "This threshold is activated when the reading changes from a value lower than the threshold to a value higher than the threshold." }, "type": "string" }, "Thresholds": { "additionalProperties": false, - "description": "The set of thresholds defined for a sensor.", - "longDescription": "This structure shall contain a set of thresholds defined for a sensor.", + "description": "The set of thresholds for a sensor.", + "longDescription": "This type shall contain a set of thresholds for a sensor.", "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", @@ -246,79 +286,57 @@ }, "properties": { "LowerCritical": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Below normal range and requires attention.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range and may require attention. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is below normal range and requires attention.", + "longDescription": "This property shall contain the value at which the MetricProperties property is below the normal range and may require attention. The value of the property shall use the same units as the MetricProperties property." }, "LowerWarning": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Below normal range.", - "longDescription": "The value of this property shall indicate the Reading is below the normal range. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is below normal range.", + "longDescription": "This property shall contain the value at which the MetricProperties property is below the normal range. The value of the property shall use the same units as the MetricProperties property." }, "UpperCritical": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Above normal range and requires attention.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range and may require attention. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is above normal range and requires attention.", + "longDescription": "This property shall contain the value at which the MetricProperties property is above the normal range and may require attention. The value of the property shall use the same units as the MetricProperties property." }, "UpperWarning": { - "anyOf": [ - { - "$ref": "#/definitions/Threshold" - }, - { - "type": "null" - } - ], - "description": "Above normal range.", - "longDescription": "The value of this property shall indicate the Reading is above the normal range. The units shall be the same units as the Reading." + "$ref": "#/definitions/Threshold", + "description": "The value at which the reading is above normal range.", + "longDescription": "This property shall contain the value at which the MetricProperties property is above the normal range. The value of the property shall use the same units as the MetricProperties property." } }, "type": "object" }, "TriggerActionEnum": { - "description": "Specifies the actions to perform when a trigger occurs.", + "description": "The actions to perform when a trigger condition is met.", "enum": [ "LogToLogService", - "RedfishEvent" + "RedfishEvent", + "RedfishMetricReport" ], "enumDescriptions": { - "LogToLogService": "Upon a trigger, record in a log.", - "RedfishEvent": "Upon a trigger, send a Redfish Event message of type Event." + "LogToLogService": "When a trigger condition is met, record in a log.", + "RedfishEvent": "When a trigger condition is met, the Service sends an event to subscribers.", + "RedfishMetricReport": "When a trigger condition is met, force an update of the specified metric reports." }, "enumLongDescriptions": { - "LogToLogService": "When a trigger condition is met, the service shall log the occurrence of the condition to the log indicated by the LogService property in the TelemetryService resource.", - "RedfishEvent": "When a trigger condition is met, the service shall produce a Redfish Event of type Event to matching subscribers indicated in the EventSubscription collection found on the EventService." + "LogToLogService": "This value indicates that when a trigger condition is met, the Service shall log the occurrence of the condition to the log that the LogService property in the TelemetryService Resource describes.", + "RedfishEvent": "This value indicates that when a trigger condition is met, the Service shall send an event to subscribers.", + "RedfishMetricReport": "This value indicates that when a trigger condition is met, the Service shall force the metric reports managed by the MetricReportDefinitions specified by the MetricReportDefinitions property to be updated, regardless of the MetricReportDefinitionType property value. The actions specified in the ReportActions property of each MetricReportDefinition shall be performed." }, - "longDescription": "The value shall specify the actions to perform when a trigger occurs.", + "enumVersionAdded": { + "RedfishMetricReport": "v1_1_0" + }, + "longDescription": "This type shall specify the actions to perform when a trigger condition is met.", "type": "string" }, "Triggers": { "additionalProperties": false, - "description": "Triggers which apply to a list of metrics.", - "longDescription": "This resource shall specify triggers, which apply to a list of metrics.", + "description": "The Triggers schema describes a trigger that applies to metrics.", + "longDescription": "This Resource shall contain a trigger that applies to metrics.", "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", @@ -333,21 +351,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -369,32 +387,52 @@ "type": "null" } ], - "description": "Specifies the conditions when a discrete metric triggers.", - "longDescription": "The value of this property shall specify the conditions when a discrete metric triggers.", + "description": "The conditions when a discrete metric triggers.", + "longDescription": "This property shall contain the conditions when a discrete metric triggers.", "readonly": true }, "DiscreteTriggers": { - "description": "List of discrete triggers.", + "description": "The list of discrete triggers.", "items": { "$ref": "#/definitions/DiscreteTrigger" }, - "longDescription": "This property shall contains a list of value to which a metric reading will be compared. This property shall be present when the DiscreteTriggerCondition property has a value of 'Specified'.", + "longDescription": "This property shall contain a list of values to which to compare a metric reading. This property shall be present when the DiscreteTriggerCondition property is `Specified`.", "type": "array" }, + "EventTriggers": { + "description": "The array of MessageIds that specify when a trigger condition is met based on an event.", + "items": { + "type": [ + "string", + "null" + ] + }, + "longDescription": "This property shall contain an array of MessageIds that specify when a trigger condition is met based on an event. When the Service generates an event and if it contains a MessageId within this array, a trigger condition shall be met.", + "pattern": "^[A-Za-z0-9]+\\.\\d+\\.\\d+\\.[A-Za-z0-9.]+$", + "readonly": false, + "type": "array", + "versionAdded": "v1_1_0" + }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, + "Links": { + "$ref": "#/definitions/Links", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", + "versionAdded": "v1_1_0" + }, "MetricProperties": { - "description": "A list of URIs with wildcards and property identifiers for which this trigger is defined. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.", - "format": "uri", + "description": "An array of URIs with wildcards and property identifiers for this trigger. Each wildcard shall be replaced with its corresponding entry in the Wildcard array property.", + "format": "uri-reference", "items": { "type": [ "string", "null" ] }, - "longDescription": "This array property shall contain a list of URIs with wildcards and property identifiers for which this trigger is defined. Each wildcard in the URI shall be delimited by a set of curly braces. Each wildcard shall be substituted as specified by the corresponding entry in the Wildcard array property. Once an URI with wildcards has had its wildcards fully substituted, it shall reference a resource property for which the metric definition applies. The property identifiers portion of the URI shall follow JSON fragment notation rules defined by RFC6901.", + "longDescription": "This property shall contain an array of URIs with wildcards and property identifiers for this trigger. Use a set of curly braces to delimit each wildcard in the URI. Replace each wildcard with its corresponding entry in the Wildcard array property. A URI that contains wildcards shall link to a Resource property to which the metric definition applies after all wildcards are replaced with their corresponding entries in the Wildcard array property. The property identifiers portion of the URI shall follow the RFC6901-defined JSON fragment notation rules.", "readonly": false, "type": "array" }, @@ -407,8 +445,8 @@ "type": "null" } ], - "description": "The type of trigger.", - "longDescription": "The value of this property shall specific the type of trigger.", + "description": "The metric type of the trigger.", + "longDescription": "This property shall contain the metric type of the trigger.", "readonly": true }, "Name": { @@ -416,49 +454,35 @@ "readonly": true }, "NumericThresholds": { - "anyOf": [ - { - "$ref": "#/definitions/Thresholds" - }, - { - "type": "null" - } - ], - "description": "Specifies the thresholds when a numeric metric triggers.", - "longDescription": "This property shall contain list of thresholds to which a numeric metric value shall be compared." + "$ref": "#/definitions/Thresholds", + "description": "The thresholds when a numeric metric triggers.", + "longDescription": "This property shall contain the list of thresholds to which to compare a numeric metric value." }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status and health properties of the Resource." }, "TriggerActions": { - "description": "This property specifies the actions to perform when the trigger occurs.", + "description": "The actions that the trigger initiates.", "items": { "$ref": "#/definitions/TriggerActionEnum" }, - "longDescription": "The value of this property shall specify the actions to perform when the trigger occurs.", + "longDescription": "This property shall contain the actions that the trigger initiates.", "readonly": true, "type": "array" }, "Wildcards": { - "description": "A list of wildcards and their substitution values to be applied to the entries in the MetricProperties array property.", + "description": "The wildcards and their substitution values for the entries in the MetricProperties array property.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Wildcard" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Wildcard" }, - "longDescription": "The property shall contain a list of wildcards and their replacement strings, which are applied to the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property.", + "longDescription": "This property shall contain the wildcards and their substitution values for the entries in the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property.", "type": "array" } }, @@ -472,10 +496,10 @@ }, "Wildcard": { "additionalProperties": false, - "description": "Contains a wildcard and its substitution values.", + "description": "The wildcard and its substitution values.", "longDescription": "This property shall contain a wildcard and its substitution values.", "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", @@ -490,7 +514,7 @@ }, "properties": { "Name": { - "description": "The string used as a wildcard.", + "description": "The wildcard.", "longDescription": "This property shall contain the string used as a wildcard.", "readonly": true, "type": [ @@ -506,7 +530,7 @@ "null" ] }, - "longDescription": "This property shall contain the list of values to susubstitute for the wildcard.", + "longDescription": "This array property shall contain the list of values to substitute for the wildcard.", "readonly": true, "type": "array" } @@ -515,6 +539,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.2", - "title": "#Triggers.v1_0_1.Triggers" + "release": "2019.1", + "title": "#Triggers.v1_1_1.Triggers" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json b/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json index 5726a4eb23..203cc22fdf 100644 --- a/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json +++ b/static/redfish/v1/JsonSchemas/UpdateService/UpdateService.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/UpdateService.v1_4_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/UpdateService.v1_6_0.json", "$ref": "#/definitions/UpdateService", "$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", @@ -28,8 +28,8 @@ }, "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." } }, "type": "object" @@ -42,25 +42,25 @@ "InMaintenanceWindowOnReset" ], "enumDescriptions": { - "AtMaintenanceWindowStart": "Apply during a maintenance window as specified by an administrator.", + "AtMaintenanceWindowStart": "Apply during an administrator-specified maintenance window.", "Immediate": "Apply immediately.", - "InMaintenanceWindowOnReset": "Apply after a reset but within maintenance window as specified by an adminstrator.", + "InMaintenanceWindowOnReset": "Apply after a reset but within an administrator-specified maintenance window.", "OnReset": "Apply on a reset." }, "enumLongDescriptions": { - "AtMaintenanceWindowStart": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window.", - "Immediate": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied immediately.", - "InMaintenanceWindowOnReset": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window.", - "OnReset": "This ApplyTime value shall be used to indicate the software provided via HttpPushUri is applied when the system or service is reset." + "AtMaintenanceWindowStart": "This value shall indicate the HttpPushUri-provided software is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A Service may perform resets during this maintenance window.", + "Immediate": "This value shall indicate the HttpPushUri-provided software is applied immediately.", + "InMaintenanceWindowOnReset": "This value shall indicate the HttpPushUri-provided software is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window.", + "OnReset": "This value shall indicate the HttpPushUri-provided software is applied when the system or Service is reset." }, "type": "string" }, "HttpPushUriApplyTime": { "additionalProperties": false, - "description": "This object contains settings for when software is to be applied when provided via HttpPushUri.", - "longDescription": "The properties in this object shall contain settings for when software is to be applied when provided via HttpPushUri.", + "description": "The settings for when to apply HttpPushUri-provided software.", + "longDescription": "The properties in this object shall contain settings for when to apply HttpPushUri-provided software.", "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", @@ -76,14 +76,14 @@ "properties": { "ApplyTime": { "$ref": "#/definitions/ApplyTime", - "description": "This property indicates when the software update invoked via HttpPushUri should be applied.", - "longDescription": "The value of this property shall indicate the preference on to when to apply the software provided via HttpPushUri.", + "description": "The time when to apply the HttpPushUri-provided software update.", + "longDescription": "This property shall indicate the time when to apply the HttpPushUri-provided software update.", "readonly": false, "versionAdded": "v1_4_0" }, "MaintenanceWindowDurationInSeconds": { - "description": "The value of this property as specified by client indicates the expiry time of maintenance window in seconds.", - "longDescription": "The value of this property shall indicate the end of the maintenance window as the number of seconds after the time specified by the HttpPushUriMaintenanceWindowStartTime property. This property shall be required if the HttpPushUriApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "description": "The expiry time, in seconds, of the maintenance window.", + "longDescription": "This property shall indicate the end of the maintenance window as the number of seconds after the time specified by the HttpPushUriMaintenanceWindowStartTime property. This property shall contain required if the HttpPushUriApplyTime property value is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`.", "minimum": 0, "readonly": false, "type": "integer", @@ -91,9 +91,9 @@ "versionAdded": "v1_4_0" }, "MaintenanceWindowStartTime": { - "description": "The value of this property as specified by client to indicate the start time of a maintenance window.", + "description": "The start time of a maintenance window.", "format": "date-time", - "longDescription": "The value of this property shall indicate the date and time as to when the service is allowed to start applying the software provided via HttpPushUri as part of a maintenance window. This property shall be required if the HttpPushUriApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset.", + "longDescription": "This property shall indicate the date and time when the Service can start to apply the HttpPushUri-provided software as part of a maintenance window. This property shall contain required if the HttpPushUriApplyTime property value is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`.", "readonly": false, "type": "string", "versionAdded": "v1_4_0" @@ -103,10 +103,10 @@ }, "HttpPushUriOptions": { "additionalProperties": false, - "description": "This object contains settings for software update via HttpPushUri.", - "longDescription": "The properties in this object shall contain settings and requirements of the service for software update via HttpPushUri.", + "description": "The settings for HttpPushUri-provided software updates.", + "longDescription": "The properties in this object shall contain settings and requirements of the Service for HttpPushUri-provided software updates.", "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", @@ -122,8 +122,8 @@ "properties": { "HttpPushUriApplyTime": { "$ref": "#/definitions/HttpPushUriApplyTime", - "description": "This property contains settings for when firmware is to be applied when provided via HttpPushUri.", - "longDescription": "The value of this property shall contain settings for when firmware is to be applied when provided via HttpPushUri.", + "description": "The settings for when to apply HttpPushUri-provided firmware.", + "longDescription": "This property shall contain settings for when to apply HttpPushUri-provided firmware.", "versionAdded": "v1_4_0" } }, @@ -131,10 +131,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", @@ -152,45 +152,45 @@ }, "SimpleUpdate": { "additionalProperties": false, - "description": "This action is used to update software components.", - "longDescription": "This action shall perform an update of installed software component(s) as contained within a software image file located at a URI referenced by the ImageURI parameter.", + "description": "This action updates software components.", + "longDescription": "This action shall update installed software components in a software image file located at an ImageURI parameter-specified URI.", "parameters": { "ImageURI": { - "description": "The URI of the software image to be installed.", - "longDescription": "This parameter shall contain a URI referencing a software image to be retreived by the UpdateService for the purpose of installing software contained within the image.", + "description": "The URI of the software image to install.", + "longDescription": "This parameter shall contain an RFC3986-defined URI that links to a software image that the Update Service retrieves to install software in that image. This URI should contain a scheme that describes the transfer protocol. If the TransferProtocol parameter is absent or not supported, and a transfer protocol is not specified by a scheme contained within this URI, the Service shall use HTTP to get the image.", "requiredParameter": true, "type": "string" }, "Password": { - "description": "The password to be used when accessing the URI specified by the ImageURI parameter.", - "longDescription": "This parameter shall contain a string representing the password to be used when accessing the URI specified by the ImageURI parameter.", + "description": "The password to access the URI specified by the ImageURI parameter.", + "longDescription": "This parameter shall represent the password to access the URI specified by the ImageURI parameter.", "type": "string", "versionAdded": "v1_4_0" }, "Targets": { - "description": "The array of URIs indicating where the update image is to be applied.", - "format": "uri", + "description": "An array of URIs that indicate where to apply the update image.", + "format": "uri-reference", "items": { "type": "string" }, - "longDescription": "This array property shall contain zero or more URIs indicating where the update image is to be applied. These targets should correspond to SoftwareInventory instances or their RelatedItems. If this property is not present or contains zero targets, the Service shall apply the software image to all applicable targets (as determined by the Service).", + "longDescription": "This array property shall contain zero or more URIs that indicate where to apply the update image. These targets should correspond to SoftwareInventory instances or their related items. If this parameter is not present or contains no targets, the Service shall apply the software image to all applicable targets, as determined by the Service.", "type": "array", "versionAdded": "v1_2_0" }, "TransferProtocol": { "$ref": "#/definitions/TransferProtocolType", - "description": "The network protocol used by the Update Service to retrieve the software image file located at the URI provided in ImageURI, if the URI does not contain a scheme.", - "longDescription": "This parameter shall contain the network protocol that the Update Service shall use to retreive the software image located at the ImageURI. If this parameter is not provided (or supported), and a transfer protocol is not specified by a scheme contained within ImageURI, the Update Service shall use HTTP to retrieve the image." + "description": "The network protocol that the Update Service uses to retrieve the software image file located at the URI provided in ImageURI, if the URI does not contain a scheme.", + "longDescription": "This parameter shall contain the network protocol that the Update Service shall use to retreive the software image located at the ImageURI. If this parameter is not provided (or supported), and a transfer protocol is not specified by a scheme contained within this URI, the Service shall use HTTP to retrieve the image." }, "Username": { - "description": "The username to be used when accessing the URI specified by the ImageURI parameter.", - "longDescription": "This parameter shall contain a string representing the username to be used when accessing the URI specified by the ImageURI parameter.", + "description": "The user name to access the URI specified by the ImageURI parameter.", + "longDescription": "This parameter shall represent the user name to access the URI specified by the ImageURI parameter.", "type": "string", "versionAdded": "v1_4_0" } }, "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", @@ -206,7 +206,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -230,19 +230,19 @@ "NFS" ], "enumDeprecated": { - "NSF": "This value has been Deprecated in favor of NFS." + "NSF": "This value has been deprecated in favor of NFS." }, "enumDescriptions": { - "CIFS": "Common Internet File System protocol.", - "FTP": "File Transfer Protocol.", - "HTTP": "Hypertext Transfer Protocol.", - "HTTPS": "HTTP Secure protocol.", - "NFS": "Network File System protocol.", - "NSF": "Network File System protocol.", - "OEM": "A protocol defined by the manufacturer.", - "SCP": "Secure File Copy protocol.", - "SFTP": "Secure File Transfer Protocol.", - "TFTP": "Trivial File Transfer Protocol." + "CIFS": "Common Internet File System (CIFS).", + "FTP": "File Transfer Protocol (FTP).", + "HTTP": "Hypertext Transfer Protocol (HTTP).", + "HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).", + "NFS": "Network File System (NFS).", + "NSF": "Network File System (NFS).", + "OEM": "A manufacturer-defined protocol.", + "SCP": "Secure Copy Protocol (SCP).", + "SFTP": "Secure File Transfer Protocol (SFTP).", + "TFTP": "Trivial File Transfer Protocol (TFTP)." }, "enumVersionAdded": { "NFS": "v1_3_0", @@ -253,12 +253,48 @@ }, "type": "string" }, + "UpdateParameters": { + "additionalProperties": false, + "description": "The update parameters used with MultipartHttpPushUri software update.", + "longDescription": "This type shall contain the update parameters when passing the update image when using the URI specified by the MultipartHttpPushUri property to push a software image.", + "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": { + "Targets": { + "description": "An array of URIs that indicate where to apply the update image.", + "format": "uri-reference", + "items": { + "type": [ + "string", + "null" + ] + }, + "longDescription": "This property shall contain zero or more URIs that indicate where to apply the update image when using the URI specified by the MultipartHttpPushUri property to push a software image. These targets should correspond to SoftwareInventory instances or their related items. If this property is not present or contains no targets, the Service shall apply the software image to all applicable targets, as determined by the Service.", + "readonly": true, + "type": "array", + "versionAdded": "v1_6_0" + } + }, + "type": "object" + }, "UpdateService": { "additionalProperties": false, - "description": "This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory.", - "longDescription": "This resource shall be used to represent an Update Service for a Redfish implementation. It represents the properties that affect the service itself.", + "description": "The UpdateService schema describes the Update Service and the properties for the Service itself with links to collections of firmware and software inventory. The Update Service also provides methods for updating software and firmware of the Resources in a Redfish Service.", + "longDescription": "This Resource shall represent an Update Service and the properties that affect the Service itself 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", @@ -273,21 +309,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." }, "Description": { "anyOf": [ @@ -301,35 +337,28 @@ "readonly": true }, "FirmwareInventory": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection" - }, - { - "type": "null" - } - ], + "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection", "description": "An inventory of firmware.", - "longDescription": "The value of this property shall be a link to a resource of type SoftwareInventoryCollection.", + "longDescription": "This property shall contain a link to a Resource of type SoftwareInventoryCollection.", "readonly": true }, "HttpPushUri": { - "description": "The URI used to perform an HTTP or HTTPS push update to the Update Service.", - "format": "uri", - "longDescription": "This property shall contain a URI at which the UpdateService supports an HTTP or HTTPS POST of a software image for the purpose of installing software contained within the image. Access to this URI shall require the same privilege as access to the Update Service.", + "description": "The URI used to perform an HTTP or HTTPS push update to the Update Service. The format of the message is vendor-specific.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI at which the Update Service supports an HTTP or HTTPS POST of a software image for the purpose of installing software contained within the image. Access to this URI shall require the same privilege as access to the Update Service. If the Service requires the Content-Length header for POST requests to this URI, the service should return HTTP 411 if the client does not include this header in the POST request.", "readonly": true, "type": "string", "versionAdded": "v1_1_0" }, "HttpPushUriOptions": { "$ref": "#/definitions/HttpPushUriOptions", - "description": "This property contains options for software update via HttpPushUri.", - "longDescription": "The value of this property shall contain options and requirements of the service for software update via HttpPushUri.", + "description": "The options for HttpPushUri-provided software updates.", + "longDescription": "This property shall contain options and requirements of the Service for HttpPushUri-provided software updates.", "versionAdded": "v1_4_0" }, "HttpPushUriOptionsBusy": { - "description": "This represents if the properties of HttpPushUriOptions are reserved by any client.", - "longDescription": "This property shall be a boolean that determines when the properties within the HttpPushUriOptions object are being used by a client for software updates. A client should set this property to True when it is using any properties in HttpPushUriOptions for software update, and should set it to False when it is no longer using HttpPushUriOptions properties for updates. The property can provide multiple clients a way to negotiate ownership of HttpPushUriOptions. This will help clients to know if a firmware update using HttpPushUriOptions is used by another client. This property has no functional requirements for the Service.", + "description": "An indication of whether a client has reserved the HttpPushUriOptions properties for software updates.", + "longDescription": "This property shall indicate whether a client uses the HttpPushUriOptions properties for software updates. When a client uses any HttpPushUriOptions properties for software updates, it should set this property to `true`. When a client no longer uses HttpPushUriOptions properties for software updates, it should set this property to `false`. This property can provide multiple clients a way to negotiate ownership of HttpPushUriOptions properties. Clients can use this property to determine whether another client uses HttpPushUriOptions properties for software updates. This property has no functional requirements for the Service.", "readonly": false, "type": [ "boolean", @@ -338,22 +367,22 @@ "versionAdded": "v1_4_0" }, "HttpPushUriTargets": { - "description": "The array of URIs indicating the target for applying the update image.", - "format": "uri", + "description": "An array of URIs that indicate where to apply the update image.", + "format": "uri-reference", "items": { "type": [ "string", "null" ] }, - "longDescription": "This property shall contain zero or more URIs indicating the targets for applying the update image when using HttpPushUri to push a software image. These targets should correspond to SoftwareInventory instances or their RelatedItems. If this property is not present or contains zero targets, the Service shall apply the software image to all applicable targets (as determined by the Service).", + "longDescription": "This property shall contain zero or more URIs that indicate where to apply the update image when using the URI specified by the HttpPushUri property to push a software image. These targets should correspond to SoftwareInventory instances or their related items. If this property is not present or contains no targets, the Service shall apply the software image to all applicable targets, as determined by the Service.", "readonly": false, "type": "array", "versionAdded": "v1_2_0" }, "HttpPushUriTargetsBusy": { - "description": "This represents if the HttpPushUriTargets property is reserved by any client.", - "longDescription": "This property shall be a boolean that determines when the HttpPushUriTargets property is being used by a client for firmware updates. A client should set this property to True when it is using HttpPushUriTargets for firmware update, and should set it to False when it is no longer using HttpPushUriTargets for updates. The property can provide multiple clients a way to negotiate ownership of HttpPushUriTargets. This will help clients to know if a firmware update using HttpPushUriTargets is used by another client. This property has no functional requirements for the Service.", + "description": "An indication of whether any client has reserved the HttpPushUriTargets property.", + "longDescription": "This property shall indicate whether any client has reserved the HttpPushUriTargets property for firmware updates. A client should set this property to `true` when it uses HttpPushUriTargets for firmware updates. A client should set it to `false` when it is no longer uses HttpPushUriTargets for updates. The property can provide multiple clients a way to negotiate ownership of HttpPushUriTargets and helps clients determine whether another client is using HttpPushUriTargets to make firmware updates. This property has no functional requirements for the Service.", "readonly": false, "type": [ "boolean", @@ -365,18 +394,37 @@ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, + "MaxImageSizeBytes": { + "description": "The maximum size in bytes of the software update image that this Service supports.", + "longDescription": "This property shall indicate the maximum size of the software update image that clients can send to this Update Service.", + "readonly": true, + "type": [ + "integer", + "null" + ], + "units": "By", + "versionAdded": "v1_5_0" + }, + "MultipartHttpPushUri": { + "description": "The URI used to perform a Redfish Specification-defined Multipart HTTP or HTTPS push update to the Update Service.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI used to perform a Redfish Specification-defined Multipart HTTP or HTTPS POST of a software image for the purpose of installing software contained within the image.", + "readonly": true, + "type": "string", + "versionAdded": "v1_6_0" + }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "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." }, "ServiceEnabled": { - "description": "This indicates whether this service is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -384,22 +432,15 @@ ] }, "SoftwareInventory": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection" - }, - { - "type": "null" - } - ], + "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection.json#/definitions/SoftwareInventoryCollection", "description": "An inventory of software.", - "longDescription": "The value of this property shall be a link to a resource of type SoftwareInventoryCollection.", + "longDescription": "This property shall contain a link to a Resource of type SoftwareInventoryCollection.", "readonly": true }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." } }, "required": [ @@ -412,6 +453,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#UpdateService.v1_4_0.UpdateService" + "release": "2019.2", + "title": "#UpdateService.v1_6_0.UpdateService" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/VLanNetworkInterface/VLanNetworkInterface.json b/static/redfish/v1/JsonSchemas/VLanNetworkInterface/VLanNetworkInterface.json index b52266fb2b..efabbc0c57 100644 --- a/static/redfish/v1/JsonSchemas/VLanNetworkInterface/VLanNetworkInterface.json +++ b/static/redfish/v1/JsonSchemas/VLanNetworkInterface/VLanNetworkInterface.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.v1_1_4.json", "$ref": "#/definitions/VLanNetworkInterface", "$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,18 +25,19 @@ "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" }, "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", @@ -53,10 +55,10 @@ }, "VLAN": { "additionalProperties": false, - "description": "This type describes the attributes of a Virtual LAN.", - "longDescription": "This type shall contain any attributes of a Virtual LAN.", + "description": "The attributes of a VLAN.", + "longDescription": "This type shall contain any attributes of a VLAN.", "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", @@ -71,8 +73,8 @@ }, "properties": { "VLANEnable": { - "description": "This indicates if this VLAN is enabled.", - "longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for this interface.", + "description": "An indication of whether this VLAN is enabled for this VLAN network interface.", + "longDescription": "This property shall indicate whether this VLAN is enabled for this VLAN network interface.", "readonly": false, "type": [ "boolean", @@ -88,8 +90,8 @@ "type": "null" } ], - "description": "This indicates the VLAN identifier for this VLAN.", - "longDescription": "The value of this property shall be used to indicate the VLAN identifier for this VLAN.", + "description": "The ID for this VLAN.", + "longDescription": "This property shall contain the ID for this VLAN.", "readonly": false } }, @@ -106,10 +108,10 @@ }, "VLanNetworkInterface": { "additionalProperties": false, - "description": "This resource describes the attributes of a Virtual LAN.", - "longDescription": "This resource shall contain any attributes of a Virtual LAN.", + "description": "The attributes of a VLAN.", + "longDescription": "The VLanNetworkInterface Schema shall contain any attributes of a VLAN.", "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", @@ -124,21 +126,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": [ @@ -161,12 +164,12 @@ }, "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." }, "VLANEnable": { - "description": "This indicates if this VLAN is enabled.", - "longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for this interface.", + "description": "An indication of whether this VLAN is enabled for this interface.", + "longDescription": "This property shall indicate whether this VLAN is enabled for this interface.", "readonly": false, "type": [ "boolean", @@ -182,8 +185,8 @@ "type": "null" } ], - "description": "This indicates the VLAN identifier for this VLAN.", - "longDescription": "The value of this property shall be used to indicate the VLAN identifier for this VLAN.", + "description": "The ID for this VLAN.", + "longDescription": "This property shall contain the ID for this VLAN.", "readonly": false } }, @@ -201,5 +204,6 @@ } }, "owningEntity": "DMTF", - "title": "#VLanNetworkInterface.v1_1_2.VLanNetworkInterface" + "release": "2017.1", + "title": "#VLanNetworkInterface.v1_1_4.VLanNetworkInterface" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json b/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json index 8053690943..dcdeee9924 100644 --- a/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json +++ b/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/VirtualMedia.v1_3_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/VirtualMedia.v1_3_2.json", "$ref": "#/definitions/VirtualMedia", "$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", @@ -31,8 +31,8 @@ }, "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" } }, @@ -48,18 +48,18 @@ "enumDescriptions": { "Applet": "Connected to a client application.", "NotConnected": "No current connection.", - "Oem": "Connected via an OEM-defined method.", + "Oem": "Connected through an OEM-defined method.", "URI": "Connected to a URI location." }, "type": "string" }, "EjectMedia": { "additionalProperties": false, - "description": "This action is used to detach remote media from virtual media.", - "longDescription": "This action shall detach the remote media from the virtual media. At the completion of the operation, inserted shall be set to false and the image name shall be cleared.", + "description": "This action detaches remote media from virtual media.", + "longDescription": "This action shall detach the remote media from the virtual media. At the completion of the operation, inserted shall be set to `false` and the image name shall be cleared.", "parameters": {}, "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", @@ -75,7 +75,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -88,52 +88,52 @@ }, "InsertMedia": { "additionalProperties": false, - "description": "This action is used to attach remote media to virtual media.", + "description": "This action attaches remote media to virtual media.", "longDescription": "This action shall attach remote media to virtual media.", "parameters": { "Image": { "description": "The URI of the remote media to attach to the virtual media.", - "longDescription": "This value shall specify the URI of the remote media to be attached to the virtual media.", + "longDescription": "This parameter shall specify the URI of the remote media to be attached to the virtual media.", "requiredParameter": true, "type": "string" }, "Inserted": { - "description": "Indicates if the image is to be treated as inserted upon completion of the action.", - "longDescription": "This value shall specify if the image is to be treated as inserted upon completion of the action. If this parameter is not provided by the client, the service shall default this value to be true.", + "description": "An indication of whether the image is treated as inserted upon completion of the action. The default is `true`.", + "longDescription": "This parameter shall indicate whether the image is treated as inserted upon completion of the action. If the client does not provide this parameter, the service shall default this value to `true`.", "type": "boolean" }, "Password": { - "description": "The password to be used when accessing the URI specified by the Image parameter.", - "longDescription": "This parameter shall contain a string representing the password to be used when accessing the URI specified by the Image parameter.", + "description": "The password to access the Image parameter-specified URI.", + "longDescription": "This parameter shall represent the password to access the Image parameter-specified URI.", "type": "string", "versionAdded": "v1_3_0" }, "TransferMethod": { "$ref": "#/definitions/TransferMethod", - "description": "Transfer method to use with the given Image.", - "longDescription": "This parameter shall contain a value describing how the image transfer is done.", + "description": "The transfer method to use with the Image.", + "longDescription": "This parameter shall describe how the image transfer occurs.", "versionAdded": "v1_3_0" }, "TransferProtocolType": { "$ref": "#/definitions/TransferProtocolType", - "description": "Network protocol to use with the image.", - "longDescription": "This parameter shall contain a value representing the network protocol to use with the specified image URI.", + "description": "The network protocol to use with the image.", + "longDescription": "This parameter shall represent the network protocol to use with the specified image URI.", "versionAdded": "v1_3_0" }, "UserName": { - "description": "The username to be used when accessing the URI specified by the Image parameter.", - "longDescription": "This parameter shall contain a string representing the username to be used when accessing the URI specified by the Image parameter.", + "description": "The user name to access the Image parameter-specified URI.", + "longDescription": "This parameter shall contain the user name to access the Image parameter-specified URI.", "type": "string", "versionAdded": "v1_3_0" }, "WriteProtected": { - "description": "Indicates if the remote media is supposed to be treated as write protected.", - "longDescription": "This value shall specify if the remote media is supposed to be treated as write protected. If this parameter is not provided by the client, the service shall default this value to be true.", + "description": "An indication of whether the remote media is treated as write-protected. The default is `true`.", + "longDescription": "This parameter shall indicate whether the remote media is treated as write-protected. If the client does not provide this parameter, the service shall default this value to `true`.", "type": "boolean" } }, "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", @@ -149,7 +149,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -177,10 +177,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", @@ -220,24 +220,24 @@ "OEM" ], "enumDescriptions": { - "CIFS": "Common Internet File System protocol.", - "FTP": "File Transfer Protocol.", - "HTTP": "Hypertext Transfer Protocol.", - "HTTPS": "HTTP Secure protocol.", - "NFS": "Network File System protocol.", - "OEM": "A protocol defined by the manufacturer.", - "SCP": "Secure File Copy protocol.", - "SFTP": "Secure File Transfer Protocol.", - "TFTP": "Trivial File Transfer Protocol." + "CIFS": "Common Internet File System (CIFS).", + "FTP": "File Transfer Protocol (FTP).", + "HTTP": "Hypertext Transfer Protocol (HTTP).", + "HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).", + "NFS": "Network File System (NFS).", + "OEM": "A manufacturer-defined protocol.", + "SCP": "Secure Copy Protocol (SCP).", + "SFTP": "Secure File Transfer Protocol (SFTP).", + "TFTP": "Trivial File Transfer Protocol (TFTP)." }, "type": "string" }, "VirtualMedia": { "additionalProperties": false, - "description": "The VirtualMedia schema contains properties related to monitoring and control of an instance of virtual media such as a remote CD, DVD, or USB device. Virtual media functionality is provided by a Manager for a system or device.", - "longDescription": "This resource shall be used to represent a virtual media service for a Redfish implementation.", + "description": "The VirtualMedia schema contains properties related to the monitor and control of an instance of virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides virtual media functionality.", + "longDescription": "This Resource shall represent a virtual media service 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", @@ -252,21 +252,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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" }, "ConnectedVia": { @@ -278,8 +278,8 @@ "type": "null" } ], - "description": "Current virtual media connection methods.", - "longDescription": "The value of this property shall indicate the current connection method from a client to the virtual media represented by this resource. A value of NotConnected shall indicate no connection is present. A value of URI shall indicate that a remote connection via a URI reference type is being used.", + "description": "The current virtual media connection method.", + "longDescription": "This property shall contain the current connection method from a client to the virtual media that this Resource represents.", "readonly": true }, "Description": { @@ -298,9 +298,9 @@ "readonly": true }, "Image": { - "description": "A URI providing the location of the selected image.", - "format": "uri", - "longDescription": "The value of this string shall be an URI. A null value indicated no image connection.", + "description": "The URI of the location of the selected image.", + "format": "uri-reference", + "longDescription": "This property shall contain an URI. A null value indicated no image connection.", "readonly": false, "type": [ "string", @@ -309,7 +309,7 @@ }, "ImageName": { "description": "The current image name.", - "longDescription": "The value of this property shall be the name of the image.", + "longDescription": "This property shall contain the name of the image.", "readonly": true, "type": [ "string", @@ -317,8 +317,8 @@ ] }, "Inserted": { - "description": "Indicates if virtual media is inserted in the virtual device.", - "longDescription": "The value of this property shall be used to indicate if media is present in the virtual media device. This is usually only applicable to remoting of devices and not for image virtual media usage.", + "description": "An indication of whether virtual media is inserted into the virtual device.", + "longDescription": "This property shall indicate whether media is present in the virtual media device.", "readonly": false, "type": [ "boolean", @@ -326,7 +326,7 @@ ] }, "MediaTypes": { - "description": "This is the media types supported as virtual media.", + "description": "The media types supported as virtual media.", "items": { "$ref": "#/definitions/MediaType" }, @@ -340,12 +340,12 @@ }, "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." }, "Password": { - "description": "The password to be used when accessing the URI specified by the Image parameter. This property is null on a GET.", - "longDescription": "This parameter shall contain a string representing the password to be used when accessing the URI specified by the Image parameter. The value shall be null for GET requests.", + "description": "The password to access the Image parameter-specified URI. This property is null in responses.", + "longDescription": "This parameter shall represent the password to access the Image parameter-specified URI. The value shall be null in responses.", "readonly": false, "type": [ "string", @@ -362,8 +362,8 @@ "type": "null" } ], - "description": "Transfer method to use with the given Image.", - "longDescription": "This parameter shall contain a value describing how the image transfer is done.", + "description": "The transfer method to use with the Image.", + "longDescription": "This parameter shall describe how the image transfer occurs.", "readonly": false, "versionAdded": "v1_3_0" }, @@ -376,14 +376,14 @@ "type": "null" } ], - "description": "Network protocol to use with the image.", - "longDescription": "This parameter shall contain a value representing the network protocol to use with the specified image URI.", + "description": "The network protocol to use with the image.", + "longDescription": "This parameter shall represent the network protocol to use with the specified image URI.", "readonly": false, "versionAdded": "v1_3_0" }, "UserName": { - "description": "The username to be used when accessing the URI specified by the Image parameter.", - "longDescription": "This parameter shall contain a string representing the username to be used when accessing the URI specified by the Image parameter.", + "description": "The user name to access the Image parameter-specified URI.", + "longDescription": "This parameter shall represent the user name to access the Image parameter-specified URI.", "readonly": false, "type": [ "string", @@ -392,8 +392,8 @@ "versionAdded": "v1_3_0" }, "WriteProtected": { - "description": "Indicates the media is write protected.", - "longDescription": "The value of this property shall be used to indicate if the remote device media prevents writing to that media.", + "description": "An indication of whether the media is write-protected.", + "longDescription": "This property shall indicate whether the remote device media prevents writing to that media.", "readonly": false, "type": [ "boolean", @@ -412,5 +412,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#VirtualMedia.v1_3_0.VirtualMedia" + "title": "#VirtualMedia.v1_3_2.VirtualMedia" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Volume/Volume.json b/static/redfish/v1/JsonSchemas/Volume/Volume.json index a3f811916a..0f8d402d8e 100644 --- a/static/redfish/v1/JsonSchemas/Volume/Volume.json +++ b/static/redfish/v1/JsonSchemas/Volume/Volume.json @@ -1,328 +1,673 @@ { - "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_2_0.json", - "title": "#Volume.v1_0_3.Volume", "$ref": "#/definitions/Volume", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", + "copyright": "Copyright 2016-2018 Storage Networking Industry Association (SNIA), USA. All rights reserved. For the full SNIA copyright policy, see http://www.snia.org/about/corporate_info/copyright", "definitions": { - "Initialize": { + "Actions": { + "additionalProperties": false, "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[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", "boolean", + "integer", "number", "null", "object", "string" - ], - "description": "This property shall specify a valid odata or Redfish property." + ] } }, - "type": "object", - "additionalProperties": false, "properties": { - "title": { - "type": "string", - "description": "Friendly action name" + "#Volume.CheckConsistency": { + "$ref": "#/definitions/CheckConsistency" }, + "#Volume.Initialize": { + "$ref": "#/definitions/Initialize" + }, + "Oem": { + "$ref": "#/definitions/OemActions" + } + }, + "type": "object" + }, + "CheckConsistency": { + "additionalProperties": false, + "description": "This action is used to force a check of the Volume's parity or redundant data to ensure it matches calculated values.", + "longDescription": "This defines the name of the custom action supported on this resource.", + "parameters": {}, + "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": { "target": { - "type": "string", + "description": "Link to invoke action", "format": "uri", - "description": "Link to invoke action" + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" } }, - "description": "This action is used to prepare the contents of the volume for use by the system.", - "longDescription": "This defines the name of the custom action supported on this resource." + "type": "object" }, "EncryptionTypes": { - "type": "string", "enum": [ "NativeDriveEncryption", "ControllerAssisted", "SoftwareAssisted" ], "enumDescriptions": { - "NativeDriveEncryption": "The volume is utilizing the native drive encryption capabilities of the drive hardware.", "ControllerAssisted": "The volume is being encrypted by the storage controller entity.", + "NativeDriveEncryption": "The volume is utilizing the native drive encryption capabilities of the drive hardware.", "SoftwareAssisted": "The volume is being encrypted by software running on the system or the operating system." - } + }, + "type": "string" }, - "Operations": { - "type": "object", + "Initialize": { + "additionalProperties": false, + "description": "This action is used to prepare the contents of the volume for use by the system. If InitializeType is not specified in the request body, the InitializeType should be Fast.", + "longDescription": "This defines the name of the custom action supported on this resource. If InitializeType is not specified in the request body, the InitializeType should be Fast.", + "parameters": { + "InitializeType": { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/InitializeType", + "description": "The type of initialization to be performed.", + "longDescription": "This defines the property name for the action." + } + }, "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[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", "boolean", + "integer", "number", "null", "object", "string" + ] + } + }, + "properties": { + "target": { + "description": "Link to invoke action", + "format": "uri", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object" + }, + "InitializeType": { + "enum": [ + "Fast", + "Slow" + ], + "enumDescriptions": { + "Fast": "The volume is prepared for use quickly, typically by erasing just the beginning and end of the space so that partitioning can be performed.", + "Slow": "The volume is prepared for use slowly, typically by completely erasing the volume." + }, + "type": "string" + }, + "Links": { + "additionalProperties": false, + "description": "Add ability to manage spare capacity.", + "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": { + "ClassOfService": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ClassOfService.json#/definitions/ClassOfService" + }, + { + "type": "null" + } ], - "description": "This property shall specify a valid odata or Redfish property." + "description": "The ClassOfService that this storage volume conforms to.", + "longDescription": "This property shall contain a reference to the ClassOfService that this storage volume conforms to.", + "readonly": true + }, + "DedicatedSpareDrives": { + "description": "An array of references to the drives which are dedicated spares for this volume.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" + }, + "longDescription": "The value of this property shall be a reference to the resources that this volume is associated with and shall reference resources of type Drive. This property shall only contain references to Drive entities which are currently assigned as a dedicated spare and are able to support this Volume.", + "readonly": true, + "type": "array" + }, + "DedicatedSpareDrives@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + }, + "Drives": { + "description": "An array of references to the drives which contain this volume. This will reference Drives that either wholly or only partly contain this volume.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" + }, + "longDescription": "The value of this property shall be a reference to the resources that this volume is associated with and shall reference resources of type Drive. This property shall only contain references to Drive entities which are currently members of the Volume, not hot spare Drives which are not currently a member of the volume.", + "readonly": true, + "type": "array" + }, + "Drives@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + }, + "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." + }, + "SpareResourceSets": { + "description": "An array of references to SpareResourceSets.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/SpareResourceSet.json#/definitions/SpareResourceSet" + }, + "longDescription": "Each referenced SpareResourceSet shall contain resources that may be utilized to replace the capacity provided by a failed resource having a compatible type.", + "readonly": false, + "type": "array" + }, + "SpareResourceSets@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" } }, + "type": "object" + }, + "OemActions": { "additionalProperties": true, + "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": {}, + "type": "object" + }, + "Operation": { + "additionalProperties": false, + "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": { + "AssociatedTask": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Task.json#/definitions/Task", + "description": "A reference to the task associated with the operation if any.", + "readonly": true + }, "OperationName": { + "description": "The name of the operation.", + "readonly": true, "type": [ "string", "null" - ], - "readonly": true, - "description": "The name of the operation." + ] }, "PercentageComplete": { + "description": "The percentage of the operation that has been completed.", + "readonly": true, "type": [ - "number", + "integer", "null" - ], - "readonly": true, - "description": "The percentage of the operation that has been completed." - }, - "AssociatedTask": { - "$ref": "http://redfish.dmtf.org/schemas/v1/Task.json#/definitions/Task", - "readonly": true, - "description": "A reference to the task associated with the operation if any." + ] } }, - "description": "An operation currently running on this resource.", - "longDescription": "This type shall describe a currently running operation on the resource." + "type": "object" }, - "VolumeType": { - "type": "string", + "RAIDType": { "enum": [ - "RawDevice", - "NonRedundant", - "Mirrored", - "StripedWithParity", - "SpannedMirrors", - "SpannedStripesWithParity" + "RAID0", + "RAID1", + "RAID3", + "RAID4", + "RAID5", + "RAID6", + "RAID10", + "RAID01", + "RAID6TP", + "RAID1E", + "RAID50", + "RAID60", + "RAID00", + "RAID10E", + "RAID1Triple", + "RAID10Triple" ], "enumDescriptions": { - "RawDevice": "The volume is a raw physical device without any RAID or other virtualization applied.", - "NonRedundant": "The volume is a non-redundant storage device.", - "Mirrored": "The volume is a mirrored device.", - "StripedWithParity": "The volume is a device which uses parity to retain redundant information.", - "SpannedMirrors": "The volume is a spanned set of mirrored devices.", - "SpannedStripesWithParity": "The volume is a spanned set of devices which uses parity to retain redundant information." - } + "RAID0": "A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy.", + "RAID00": "A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.", + "RAID01": "A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0).", + "RAID1": "A placement policy where each logical block of data is stored on more than one independent storage device.", + "RAID10": "A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1).", + "RAID10E": "A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.", + "RAID10Triple": "A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple).", + "RAID1E": "A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices.", + "RAID1Triple": "A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices.", + "RAID3": "A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.", + "RAID4": "A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.", + "RAID5": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and one logical block of parity across a set of 'n+1' independent storage devices where the parity and data blocks are interleaved across the storage devices.", + "RAID50": "A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices.", + "RAID6": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and two logical blocks of independent parity across a set of 'n+2' independent storage devices where the parity and data blocks are interleaved across the storage devices.", + "RAID60": "A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices.", + "RAID6TP": "A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of data and three logical blocks of independent parity across a set of 'n+3' independent storage devices where the parity and data blocks are interleaved across the storage devices. This is commonly referred to as Triple Parity RAID. Data stored using this form of RAID is able to survive any three independent storage device failures without data loss." + }, + "enumLongDescriptions": { + "RAID0": "A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy. This is commonly referred to as data striping. This form of RAID will encounter data loss with the failure of any storage device in the set.", + "RAID00": "A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets. This is commonly referred to as RAID 0+0. This form of data layout is not fault tolerant; if any storage device fails there will be data loss.", + "RAID01": "A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0). This is commonly referred to as RAID 0+1 or RAID 0/1. Data stored using this form of RAID is able to survive a single RAID 0 data set failure without data loss.", + "RAID1": "A placement policy where each logical block of data is stored on more than one independent storage device. This is commonly referred to as mirroring. Data stored using this form of RAID is able to survive a single storage device failure without data loss.", + "RAID10": "A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1). This is commonly referred to as RAID 1/0. Data stored using this form of RAID is able to survive storage device failures in each RAID 1 set without data loss.", + "RAID10E": "A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets. This is commonly referred to as Enhanced RAID 10. Data stored using this form of RAID is able to survive a single device failure within each nested RAID 1 set without data loss.", + "RAID10Triple": "A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple). This form of RAID can survive up to two failures in each triple mirror set without data loss. ", + "RAID1E": "A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices. This is commonly referred to as RAID 1 Enhanced. Data stored using this form of RAID is able to survive a single storage device failure without data loss.", + "RAID1Triple": "A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices. This is commonly referred to as three-way mirroring. This form of RAID can survive two device failures without data loss.", + "RAID3": "A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device. Data stored using this form of RAID is able to survive a single storage device failure without data loss. If the storage devices use rotating media, they are assumed to be rotationally synchronized, and the data stripe size should be no larger than the exported block size.", + "RAID4": "A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device. Data stored using this form of RAID is able to survive a single storage device failure without data loss.", + "RAID5": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and one logical block of parity across a set of 'n+1' independent storage devices where the parity and data blocks are interleaved across the storage devices. Data stored using this form of RAID is able to survive a single storage device failure without data loss.", + "RAID50": "A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices. Data stored using this form of RAID is able to survive a single storage device failure within each RAID 5 set without data loss.", + "RAID6": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and two logical blocks of independent parity across a set of 'n+2' independent storage devices where the parity and data blocks are interleaved across the storage devices. Data stored using this form of RAID is able to survive any two independent storage device failures without data loss.", + "RAID60": "A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices. Data stored using this form of RAID is able to survive two device failures within each RAID 6 set without data loss." + }, + "type": "string" }, "Volume": { - "type": "object", + "additionalProperties": false, + "description": "Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.", + "longDescription": "This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[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", "boolean", + "integer", "number", "null", "object", "string" - ], - "description": "This property shall specify a valid odata or Redfish property." + ] } }, - "additionalProperties": false, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/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.4.0.0.json#/definitions/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.4.0.0.json#/definitions/type" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type" }, - "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*." + "AccessCapabilities": { + "description": "Supported IO access capabilities.", + "items": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/StorageAccessCapability" + }, + { + "type": "null" + } + ] + }, + "longDescription": "Each entry shall specify a current storage access capability.", + "readonly": false, + "type": "array" }, - "Id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", - "readonly": true + "Actions": { + "$ref": "#/definitions/Actions", + "description": "The available actions for this resource.", + "longDescription": "The Actions property shall contain the available actions for this resource." }, - "Description": { + "AllocatedPools": { "anyOf": [ - {"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"}, - {"type": "null"} + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StoragePoolCollection.json#/definitions/StoragePoolCollection" + }, + { + "type": "null" + } ], + "description": "An array of references to StoragePools allocated from this Volume.", + "longDescription": "The value of this property shall contain references to all storage pools allocated from this volume.", "readonly": true }, - "Name": { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", - "readonly": true + "BlockSizeBytes": { + "description": "The size of the smallest addressable unit (Block) of this volume in bytes.", + "longDescription": "This property shall contain size of the smallest addressable unit of the associated volume.", + "readonly": true, + "type": [ + "integer", + "null" + ], + "units": "By" }, - "Status": { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status" + "Capacity": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/Capacity" + }, + { + "type": "null" + } + ], + "description": "Capacity utilization.", + "longDescription": "Information about the utilization of capacity allocated to this storage volume.", + "readonly": false }, "CapacityBytes": { + "description": "The size in bytes of this Volume.", + "longDescription": "This property shall contain the size in bytes of the associated volume.", + "readonly": true, "type": [ - "number", + "integer", "null" ], - "units": "By", - "readonly": true, - "description": "The size in bytes of this Volume.", - "longDescription": "This property shall contain the size in bytes of the associated volume." + "units": "By" }, - "VolumeType": { + "CapacitySources": { + "description": "An array of space allocations to this volume.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/CapacitySource" + }, + "longDescription": "Fully or partially consumed storage from a source resource. Each entry provides capacity allocation information from a named source resource.", + "readonly": false, + "type": "array" + }, + "CapacitySources@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + }, + "Description": { "anyOf": [ - {"$ref": "#/definitions/VolumeType"}, - {"type": "null"} + { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" + }, + { + "type": "null" + } ], - "readonly": true, - "description": "The type of this volume.", - "longDescription": "This property shall contain the type of the associated Volume." + "readonly": true }, "Encrypted": { + "description": "Is this Volume encrypted.", + "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing encryption or not.", + "readonly": false, "type": [ "boolean", "null" - ], - "readonly": false, - "description": "Is this Volume encrypted.", - "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing encryption or not." + ] }, "EncryptionTypes": { - "type": "array", + "description": "The types of encryption used by this Volume.", "items": { "$ref": "#/definitions/EncryptionTypes" }, + "longDescription": "This property shall contain the types of encryption used by this Volume.", "readonly": false, - "description": "The types of encryption used by this Volume.", - "longDescription": "This property shall contain the types of encryption used by this Volume." + "type": "array" + }, + "IOStatistics": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/IOStatistics.json#/definitions/IOStatistics" + }, + { + "type": "null" + } + ], + "description": "Statistics for this volume.", + "longDescription": "The value shall represent IO statistics for this volume." + }, + "Id": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", + "readonly": true }, "Identifiers": { - "type": "array", + "description": "The Durable names for the volume.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.v1_1_0.json#/definitions/Identifier" + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" }, - "description": "The Durable names for the volume.", - "longDescription": "This property shall contain a list of all known durable names for the associated volume." + "longDescription": "This property shall contain a list of all known durable names for the associated volume.", + "type": "array" }, - "BlockSizeBytes": { + "Links": { + "$ref": "#/definitions/Links", + "description": "Contains references to other resources that are related to this resource.", + "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + }, + "LowSpaceWarningThresholdPercents": { + "description": "Low space warning.", + "items": { + "type": [ + "integer", + "null" + ] + }, + "longDescription": "Each time the following value is less than one of the values in the array the LOW_SPACE_THRESHOLD_WARNING event shall be triggered: Across all CapacitySources entries, percent = (SUM(AllocatedBytes) - SUM(ConsumedBytes))/SUM(AllocatedBytes).", + "readonly": false, + "type": "array", + "units": "%" + }, + "Manufacturer": { + "description": "The manufacturer or OEM of this storage volume.", + "longDescription": "This property shall contain a value that represents the manufacturer or implementer of the storage volume.", + "readonly": true, "type": [ - "number", + "string", + "null" + ] + }, + "MaxBlockSizeBytes": { + "description": "Max Block size in bytes.", + "longDescription": "This property shall contain size of the largest addressable unit of this storage volume.", + "readonly": true, + "type": [ + "integer", "null" ], - "units": "By", + "units": "By" + }, + "Model": { + "description": "The model number for this storage volume.", + "longDescription": "The value is assigned by the manufacturer and shall represents a specific storage volume implementation.", "readonly": true, - "description": "The size of the smallest addressible unit (Block) of this volume in bytes.", - "longDescription": "This property shall contain size of the smallest addressible unit of the associated volume." + "type": [ + "string", + "null" + ] + }, + "Name": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", + "readonly": true + }, + "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*." }, "Operations": { - "type": "array", + "description": "The operations currently running on the Volume.", "items": { - "$ref": "#/definitions/Operations" + "$ref": "#/definitions/Operation" }, - "description": "The operations currently running on the Volume.", - "longDescription": "This property shall contain a list of all currently running on the Volume." + "longDescription": "This property shall contain a list of all currently running on the Volume.", + "type": "array" }, "OptimumIOSizeBytes": { + "description": "The size in bytes of this Volume's optimum IO size.", + "longDescription": "This property shall contain the optimum IO size to use when performing IO on this volume. For logical disks, this is the stripe size. For physical disks, this describes the physical sector size.", + "readonly": true, "type": [ - "number", + "integer", "null" ], - "units": "By", - "readonly": true, - "description": "The size in bytes of this Volume's optimum IO size.", - "longDescription": "This property shall contain the optimum IO size to use when performing IO on this volume. For logical disks, this is the stripe size. For physical disks, this describes the physical sector size." + "units": "By" }, - "Links": { - "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": { - "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." - }, - "Drives@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/count" + "RAIDType": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/RAIDType" }, - "Drives@odata.navigationLink": { - "type": "string", - "format": "uri" + { + "type": "null" + } + ], + "description": "The RAID type of this volume.", + "longDescription": "This property shall contain the RAID type of the associated Volume.", + "readonly": true + }, + "RecoverableCapacitySourceCount": { + "description": "Current number of capacity source resources that are available as replacements.", + "longDescription": "The value is the number of available capacity source resources currently available in the event that an equivalent capacity source resource fails.", + "readonly": false, + "type": [ + "integer", + "null" + ] + }, + "RemainingCapacityPercent": { + "description": "The percentage of the capacity remaining in the StoragePool.", + "longDescription": "If present, this value shall return {[(SUM(AllocatedBytes) - SUM(ConsumedBytes)]/SUM(AllocatedBytes)}*100 represented as an integer value.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "ReplicaInfo": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaInfo" }, - "Drives": { - "type": "array", - "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" - }, - "readonly": true, - "description": "An array of references to the drives which contain this volume. This will reference Drives that either wholly or only partly contain this volume.", - "longDescription": "The value of this property shall be a reference to the resources that this volume is associated with and shall reference resources of type Drive. This property shall only contain references to Drive entities which are currently members of the Volume, not hot spare Drives which are not currently a member of the volume." + { + "type": "null" } + ], + "description": "Describes this storage volume in its role as a target replica.", + "longDescription": "This property shall describe the replica relationship between this storage volume and a corresponding source volume.", + "readonly": true + }, + "ReplicaTargets": { + "description": "The resources that are target replicas of this source.", + "items": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef" }, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "longDescription": "The value shall reference the target replicas that are sourced by this replica.", + "readonly": true, + "type": "array" }, - "Actions": { - "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." + "ReplicaTargets@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + }, + "Status": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status" + }, + "StorageGroups": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageGroupCollection.json#/definitions/StorageGroupCollection" + }, + { + "type": "null" } - }, - "additionalProperties": false, - "properties": { - "Oem": { - "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": true, - "properties": {}, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource." + ], + "description": "An array of references to Storage Groups that includes this volume.", + "longDescription": "The value of this property shall contain references to all storage groups that include this volume.", + "readonly": true + }, + "VolumeType": { + "anyOf": [ + { + "$ref": "#/definitions/VolumeType" }, - "#Volume.Initialize": { - "$ref": "#/definitions/Initialize" + { + "type": "null" } - }, - "description": "The available actions for this resource.", - "longDescription": "The Actions property shall contain the available actions for this resource." + ], + "deprecated": "Deprecated in favor of explicit use of RAIDType.", + "description": "The type of this volume.", + "longDescription": "This property shall contain the type of the associated Volume.", + "readonly": true } }, "required": [ + "@odata.id", + "@odata.type", "Id", "Name" ], - "description": "Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.", - "longDescription": "This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation." + "type": "object" + }, + "VolumeType": { + "enum": [ + "RawDevice", + "NonRedundant", + "Mirrored", + "StripedWithParity", + "SpannedMirrors", + "SpannedStripesWithParity" + ], + "enumDescriptions": { + "Mirrored": "The volume is a mirrored device.", + "NonRedundant": "The volume is a non-redundant storage device.", + "RawDevice": "The volume is a raw physical device without any RAID or other virtualization applied.", + "SpannedMirrors": "The volume is a spanned set of mirrored devices.", + "SpannedStripesWithParity": "The volume is a spanned set of devices which uses parity to retain redundant information.", + "StripedWithParity": "The volume is a device which uses parity to retain redundant information." + }, + "type": "string" } }, - "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright" -} + "owningEntity": "SNIA", + "title": "#Volume.v1_3_1.Volume" +}
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/Zone/Zone.json b/static/redfish/v1/JsonSchemas/Zone/Zone.json index 5d419d2ebe..5fecadde29 100644 --- a/static/redfish/v1/JsonSchemas/Zone/Zone.json +++ b/static/redfish/v1/JsonSchemas/Zone/Zone.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Zone.v1_3_1.json", "$ref": "#/definitions/Zone", "$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,18 +25,37 @@ "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" }, + "ExternalAccessibility": { + "enum": [ + "GloballyAccessible", + "NonZonedAccessible", + "ZoneOnly" + ], + "enumDescriptions": { + "GloballyAccessible": "Any external entity with the correct access details, which may include authorization information, can access the endpoints that this zone lists.", + "NonZonedAccessible": "Any external entity that another zone does not explicitly list can access the endpoints that this zone lists.", + "ZoneOnly": "Only accessible by endpoints that this zone explicitly lists." + }, + "enumLongDescriptions": { + "GloballyAccessible": "This value shall indicate that any external entity with the correct access details, which may include authorization information, can access the endpoints that this zone lists, regardless of zone.", + "NonZonedAccessible": "This value shall indicate that any external entity that another zone does not explicitly list can access the endpoints that this zone lists.", + "ZoneOnly": "This value shall indicate that endpoints in this zone are only accessible by endpoints that this zone explicitly lists." + }, + "type": "string" + }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are not contained in or subordinate to 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,55 +70,56 @@ }, "properties": { "Endpoints": { - "description": "Represents an array of references to the endpoints that are contained in this zone.", + "description": "The links to the endpoints that this zone contains.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, - "longDescription": "The value of this property shall be a reference to the resources that this zone is associated with and shall reference a resource of type Endpoint.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type that this zone contains.", "readonly": true, "type": "array" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "InvolvedSwitches": { - "description": "Represents an array of references to the switches in this zone.", + "description": "The links to the collection of switches in this zone.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Switch.json#/definitions/Switch" }, - "longDescription": "The value of this property shall be a reference to the resources that this zone is associated with and shall reference a resource of type Switch.", + "longDescription": "This property shall contain the links to the Resource Collection of type Switch in this zone.", "readonly": true, "type": "array" }, "InvolvedSwitches@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "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." }, "ResourceBlocks": { - "description": "An array of references to the Resource Blocks that are used in this Zone.", + "description": "The links to the Resource Blocks with which this zone is associated.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock" }, - "longDescription": "The value of this property shall be an array of references of type ResourceBlock that are associated with this Zone.", + "longDescription": "This property shall contain an array of links to Resources of the ResourceBlock type with which this zone is associated.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "ResourceBlocks@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" } }, "type": "object" }, "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", @@ -116,10 +137,10 @@ }, "Zone": { "additionalProperties": false, - "description": "The Zone schema represents a fabric zone.", - "longDescription": "This resource shall be used to represent a simple zone for a Redfish implementation.", + "description": "The Zone schema describes a simple fabric zone for a Redfish implementation.", + "longDescription": "This Resource shall represent a simple fabric zone 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", @@ -134,21 +155,22 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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": [ @@ -161,12 +183,26 @@ ], "readonly": true }, + "ExternalAccessibility": { + "anyOf": [ + { + "$ref": "#/definitions/ExternalAccessibility" + }, + { + "type": "null" + } + ], + "description": "Indicates accessiblity of endpoints in this zone to endpoints outside of this zone.", + "longDescription": "This property shall contain and indication of accessiblity of endpoints in this zone to endpoints outside of this zone.", + "readonly": false, + "versionAdded": "v1_3_0" + }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "Identifiers": { - "description": "Identifiers for this zone.", + "description": "The identifiers for this zone.", "items": { "anyOf": [ { @@ -177,13 +213,14 @@ } ] }, - "longDescription": "Identifiers for this zone shall be unique in the context of other zones.", - "type": "array" + "longDescription": "This property shall contain a Resource Collection of identifiers for this zone, which shall be unique in the context of other zones.", + "type": "array", + "versionAdded": "v1_2_0" }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to Resources related to but not subordinate to this Resource.", + "longDescription": "This Redfish Specification-described property shall contain links to Resources related to but not subordinate to this Resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -191,13 +228,13 @@ }, "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." }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain the status and health properties of the Resource and its children." } }, "required": [ @@ -210,5 +247,6 @@ } }, "owningEntity": "DMTF", - "title": "#Zone.v1_2_1.Zone" + "release": "2019.1", + "title": "#Zone.v1_3_1.Zone" }
\ No newline at end of file diff --git a/static/redfish/v1/JsonSchemas/odata/odata.json b/static/redfish/v1/JsonSchemas/odata/odata.json index a1701345cf..102441c242 100644 --- a/static/redfish/v1/JsonSchemas/odata/odata.json +++ b/static/redfish/v1/JsonSchemas/odata/odata.json @@ -1,16 +1,17 @@ { - "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_4_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/odata-v4_0_4.json", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "definitions": { "context": { "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true, "description": "The OData description of a payload.", "longDescription": "The value of this property shall be the context URL that describes the resource according to OData-Protocol and shall be of the form defined in the Redfish specification." }, "id": { "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true, "description": "The unique identifier for a resource.", "longDescription": "The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification." @@ -46,7 +47,7 @@ }, "nextLink": { "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true, "description": "The URI to the resource containing the next set of partial members.", "longDescription": "The value of this property shall be a URI to a resource, with the same @odata.type, containing the next set of partial members." diff --git a/static/redfish/v1/JsonSchemas/redfish-error/redfish-error.json b/static/redfish/v1/JsonSchemas/redfish-error/redfish-error.json index a4b699d060..97d4f72c5c 100644 --- a/static/redfish/v1/JsonSchemas/redfish-error/redfish-error.json +++ b/static/redfish/v1/JsonSchemas/redfish-error/redfish-error.json @@ -1,18 +1,18 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/redfish-error.v1_0_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/redfish-error.v1_0_1.json", "$ref": "#/definitions/RedfishError", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "RedfishError": { "additionalProperties": false, - "description": "Contains an error payload from a Redfish Service.", - "longDescription": "This type, as described by the Redfish Specification, shall contain an error payload from a Redfish Service.", + "description": "The error payload from a Redfish Service.", + "longDescription": "The Redfish Specification-described type shall contain an error payload from a Redfish Service.", "properties": { "error": { "$ref": "#/definitions/RedfishErrorContents", - "description": "Contains properties used to describe an error from a Redfish Service.", - "longDescription": "This property, as described by the Redfish Specification, shall contain properties used to describe an error from a Redfish Service." + "description": "The properties that describe an error from a Redfish Service.", + "longDescription": "This property, as described by the Redfish Specification, shall contain properties that describe an error from a Redfish Service." } }, "required": [ @@ -22,24 +22,24 @@ }, "RedfishErrorContents": { "additionalProperties": false, - "description": "Contains properties used to describe an error from a Redfish Service.", - "longDescription": "This type, as described by the Redfish Specification, shall contain properties used to describe an error from a Redfish Service.", + "description": "The properties that describe an error from a Redfish Service.", + "longDescription": "The Redfish Specification-described type shall contain properties that describe an error from a Redfish Service.", "properties": { "code": { - "description": "A string indicating a specific MessageId from the message registry.", - "longDescription": "This property shall be a string indicating a specific MessageId from the message registry.", + "description": "A string indicating a specific MessageId from a Message Registry.", + "longDescription": "This property shall contain a string indicating a specific MessageId from a Message Registry.", "readonly": true, "type": "string" }, "message": { - "description": "A human-readable error message corresponding to the message in the message registry.", - "longDescription": "This property shall be a human-readable error message corresponding to the message in the message registry.", + "description": "A human-readable error message corresponding to the message in a Message Registry.", + "longDescription": "This property shall contain a human-readable error message corresponding to the message in a Message Registry.", "readonly": true, "type": "string" }, "@Message.ExtendedInfo": { - "description": "An array of message objects describing one or more error message(s).", - "longDescription": "This property shall be an array of message objects describing one or more error message(s).", + "description": "An array of messages describing one or more error messages.", + "longDescription": "This property shall be an array of message objects describing one or more error messages.", "type": "array", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message" diff --git a/static/redfish/v1/JsonSchemas/redfish-payload-annotations/redfish-payload-annotations.json b/static/redfish/v1/JsonSchemas/redfish-payload-annotations/redfish-payload-annotations.json index 0bfdb13840..84cab6d37a 100644 --- a/static/redfish/v1/JsonSchemas/redfish-payload-annotations/redfish-payload-annotations.json +++ b/static/redfish/v1/JsonSchemas/redfish-payload-annotations/redfish-payload-annotations.json @@ -1,47 +1,48 @@ { - "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_4_1.json", - "copyright": "Copyright 2014-2018 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "$id": "http://redfish.dmtf.org/schemas/v1/redfish-payload-annotations.v1_0_1.json", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", + "copyright": "Copyright 2014-2019 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "properties": { "@Redfish.ActionInfo": { - "description": "The term can be applied to an Action to specify a URI to an ActionInfo resource which describes the parameters supported by this instance of the Action.", + "description": "The term can be applied to an action to specify a URI to an ActionInfo Resource that describes the parameters supported by this instance of the action.", "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true }, "@Redfish.Settings": { - "description": "Reference to the resource that represents the settings to be applied to this object.", + "description": "The link to the Settings Resource that represents the settings to apply to this Resource.", "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/Settings" }, "@Redfish.SettingsApplyTime": { - "description": "Configuration settings for when the values in the settings object are applied to a given resource.", + "description": "The configuration settings for when the values in the settings object are applied to a Resource.", "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/PreferredApplyTime" }, "@Redfish.OperationApplyTime": { - "description": "The requested apply time from a client when performing a Create, Delete, or Action operation.", + "description": "The requested apply time from a client when performing a create, delete, or action operation.", "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTime" }, "@Redfish.OperationApplyTimeSupport": { - "description": "Indicates if a client is allowed to request for a specific apply time of a Create, Delete, or Action operation of a given resource via the OperationApplyTime term.", + "description": "An indication of whether a client can request an apply time for a create, delete, or action operation of a Resource through the OperationApplyTime term.", "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTimeSupport" }, "@Redfish.MaintenanceWindow": { - "description": "Maintenance window configuration of a resource for when to apply settings or operations.", + "description": "The maintenance window configuration for a Resource for when to apply settings or operations.", "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/MaintenanceWindow" }, "@Redfish.CollectionCapabilities": { - "description": "Reference to the resource that represents the POST capabilities of a given collection.", + "description": "The link to the Resource that represents the POST capabilities of a collection.", "$ref": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.json#/definitions/CollectionCapabilities" }, "@odata.context": { "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true, "description": "The OData description of a payload.", "longDescription": "The value of this property shall be the context URL that describes the resource according to OData-Protocol and shall be of the form defined in the Redfish specification." }, "@odata.id": { "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true, "description": "The unique identifier for a resource.", "longDescription": "The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification." @@ -61,7 +62,7 @@ }, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.AllowableValues$": { - "description": "The set of allowable values for a parameter or property.", + "description": "The set of allowable values for a parameter.", "type": "array", "items": { "type": "string" @@ -69,22 +70,22 @@ "readonly": true }, "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.RequiredOnCreate$": { - "description": "The term specifies that a property is required to be specified in the body of a POST request to create the resource.", + "description": "The term specifies that a property is required to be specified in the body of a POST request to create the Resource.", "type": "boolean", "readonly": true }, "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.SetOnlyOnCreate$": { - "description": "The term specifies that a property can only be set when a client is creating a new instance of a resource via POST.", + "description": "The term specifies that a property can only be set when a client creates an instance of a Resource through POST.", "type": "boolean", "readonly": true }, "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.OptionalOnCreate$": { - "description": "The term specifies that a property may be set when a client is creating a new instance of a resource via POST.", + "description": "The term specifies that a property may be set when a client creates an instance of a Resource through POST.", "type": "boolean", "readonly": true }, "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.UpdatableAfterCreate$": { - "description": "The term specifies that a property may be set by a client using PATCH after creating a new instance of a resource via POST.", + "description": "The term specifies that a property may be set by a client that uses PATCH after it creates an instance of a Resource through POST.", "type": "boolean", "readonly": true }, @@ -103,7 +104,7 @@ }, "^([a-zA-Z_][a-zA-Z0-9_]*)?@odata.nextLink$": { "type": "string", - "format": "uri", + "format": "uri-reference", "readonly": true, "description": "The URI to the resource containing the next set of partial members.", "longDescription": "The value of this property shall be a URI to a resource, with the same @odata.type, containing the next set of partial members." diff --git a/static/redfish/v1/JsonSchemas/redfish-schema/redfish-schema.json b/static/redfish/v1/JsonSchemas/redfish-schema/redfish-schema.json index ba60b81524..ab3c143f2e 100644 --- a/static/redfish/v1/JsonSchemas/redfish-schema/redfish-schema.json +++ b/static/redfish/v1/JsonSchemas/redfish-schema/redfish-schema.json @@ -1,5 +1,5 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_6_0", + "$id": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_7_0", "type": "object", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Redfish Schema Extension", @@ -111,6 +111,18 @@ "type": "string", "description": "Indicates a filter to apply to an array of objects when the values are copies of data elsewhere in the data model." }, + "language": { + "type": "string", + "description": "The term specifies the ISO 639-1 language code (Alpha-2) that matches the language used for the descriptive text in this schema file. If this term is not present, the default value shall be English (en)." + }, + "translation": { + "type": "string", + "description": "The term specifies a translated language (localized) version of the property name, parameter, or enumeration string. The language used shall match the 'language' value for this schema." + }, + "enumTranslations": { + "type": "object", + "description": "The term specifies a translated language (localized) version of enumeration values. The object shall contain properties with names that match the enumerations and values that contain the translation of the enumeration value. The language used shall match the 'language' value for this schema." + }, "actionResponse": { "type": "object", "description": "Contains the definition of the response body for a given action if it does not follow the Redfish Error format." @@ -201,6 +213,15 @@ "filter": { "$ref": "#/definitions/filter" }, + "language": { + "$ref": "#/definitions/language" + }, + "translation": { + "$ref": "#/definitions/translation" + }, + "enumTranslations": { + "$ref": "#/definitions/enumTranslations" + }, "actionResponse": { "$ref": "#/definitions/actionResponse" }, |