Document session as an argument to v3.Client

Developers are probably going to want to know what the type of
the session argument is since other methods of constructing
v3.client.Client are deprecated.

Change-Id: Ifb94ef134b86980f88e7cf3c80344c458937d1ab
This commit is contained in:
Brant Knudson
2016-02-28 11:10:41 -06:00
parent 7d57eceb19
commit e418ff8e50

View File

@@ -50,6 +50,8 @@ _logger = logging.getLogger(__name__)
class Client(httpclient.HTTPClient): class Client(httpclient.HTTPClient):
"""Client for the OpenStack Identity API v3. """Client for the OpenStack Identity API v3.
:param session: Session for requests. (optional)
:type session: keystoneauth1.session.Session
:param string user_id: User ID for authentication. (optional) :param string user_id: User ID for authentication. (optional)
:param string username: Username for authentication. (optional) :param string username: Username for authentication. (optional)
:param string user_domain_id: User's domain ID for authentication. :param string user_domain_id: User's domain ID for authentication.