Correct docstrings for federation driver interface
A number of the federation driver signature docstings were missing descriptions of paramaters and/or return values. This patch adds the missing docstring information. Change-Id: I59bd800385eb40f1f59c191f0ae8e128eef12e0e
This commit is contained in:
Henry Nash
parent
08ce1a504b
commit
3a4a739ef9
@ -114,7 +114,12 @@ class FederationDriverBase(object):
|
||||
def create_idp(self, idp_id, idp):
|
||||
"""Create an identity provider.
|
||||
|
||||
:returns: idp_ref
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:param idp: idp object
|
||||
:type idp: dict
|
||||
:returns: idp ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -123,6 +128,8 @@ class FederationDriverBase(object):
|
||||
def delete_idp(self, idp_id):
|
||||
"""Delete an identity provider.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
@ -135,6 +142,8 @@ class FederationDriverBase(object):
|
||||
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:returns: list of idp refs
|
||||
:rtype: list of dicts
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -143,8 +152,12 @@ class FederationDriverBase(object):
|
||||
def get_idp(self, idp_id):
|
||||
"""Get an identity provider by ID.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:returns: idp ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -153,8 +166,12 @@ class FederationDriverBase(object):
|
||||
def get_idp_from_remote_id(self, remote_id):
|
||||
"""Get an identity provider by remote ID.
|
||||
|
||||
:param remote_id: ID of remote IdP
|
||||
:type idp_id: string
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:returns: idp ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -163,8 +180,14 @@ class FederationDriverBase(object):
|
||||
def update_idp(self, idp_id, idp):
|
||||
"""Update an identity provider by ID.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:param idp: idp object
|
||||
:type idp: dict
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:returns: idp ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -173,8 +196,16 @@ class FederationDriverBase(object):
|
||||
def create_protocol(self, idp_id, protocol_id, protocol):
|
||||
"""Add an IdP-Protocol configuration.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:param protocol_id: ID of protocol object
|
||||
:type protocol_id: string
|
||||
:param protocol: protocol object
|
||||
:type protocol: dict
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:returns: protocol ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -183,10 +214,18 @@ class FederationDriverBase(object):
|
||||
def update_protocol(self, idp_id, protocol_id, protocol):
|
||||
"""Change an IdP-Protocol configuration.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:param protocol_id: ID of protocol object
|
||||
:type protocol_id: string
|
||||
:param protocol: protocol object
|
||||
:type protocol: dict
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
:returns: protocol ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -195,10 +234,16 @@ class FederationDriverBase(object):
|
||||
def get_protocol(self, idp_id, protocol_id):
|
||||
"""Get an IdP-Protocol configuration.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:param protocol_id: ID of protocol object
|
||||
:type protocol_id: string
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
:returns: protocol ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -207,8 +252,12 @@ class FederationDriverBase(object):
|
||||
def list_protocols(self, idp_id):
|
||||
"""List an IdP's supported protocols.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:returns: list of protocol ref
|
||||
:rtype: list of dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -217,6 +266,10 @@ class FederationDriverBase(object):
|
||||
def delete_protocol(self, idp_id, protocol_id):
|
||||
"""Delete an IdP-Protocol configuration.
|
||||
|
||||
:param idp_id: ID of IdP object
|
||||
:type idp_id: string
|
||||
:param protocol_id: ID of protocol object
|
||||
:type protocol_id: string
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
@ -229,11 +282,12 @@ class FederationDriverBase(object):
|
||||
def create_mapping(self, mapping_id, mapping):
|
||||
"""Create a mapping.
|
||||
|
||||
:param mapping_id: id of mapping ref
|
||||
:param mapping_id: ID of mapping object
|
||||
:type mapping_id: string
|
||||
:param mapping: mapping ref with mapping name
|
||||
:type mapping: dict
|
||||
:returns: mapping ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -257,7 +311,8 @@ class FederationDriverBase(object):
|
||||
:type mapping_id: string
|
||||
:param mapping_ref: new mapping ref
|
||||
:type mapping_ref: dict
|
||||
:returns: mapping_ref
|
||||
:returns: mapping ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -266,7 +321,8 @@ class FederationDriverBase(object):
|
||||
def list_mappings(self):
|
||||
"""List all mappings.
|
||||
|
||||
:returns: list of mappings
|
||||
:returns: list of mapping refs
|
||||
:rtype: list of dicts
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -278,7 +334,10 @@ class FederationDriverBase(object):
|
||||
|
||||
:param mapping_id: id of mapping to get
|
||||
:type mapping_ref: string
|
||||
:returns: mapping_ref
|
||||
:raises keystone.exception.MappingNotFound: If the mapping cannot
|
||||
be found.
|
||||
:returns: mapping ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -295,7 +354,8 @@ class FederationDriverBase(object):
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
:returns: mapping_ref
|
||||
:returns: mapping ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
@ -309,7 +369,7 @@ class FederationDriverBase(object):
|
||||
:param sp: service prvider object
|
||||
:type sp: dict
|
||||
|
||||
:returns: sp_ref
|
||||
:returns: service provider ref
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
@ -332,7 +392,7 @@ class FederationDriverBase(object):
|
||||
def list_sps(self):
|
||||
"""List all service providers.
|
||||
|
||||
:returns: List of sp_ref objects
|
||||
:returns: List of service provider ref objects
|
||||
:rtype: list of dicts
|
||||
|
||||
"""
|
||||
@ -344,8 +404,9 @@ class FederationDriverBase(object):
|
||||
|
||||
:param sp_id: id of the service provider
|
||||
:type sp_id: string
|
||||
:returns: service provider ref
|
||||
:rtype: dict
|
||||
|
||||
:returns: sp_ref
|
||||
:raises keystone.exception.ServiceProviderNotFound: If the service
|
||||
provider doesn't exist.
|
||||
|
||||
@ -361,7 +422,7 @@ class FederationDriverBase(object):
|
||||
:param sp: service prvider object
|
||||
:type sp: dict
|
||||
|
||||
:returns: sp_ref
|
||||
:returns: service provider ref
|
||||
:rtype: dict
|
||||
|
||||
:raises keystone.exception.ServiceProviderNotFound: If the service
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user