summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-04-28 21:52:47 +0000
committerGerrit Code Review <review@openstack.org>2016-04-28 21:52:47 +0000
commit7af57ed5ba77cb043b9e1ad3b63da1ab391b75d2 (patch)
treefe6996159a7f9dc5bee4e75c1aed3c3a464dd1cc
parent04d47fe79e2659f201609125b8d7d2ad5e817146 (diff)
parentb4dcb21fb109cce03aa2dc88a02f5c049260054f (diff)
downloadpython-keystoneclient-7af57ed5ba77cb043b9e1ad3b63da1ab391b75d2.tar.gz
Merge "Fix identity_providers docstring"
-rw-r--r--keystoneclient/v3/contrib/federation/identity_providers.py15
1 files changed, 13 insertions, 2 deletions
diff --git a/keystoneclient/v3/contrib/federation/identity_providers.py b/keystoneclient/v3/contrib/federation/identity_providers.py
index 349317d..e21a136 100644
--- a/keystoneclient/v3/contrib/federation/identity_providers.py
+++ b/keystoneclient/v3/contrib/federation/identity_providers.py
@@ -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(