openstack/keystoneauth
Code Issues Proposed changes

Improve usability of docs

Browse Source 
There's several references to BaseAuthPlugin, unfortunately the
docs for BaseAuthPlugin didn't lead to anywhere useful. Added
links to the implementations so developers know what to do next.

Change-Id: I8cf0f54cdec358238774636ba1d42f11e7ace555
This commit is contained in:
Brant Knudson 2016-03-01 13:59:38 -06:00
parent 2e951b7670
commit 73b1e66a16
2 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
keystoneauth1/identity/__init__.py
View File

@ -20,16 +20,28 @@ from keystoneauth1.identity.v3 import oidc
BaseIdentityPlugin = base.BaseIdentityPlugin BaseIdentityPlugin = base.BaseIdentityPlugin
V2Password = v2.Password V2Password = v2.Password
"""See :class:`keystoneauth1.identity.v2.Password`"""
V2Token = v2.Token V2Token = v2.Token
"""See :class:`keystoneauth1.identity.v2.Token`"""
V3Password = v3.Password V3Password = v3.Password
"""See :class:`keystoneauth1.identity.v3.Password`"""
V3Token = v3.Token V3Token = v3.Token
"""See :class:`keystoneauth1.identity.v3.Token`"""
Password = generic.Password Password = generic.Password
"""See :class:`keystoneauth1.identity.generic.Password`"""
Token = generic.Token Token = generic.Token
"""See :class:`keystoneauth1.identity.generic.Token`"""
V3OidcPassword = oidc.OidcPassword V3OidcPassword = oidc.OidcPassword
"""See :class:`keystoneauth1.identity.v3.oidc.OidcPassword`"""
V3OidcAuthorizationCode = oidc.OidcAuthorizationCode V3OidcAuthorizationCode = oidc.OidcAuthorizationCode
"""See :class:`keystoneauth1.identity.v3.oidc.OidcAuthorizationCode`"""
__all__ = ('BaseIdentityPlugin', __all__ = ('BaseIdentityPlugin',
'Password', 'Password',

8
keystoneauth1/plugin.py
View File

@ -19,7 +19,13 @@ IDENTITY_AUTH_HEADER_NAME = 'X-Auth-Token'
class BaseAuthPlugin(object): class BaseAuthPlugin(object):
"""The basic structure of an authentication plugin.""" """The basic structure of an authentication plugin.
.. note::
See :doc:`/authentication-plugins` for a description of plugins
provided by this library.
"""
def get_token(self, session, **kwargs): def get_token(self, session, **kwargs):
"""Obtain a token. """Obtain a token.