diff options
author | Zuul <zuul@review.opendev.org> | 2019-05-17 15:24:11 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2019-05-17 15:24:11 +0000 |
commit | dfb84228a2748bed82f9b83c1209d5e2e0557bfa (patch) | |
tree | 2968af644554ee73a8f2bfc2de9e9c2142e32d2e | |
parent | 8c3311eefe0ff94a3184d3a7caca89ae1310e934 (diff) | |
parent | 2ecb39710f1fd9f6e5765e52d29953c2af44e714 (diff) | |
download | python-novaclient-dfb84228a2748bed82f9b83c1209d5e2e0557bfa.tar.gz |
Merge "Optimize limit option docs string description for novaclient"
-rw-r--r-- | novaclient/v2/flavors.py | 3 | ||||
-rw-r--r-- | novaclient/v2/hypervisors.py | 3 | ||||
-rw-r--r-- | novaclient/v2/instance_action.py | 3 | ||||
-rw-r--r-- | novaclient/v2/keypairs.py | 3 | ||||
-rw-r--r-- | novaclient/v2/migrations.py | 6 | ||||
-rw-r--r-- | novaclient/v2/server_groups.py | 3 | ||||
-rw-r--r-- | novaclient/v2/servers.py | 4 | ||||
-rw-r--r-- | novaclient/v2/usage.py | 8 |
8 files changed, 31 insertions, 2 deletions
diff --git a/novaclient/v2/flavors.py b/novaclient/v2/flavors.py index 9cc2b643..803e226a 100644 --- a/novaclient/v2/flavors.py +++ b/novaclient/v2/flavors.py @@ -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`. diff --git a/novaclient/v2/hypervisors.py b/novaclient/v2/hypervisors.py index f457fa08..4b26bfc5 100644 --- a/novaclient/v2/hypervisors.py +++ b/novaclient/v2/hypervisors.py @@ -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) diff --git a/novaclient/v2/instance_action.py b/novaclient/v2/instance_action.py index 79f1b617..d84c50f9 100644 --- a/novaclient/v2/instance_action.py +++ b/novaclient/v2/instance_action.py @@ -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. diff --git a/novaclient/v2/keypairs.py b/novaclient/v2/keypairs.py index 08c5ea39..9b2e73b7 100644 --- a/novaclient/v2/keypairs.py +++ b/novaclient/v2/keypairs.py @@ -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: diff --git a/novaclient/v2/migrations.py b/novaclient/v2/migrations.py index f1954f1a..ab62f2c5 100644 --- a/novaclient/v2/migrations.py +++ b/novaclient/v2/migrations.py @@ -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). diff --git a/novaclient/v2/server_groups.py b/novaclient/v2/server_groups.py index e8839ae5..bc66b01a 100644 --- a/novaclient/v2/server_groups.py +++ b/novaclient/v2/server_groups.py @@ -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) diff --git a/novaclient/v2/servers.py b/novaclient/v2/servers.py index afbd5536..2f14f43d 100644 --- a/novaclient/v2/servers.py +++ b/novaclient/v2/servers.py @@ -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 diff --git a/novaclient/v2/usage.py b/novaclient/v2/usage.py index abbeca69..32fc5508 100644 --- a/novaclient/v2/usage.py +++ b/novaclient/v2/usage.py @@ -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) |