openstack/python-novaclient
Code Issues Proposed changes

Merge "Add Client object to documentation"

Browse Source
This commit is contained in:
Jenkins 2015-03-12 18:32:48 +00:00 committed by Gerrit Code Review
commit 49d6d9278c
2 changed files with 38 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/conf.py
View File

@ -72,12 +72,12 @@ def gen_ref(ver, title, names):
gen_ref(None, "Exceptions", ["exceptions"])
gen_ref("v2", "Version 1.1, Version 2 API Reference, Version 3 API Reference",
["flavors", "images", "servers", "hosts", "agents", "aggregates",
"availability_zones", "certs", "fixed_ips", "floating_ip_pools",
"floating_ips", "hypervisors", "keypairs", "limits", "networks",
"quota_classes", "quotas", "security_group_rules",
"security_groups", "services", "virtual_interfaces",
"volume_snapshots", "volumes", "volume_types"])
["client", "flavors", "images", "servers", "hosts", "agents",
"aggregates", "availability_zones", "certs", "fixed_ips",
"floating_ip_pools", "floating_ips", "hypervisors", "keypairs",
"limits", "networks", "quota_classes", "quotas",
"security_group_rules", "security_groups", "services",
"virtual_interfaces", "volume_snapshots", "volumes", "volume_types"])
# -- General configuration ----------------------------------------------------
@ -86,6 +86,8 @@ gen_ref("v2", "Version 1.1, Version 2 API Reference, Version 3 API Reference",
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'oslosphinx']
autoclass_content = 'both'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

30
novaclient/v2/client.py
View File

@ -104,6 +104,36 @@ class Client(object):
cacert=None, tenant_id=None, user_id=None,
connection_pool=False, session=None, auth=None,
**kwargs):
"""
:param str username: Username
:param str api_key: API Key
:param str project_id: Project ID
:param str auth_url: Auth URL
:param bool insecure: Allow insecure
:param float timeout: API timeout, None or 0 disables
:param str proxy_tenant_id: Tenant ID
:param str proxy_token: Proxy Token
:param str region_name: Region Name
:param str endpoint_type: Endpoint Type
:param str extensions: Exensions
:param str service_type: Service Type
:param str service_name: Service Name
:param str volume_service_name: Volume Service Name
:param bool timings: Timings
:param str bypass_url: Bypass URL
:param bool os_cache: OS cache
:param bool no_cache: No cache
:param bool http_log_debug: Enable debugging for HTTP connections
:param str auth_system: Auth system
:param str auth_plugin: Auth plugin
:param str auth_token: Auth token
:param str cacert: cacert
:param str tenant_id: Tenant ID
:param str user_id: User ID
:param bool connection_pool: Use a connection pool
:param str session: Session
:param str auth: Auth
"""
# FIXME(comstud): Rename the api_key argument above when we
# know it's not being used as keyword argument