openstack/python-keystoneclient
Code Issues Proposed changes

Add auth plugin params to doc

Browse Source 
These parameters were always available and documented however the way
the documentation is generated it is not clear from the superclass what
parameters are available from inheritance.

Copy the documentation for parameters from the subclass.

Change-Id: I43db89505a03d7a4fbd51fadc0e1042a83f2f72a
This commit is contained in:
Jamie Lennox
2014-12-15 11:28:58 +10:00
parent f9be84a566
commit 764e42e55e
2 changed files with 44 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
keystoneclient/auth/identity/v2.py
View File

@@ -107,6 +107,11 @@ class Password(Auth):
:param string username: Username for authentication.
:param string password: Password for authentication.
:param string user_id: User ID for authentication.
:param string trust_id: Trust ID for trust scoping.
:param string tenant_id: Tenant ID for tenant scoping.
:param string tenant_name: Tenant name for tenant scoping.
:param bool reauthenticate: Allow fetching a new token if the current one
is going to expire. (optional) default True
:raises TypeError: if a user_id or username is not provided.
"""
@@ -160,6 +165,11 @@ class Token(Auth):
:param string auth_url: Identity service endpoint for authorization.
:param string token: Existing token for authentication.
:param string tenant_id: Tenant ID for tenant scoping.
:param string tenant_name: Tenant name for tenant scoping.
:param string trust_id: Trust ID for trust scoping.
:param bool reauthenticate: Allow fetching a new token if the current one
is going to expire. (optional) default True
"""
def __init__(self, auth_url, token, **kwargs):

34
keystoneclient/auth/identity/v3.py
View File

@@ -237,6 +237,25 @@ class PasswordMethod(AuthMethod):
class Password(AuthConstructor):
"""A plugin for authenticating with a username and password.
:param string auth_url: Identity service endpoint for authentication.
:param string password: Password for authentication.
:param string username: Username for authentication.
:param string user_id: User ID for authentication.
:param string user_domain_id: User's domain ID for authentication.
:param string user_domain_name: User's domain name for authentication.
:param string trust_id: Trust ID for trust scoping.
:param string domain_id: Domain ID for domain scoping.
:param string domain_name: Domain name for domain scoping.
:param string project_id: Project ID for project scoping.
:param string project_name: Project name for project scoping.
:param string project_domain_id: Project's domain ID for project.
:param string project_domain_name: Project's domain name for project.
:param bool reauthenticate: Allow fetching a new token if the current one
is going to expire. (optional) default True
"""
_auth_method_class = PasswordMethod
@classmethod
@@ -269,6 +288,21 @@ class TokenMethod(AuthMethod):
class Token(AuthConstructor):
"""A plugin for authenticating with an existing Token.
:param string auth_url: Identity service endpoint for authentication.
:param string token: Token for authentication.
:param string trust_id: Trust ID for trust scoping.
:param string domain_id: Domain ID for domain scoping.
:param string domain_name: Domain name for domain scoping.
:param string project_id: Project ID for project scoping.
:param string project_name: Project name for project scoping.
:param string project_domain_id: Project's domain ID for project.
:param string project_domain_name: Project's domain name for project.
:param bool reauthenticate: Allow fetching a new token if the current one
is going to expire. (optional) default True
"""
_auth_method_class = TokenMethod
def __init__(self, auth_url, token, **kwargs):