openstack
/
python-novaclient
Code Issues Proposed changes

Merge "Optimize limit option docs string description for novaclient"

This commit is contained in:
Zuul 2019-05-17 15:24:11 +00:00 committed by Gerrit Code Review
parent 8c3311eefe 2ecb39710f
commit dfb84228a2
8 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
novaclient/v2/flavors.py
View File

@ -116,6 +116,9 @@ class FlavorManager(base.ManagerWithFind):
:param min_disk: Filters the flavors by a minimum disk space, in GiB.
:param min_ram: Filters the flavors by a minimum RAM, in MiB.
:param limit: maximum number of flavors to return (optional).
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
:param sort_key: Flavors list sort key (optional).
:param sort_dir: Flavors list sort direction (optional).
:returns: list of :class:`Flavor`.

3
novaclient/v2/hypervisors.py
View File

@ -70,6 +70,9 @@ class HypervisorManager(base.ManagerWithFind):
marker must be a UUID hypervisor ID.
(optional).
:param limit: maximum number of hypervisors to return (optional).
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
"""
return self._list_base(detailed=detailed, marker=marker, limit=limit)

3
novaclient/v2/instance_action.py
View File

@ -53,6 +53,9 @@ class InstanceActionManager(base.ManagerWithFind):
list than that represented by this action request id
(optional).
:param limit: Maximum number of actions to return. (optional).
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
:param changes_since: List only instance actions changed later or
equal to a certain point of time. The provided
time should be an ISO 8061 formatted time.

3
novaclient/v2/keypairs.py
View File

@ -185,6 +185,9 @@ class KeypairManager(base.ManagerWithFind):
keypair list than that represented by this keypair name
(optional).
:param limit: maximum number of keypairs to return (optional).
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
"""
params = {}
if user_id:

6
novaclient/v2/migrations.py
View File

@ -70,6 +70,9 @@ class MigrationManager(base.ManagerWithFind):
migrations list than that represented by this migration UUID
(optional).
:param limit: maximum number of migrations to return (optional).
Note the API server has a configurable default limit. If no limit is
specified here or limit is larger than default, the default limit will
be used.
:param changes_since: only return migrations changed later or equal
to a certain point of time. The provided time should be an ISO 8061
formatted time. e.g. 2016-03-04T06:27:59Z . (optional).
@ -92,6 +95,9 @@ class MigrationManager(base.ManagerWithFind):
migrations list than that represented by this migration UUID
(optional).
:param limit: maximum number of migrations to return (optional).
Note the API server has a configurable default limit. If no limit is
specified here or limit is larger than default, the default limit will
be used.
:param changes_since: Only return migrations changed later or equal
to a certain point of time. The provided time should be an ISO 8061
formatted time. e.g. 2016-03-04T06:27:59Z . (optional).

3
novaclient/v2/server_groups.py
View File

@ -51,6 +51,9 @@ class ServerGroupsManager(base.ManagerWithFind):
:param all_projects: Lists server groups for all projects. (optional)
:param limit: Maximum number of server groups to return. (optional)
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
:param offset: Use with `limit` to return a slice of server
groups. `offset` is where to start in the groups
list. (optional)

4
novaclient/v2/servers.py
View File

@ -843,6 +843,10 @@ class ServerManager(base.BootingManagerWithFind):
:param marker: Begin returning servers that appear later in the server
list than that represented by this server id (optional).
:param limit: Maximum number of servers to return (optional).
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
If limit == -1, all servers will be returned.
:param sort_keys: List of sort keys
:param sort_dirs: List of sort directions

8
novaclient/v2/usage.py
View File

@ -87,7 +87,9 @@ class UsageManager(base.ManagerWithFind):
later in the instance list than that represented by
this instance UUID (optional).
:param limit: Maximum number of instances to include in the usage
(optional).
(optional). Note the API server has a configurable
default limit. If no limit is specified here or limit
is larger than default, the default limit will be used.
:rtype: list of :class:`Usage`.
"""
query_string = self._usage_query(start, end, marker, limit, detailed)
@ -120,7 +122,9 @@ class UsageManager(base.ManagerWithFind):
later in the instance list than that represented by
this instance UUID (optional).
:param limit: Maximum number of instances to include in the usage
(optional).
(optional). Note the API server has a configurable
default limit. If no limit is specified here or limit
is larger than default, the default limit will be used.
:rtype: :class:`Usage`
"""
query_string = self._usage_query(start, end, marker, limit)