Move to 2020.1
Make changes to update_schemas.py needed for the move and run
update_schemas.py.
Need 1.3.6 or later version of Redfish-Service-Validator.
CI uses the master branch of Redfish-Service-Validator, which has
this fix.
Redfish-Service-Validators before 1.3.6 will incorrectly throw errors in
message registries like (Task Event Message Registry)
/redfish/v1/Registries/TaskEvent/TaskEvent and (Base Message Registry)
/redfish/v1/Registries/Base/Base.
For more information:
https://redfishforum.com/thread/323/validator-errors-when-moving-release
This does introduce some "warnDeprecated" due to "Severity" becoming
Deprecated in MessageRegistry v1_4_0. Since all bmcweb Registries are
<v1_4_0, not a real problem. Redfish has no Base Message Registry and
Task Event Message Registry available to move to something that
uses MessageRegistry v1_4_0. Will take up with Redfish.
2020.1 includes new features like AutoRebot (Boot -> AutomaticRetry),
factory reset (ResetToDefaults action), and Modified Event Log property
which are in OpenBMC's D-Bus interfaces today.
Tested: Built bmcweb, loaded on a Witherspoon, and ran
the validator. Validator passed.
See new schemas:
curl -k https://${bmc}/redfish/v1/JsonSchemas/SecureBootDatabase
{
"@odata.context": "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile",
"@odata.id": "/redfish/v1/JsonSchemas/SecureBootDatabase",
"@odata.type": "#JsonSchemaFile.v1_0_2.JsonSchemaFile",
"Name": "SecureBootDatabase Schema File",
Change-Id: If30fcc50276aea44d8a77ed547ee0cbd72e4cf1a
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
diff --git a/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json b/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json
index 7da70a4..372bb46 100644
--- a/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json
+++ b/static/redfish/v1/JsonSchemas/SecureBoot/SecureBoot.json
@@ -1,13 +1,13 @@
{
- "$id": "http://redfish.dmtf.org/schemas/v1/SecureBoot.v1_0_6.json",
+ "$id": "http://redfish.dmtf.org/schemas/v1/SecureBoot.v1_1_0.json",
"$ref": "#/definitions/SecureBoot",
"$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",
+ "copyright": "Copyright 2014-2020 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_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
@@ -28,16 +28,16 @@
},
"Oem": {
"$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."
+ "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 the available OEM-specific 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_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
@@ -57,13 +57,13 @@
},
"ResetKeys": {
"additionalProperties": false,
- "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.",
+ "description": "This action resets the UEFI Secure Boot keys.",
+ "longDescription": "This action shall reset the UEFI Secure Boot key databases. The `ResetAllKeysToDefault` value shall reset all UEFI Secure Boot key databases to their default values. The `DeleteAllKeys` value shall delete the content of all UEFI Secure Boot key databases. The `DeletePK` value shall delete the content of the PK Secure Boot key database.",
"parameters": {
"ResetKeysType": {
"$ref": "#/definitions/ResetKeysType",
- "description": "The type of keys to reset or delete.",
- "longDescription": "This parameter shall specify the type of keys to reset or delete.",
+ "description": "The type of reset or delete to perform on the UEFI Secure Boot databases.",
+ "longDescription": "This parameter shall specify the type of reset or delete to perform on the UEFI Secure Boot databases.",
"requiredParameter": true
}
},
@@ -101,16 +101,16 @@
"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.",
- "ResetAllKeysToDefault": "Reset the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX) to their default values."
+ "DeleteAllKeys": "Delete the contents of all UEFI Secure Boot key databases, including the PK key database. This puts the system in Setup Mode.",
+ "DeletePK": "Delete the contents of the PK UEFI Secure Boot database. This puts the system in Setup Mode.",
+ "ResetAllKeysToDefault": "Reset the contents of all UEFI Secure Boot key databases, including the PK key database, to the default values."
},
"type": "string"
},
"SecureBoot": {
"additionalProperties": false,
"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.",
+ "longDescription": "This resource contains UEFI Secure Boot information for a Redfish implementation.",
"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.",
@@ -140,8 +140,8 @@
},
"Actions": {
"$ref": "#/definitions/Actions",
- "description": "The available actions for this Resource.",
- "longDescription": "This 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": [
@@ -176,10 +176,17 @@
"type": "null"
}
],
- "description": "Secure Boot state during the current boot cycle.",
+ "description": "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
},
+ "SecureBootDatabases": {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/SecureBootDatabaseCollection.json#/definitions/SecureBootDatabaseCollection",
+ "description": "A link to the collection of UEFI Secure Boot databases.",
+ "longDescription": "The value of this property shall be a link to a resource collection of type SecureBootDatabaseCollection.",
+ "readonly": true,
+ "versionAdded": "v1_1_0"
+ },
"SecureBootEnable": {
"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.",
@@ -198,8 +205,8 @@
"type": "null"
}
],
- "description": "Current Secure Boot Mode.",
- "longDescription": "This property shall contain the current Secure Boot mode, as defined in the UEFI Specification.",
+ "description": "The current UEFI Secure Boot Mode.",
+ "longDescription": "This property shall contain the current UEFI Secure Boot mode, as defined in the UEFI Specification.",
"readonly": true
}
},
@@ -217,8 +224,8 @@
"Disabled"
],
"enumDescriptions": {
- "Disabled": "Secure Boot is currently disabled.",
- "Enabled": "Secure Boot is currently enabled."
+ "Disabled": "UEFI Secure Boot is currently disabled.",
+ "Enabled": "UEFI Secure Boot is currently enabled."
},
"type": "string"
},
@@ -230,15 +237,15 @@
"DeployedMode"
],
"enumDescriptions": {
- "AuditMode": "Secure Boot is currently in Audit Mode.",
- "DeployedMode": "Secure Boot is currently in Deployed Mode.",
- "SetupMode": "Secure Boot is currently in Setup Mode.",
- "UserMode": "Secure Boot is currently in User Mode."
+ "AuditMode": "UEFI Secure Boot is currently in Audit Mode.",
+ "DeployedMode": "UEFI Secure Boot is currently in Deployed Mode.",
+ "SetupMode": "UEFI Secure Boot is currently in Setup Mode.",
+ "UserMode": "UEFI Secure Boot is currently in User Mode."
},
"type": "string"
}
},
"owningEntity": "DMTF",
- "release": "2016.1",
- "title": "#SecureBoot.v1_0_6.SecureBoot"
+ "release": "2020.1",
+ "title": "#SecureBoot.v1_1_0.SecureBoot"
}
\ No newline at end of file