openstack/python-keystoneclient
Code Issues Proposed changes

Add docstrings for `protocol` parameter

Browse Source 
Parameter ``protocol`` was missing docstrings in the __init__.
Also, config help is very poor.
This patch fixes both issues.

Change-Id: Ia2cfee9ba6aa5f4ca036c008bcfe03ff9113c7a3
This commit is contained in:
Marek Denis
2015-04-24 17:04:12 +02:00
parent 841e634ace
commit af9d954ef5
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
keystoneclient/auth/identity/v3/federated.py
View File

@@ -31,11 +31,14 @@ class FederatedBaseAuth(base.BaseAuth):
:param auth_url: URL of the Identity Service
:type auth_url: string
:param identity_provider: name of the Identity Provider the client
:param identity_provider: Name of the Identity Provider the client
will authenticate against. This parameter
will be used to build a dynamic URL used to
obtain unscoped OpenStack token.
:type identity_provider: string
:param protocol: Protocol name configured on the keystone service
provider side
:type protocol: string
"""
super(FederatedBaseAuth, self).__init__(auth_url=auth_url, **kwargs)
@@ -49,8 +52,12 @@ class FederatedBaseAuth(base.BaseAuth):
options.extend([
cfg.StrOpt('identity-provider',
help="Identity Provider's name"),
cfg.StrOpt('protocol',
help='Protocol for federated plugin'),
cfg.StrOpt('protocol', help="Name of the federated protocol used "
"for federated authentication. Must "
"match its counterpart name "
"configured at the keystone service "
"provider. Typically values would be "
"'saml2' or 'oidc'.")
])
return options