From 1a4eb8630752cd92d12d50f34d84e9418ece2caa Mon Sep 17 00:00:00 2001 From: Kyrylo Romanenko Date: Wed, 14 Sep 2016 15:11:20 +0300 Subject: [PATCH] Fix docstrings in Tempest Plugin REST client for Ironic API Fix misprints in docstrings. Change-Id: I68a6f98a626acccb404fb3088e7533e8340473da --- .../services/baremetal/v1/json/baremetal_client.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/ironic_tempest_plugin/services/baremetal/v1/json/baremetal_client.py b/ironic_tempest_plugin/services/baremetal/v1/json/baremetal_client.py index 1863fc2509..c3661bc499 100644 --- a/ironic_tempest_plugin/services/baremetal/v1/json/baremetal_client.py +++ b/ironic_tempest_plugin/services/baremetal/v1/json/baremetal_client.py @@ -72,7 +72,7 @@ class BaremetalClient(base.BaremetalClient): def show_node_by_instance_uuid(self, instance_uuid): """Gets a node associated with given instance uuid. - :param uuid: Unique identifier of the node in UUID format. + :param instance_uuid: Unique identifier of the instance in UUID format. :return: Serialized node as a dictionary. """ @@ -126,6 +126,7 @@ class BaremetalClient(base.BaremetalClient): def create_node(self, chassis_id=None, **kwargs): """Create a baremetal node with the specified parameters. + :param chassis_id: The unique identifier of the chassis. :param cpu_arch: CPU architecture of the node. Default: x86_64. :param cpus: Number of CPUs. Default: 8. :param local_gb: Disk size. Default: 1024. @@ -257,7 +258,7 @@ class BaremetalClient(base.BaremetalClient): """Set power state of the specified node. :param node_uuid: The unique identifier of the node. - :state: desired state to set (on/off/reboot). + :param state: desired state to set (on/off/reboot). """ target = {'target': state} @@ -269,7 +270,7 @@ class BaremetalClient(base.BaremetalClient): """Set provision state of the specified node. :param node_uuid: The unique identifier of the node. - :state: desired state to set + :param state: desired state to set (active/rebuild/deleted/inspect/manage/provide). :config_drive: A gzipped, base64-encoded configuration drive string. """ @@ -291,7 +292,7 @@ class BaremetalClient(base.BaremetalClient): def validate_driver_interface(self, node_uuid): """Get all driver interfaces of a specific node. - :param uuid: Unique identifier of the node in UUID format. + :param node_uuid: Unique identifier of the node in UUID format. """