Fix incorrect documentation for keyword args
Changes:
Fix incorrect documentation for keyword arguments
Tested:
NA
Change-Id: Icb12076b16331651e9079806d899502501509875
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>
diff --git a/redfish/systems/test_alternate_fan_settings.robot b/redfish/systems/test_alternate_fan_settings.robot
index 6157350..b88c330 100755
--- a/redfish/systems/test_alternate_fan_settings.robot
+++ b/redfish/systems/test_alternate_fan_settings.robot
@@ -123,6 +123,10 @@
[Documentation] Verify the thermal mode remains set at runtime.
[Arguments] ${pre_req_state} ${thermal_mode}
+ # Description of Arguments(s):
+ # pre_req_state Set the state of the host to Standby or Runtime (e.g. "Running")
+ # thermal_mode Read the supported thermal mode (e.g. "CUSTOM")
+
Set and Verify Thermal Mode Switches ${pre_req_state} ${thermal_mode}
Run Key U Redfish Power On \ stack_mode=normal \ quiet=1
diff --git a/redfish/systems/test_boot_devices.robot b/redfish/systems/test_boot_devices.robot
index 1ff3030..b0e34a4 100644
--- a/redfish/systems/test_boot_devices.robot
+++ b/redfish/systems/test_boot_devices.robot
@@ -314,12 +314,11 @@
[Arguments] ${override_target} ${override_mode}=UEFI ${is_bios_setup}=False
# Description of argument(s):
- # override_enabled Boot source override enable type.
- # ('Once', 'Continuous', 'Disabled').
# override_target Boot source override target.
# ('Pxe', 'Cd', 'Hdd', 'Diags', 'BiosSetup', 'None').
# override_mode Boot source override mode (relevant only for x86 arch).
# ('Legacy', 'UEFI').
+ # is_bios_setup Is BIOS setup required (True, False).
# Example:
# "Boot": {
@@ -379,12 +378,11 @@
[Arguments] ${override_target} ${override_mode}=UEFI ${is_bios_setup}=False
# Description of argument(s):
- # override_enabled Boot source override enable type.
- # ('Once', 'Continuous', 'Disabled').
# override_target Boot source override target.
# ('Pxe', 'Cd', 'Hdd', 'Diags', 'BiosSetup', 'None').
# override_mode Boot source override mode (relevant only for x86 arch).
# ('Legacy', 'UEFI').
+ # is_bios_setup Is BIOS setup required (True, False).
# Example:
# "Boot": {
diff --git a/redfish/systems/test_led_indicator_asserted.robot b/redfish/systems/test_led_indicator_asserted.robot
index e1ef718..c233170 100755
--- a/redfish/systems/test_led_indicator_asserted.robot
+++ b/redfish/systems/test_led_indicator_asserted.robot
@@ -246,6 +246,9 @@
[Documentation] Set And Verify LED Location Indicator State.
[Arguments] ${set_value}
+ # Description of argument(s):
+ # set_value Location indicator active value (True, False).
+
${payload}= Create Dictionary LocationIndicatorActive=${set_value}
Redfish.Patch /redfish/v1/Systems/${SYSTEM_ID} body=&{payload}
... valid_status_codes=[${HTTP_NO_CONTENT}]
@@ -259,6 +262,9 @@
[Documentation] setting back Initial value.
[Arguments] ${value}
+ # Description of argument(s):
+ # value Location indicator active value (True, False).
+
${payload}= Create Dictionary LocationIndicatorActive=${value}
Redfish.Patch /redfish/v1/Systems/${SYSTEM_ID} body=&{payload}
... valid_status_codes=[${HTTP_NO_CONTENT}]
diff --git a/redfish/update_service/test_redfish_host_code_update.robot b/redfish/update_service/test_redfish_host_code_update.robot
index 6a1052c..d8246cb 100644
--- a/redfish/update_service/test_redfish_host_code_update.robot
+++ b/redfish/update_service/test_redfish_host_code_update.robot
@@ -76,7 +76,7 @@
[Arguments] ${apply_time}
# Description of argument(s):
- # policy ApplyTime allowed values (e.g. "OnReset", "Immediate").
+ # apply_time ApplyTime allowed values (e.g. "OnReset", "Immediate").
Redfish.Login
${post_code_update_actions}= Get Post Boot Action
@@ -97,8 +97,8 @@
Set ApplyTime policy="Immediate"
- # URI : /redfish/v1/UpdateService
- # "HttpPushUri": "/redfish/v1/UpdateService/update",
+ # URI : /redfish/v1/UpdateService
+ # "HttpPushUri": "/redfish/v1/UpdateService/update",
${redfish_update_uri}= Get Redfish Update Service URI
Redfish Upload Image ${redfish_update_uri} ${IMAGE_FILE_PATH}
diff --git a/security/test_slp.robot b/security/test_slp.robot
index 2436276..f39d1da 100644
--- a/security/test_slp.robot
+++ b/security/test_slp.robot
@@ -23,6 +23,7 @@
Verify SLP Service Types
[Documentation] Find services supported by system.
[Tags] Verify_SLP_Service_Types
+
Verify Service Types
Verify Service Agents For Service Types
@@ -40,6 +41,7 @@
Suite Setup Execution
[Documentation] Get SLP services.
+
${output}= Run which slptool
Should Not Be Empty ${output}
... msg=slptool not installed.
@@ -78,8 +80,12 @@
Verify Service Agents
[Documentation] Verifies the output of srvs.
[Arguments] ${output} ${service_agent}
- # Example of output
- # <service:service_name:tcp//xxx.xxx.xxx.xxx,2200>
+
+ # Description of argument(s):
+ # output SLP service output.
+ # Example of output
+ # <service:service_name:tcp//xxx.xxx.xxx.xxx,2200>
+ # service_agent Service agent ('findsrvs').
Run Keywords Should Contain ${output} ${service_agent} AND
... Should Contain ${output} ${OPENBMC_HOST},