openstack
/
keystoneauth
Code Issues Proposed changes

Generate FederationBaseAuth constructor parameters 

The parameter documentation didn't make it into the generated
docs so nobody could use this class.

Change-Id: If264804f513b07b1253bd73698ef14891f94c0a9
This commit is contained in:
Brant Knudson 2016-03-01 14:33:10 -06:00
parent 2e951b7670
commit ee85077a98
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
keystoneauth1/identity/v3/federation.py
View File

@ -80,22 +80,22 @@ class _Rescoped(base.BaseAuth):
class FederationBaseAuth(_Rescoped):
"""Federation authentication plugin.
:param auth_url: URL of the Identity Service
:type auth_url: string
: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: name of the protocol the client will authenticate
against.
:type protocol: string
"""
def __init__(self, auth_url, identity_provider, protocol, **kwargs):
"""Class constructor accepting following parameters:
:param auth_url: URL of the Identity Service
:type auth_url: string
: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: name of the protocol the client will authenticate
against.
:type protocol: string
"""
super(FederationBaseAuth, self).__init__(auth_url=auth_url, **kwargs)
self.identity_provider = identity_provider
self.protocol = protocol