openstack/tempest
Code Issues Proposed changes

Add available params in baremetal client's comment

Browse Source 
Some interfaces in baremetal client have **kwargs parameter, but no
api reference links are given. so this is to add "Available params" in
their comments.

Change-Id: I593d6f5917a30e8973c4ec553be76bc3e0a9c366
This commit is contained in:
Lv Fumei 2016-07-08 14:36:25 +08:00
parent d519cb7195
commit 2edbc3c4b7
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
tempest/services/baremetal/v1/json/baremetal_client.py Normal file → Executable file
View File

@ -20,7 +20,11 @@ class BaremetalClient(base.BaremetalClient):
@base.handle_errors
def list_nodes(self, **kwargs):
"""List all existing nodes."""
"""List all existing nodes.
Available params: see http://developer.openstack.org/api-ref/
baremetal/index.html#list-nodes
"""
return self._list_request('nodes', **kwargs)
@base.handle_errors
@ -35,7 +39,11 @@ class BaremetalClient(base.BaremetalClient):
@base.handle_errors
def list_ports(self, **kwargs):
"""List all existing ports."""
"""List all existing ports.
Available params: see http://developer.openstack.org/api-ref/
baremetal/index.html?expanded=#list-ports
"""
return self._list_request('ports', **kwargs)
@base.handle_errors
@ -50,7 +58,11 @@ class BaremetalClient(base.BaremetalClient):
@base.handle_errors
def list_ports_detail(self, **kwargs):
"""Details list all existing ports."""
"""Details list all existing ports.
Available params: see http://developer.openstack.org/api-ref/baremetal/
index.html?expanded=#list-detailed-ports
"""
return self._list_request('/ports/detail', **kwargs)
@base.handle_errors