openstack/python-keystoneclient
Code Issues Proposed changes

Fix identity_providers docstring

Browse Source 
Adds the missing information in the IdentityProviderManager class
methods.

Change-Id: I3b9bcc39f5c15f654e242d2e2b3af3167b00ceb1
This commit is contained in:
Rodrigo Duarte
2016-04-26 17:22:52 -03:00
parent 20e23f3e0d
commit b4dcb21fb1
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
keystoneclient/v3/contrib/federation/identity_providers.py
View File

@@ -47,6 +47,10 @@ class IdentityProviderManager(base.CrudManager):
PUT /OS-FEDERATION/identity_providers/$identity_provider
:param id: unique id of the identity provider.
:param kwargs: optional attributes: description (str), enabled
(boolean) and remote_ids (list).
:returns: an IdentityProvider resource object.
:rtype: :py:class:`keystoneclient.v3.federation.IdentityProvider`
"""
return self._build_url_and_put(identity_provider_id=id,
@@ -60,6 +64,8 @@ class IdentityProviderManager(base.CrudManager):
:param identity_provider: an object with identity_provider_id
stored inside.
:returns: an IdentityProvider resource object.
:rtype: :py:class:`keystoneclient.v3.federation.IdentityProvider`
"""
return super(IdentityProviderManager, self).get(
@@ -71,6 +77,9 @@ class IdentityProviderManager(base.CrudManager):
Utilize Keystone URI:
GET /OS-FEDERATION/identity_providers
:returns: a list of IdentityProvider resource objects.
:rtype: list
"""
return super(IdentityProviderManager, self).list(**kwargs)
@@ -82,6 +91,8 @@ class IdentityProviderManager(base.CrudManager):
:param identity_provider: an object with identity_provider_id
stored inside.
:returns: an IdentityProvider resource object.
:rtype: :py:class:`keystoneclient.v3.federation.IdentityProvider`
"""
return super(IdentityProviderManager, self).update(
@@ -93,8 +104,8 @@ class IdentityProviderManager(base.CrudManager):
Utilize Keystone URI:
DELETE /OS-FEDERATION/identity_providers/$identity_provider
:param identity_provider: an object with identity_provider_id
stored inside.
:param identity_provider: the Identity Provider ID itself or an object
with it stored inside.
"""
return super(IdentityProviderManager, self).delete(