From af9d954ef55ee50b076fd2437560ff794b3d682c Mon Sep 17 00:00:00 2001 From: Marek Denis Date: Fri, 24 Apr 2015 17:04:12 +0200 Subject: [PATCH] Add docstrings for ``protocol`` parameter Parameter ``protocol`` was missing docstrings in the __init__. Also, config help is very poor. This patch fixes both issues. Change-Id: Ia2cfee9ba6aa5f4ca036c008bcfe03ff9113c7a3 --- keystoneclient/auth/identity/v3/federated.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/keystoneclient/auth/identity/v3/federated.py b/keystoneclient/auth/identity/v3/federated.py index db7ad2b92..f6416eb87 100644 --- a/keystoneclient/auth/identity/v3/federated.py +++ b/keystoneclient/auth/identity/v3/federated.py @@ -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