Using the right format to render the docstring correctly
There are several issues in the docstring, the format is not correct, not using the full path of class etc. This patch corrects all of them, so the docstring will be rendered correctly. Change-Id: I04d5818f38b5e75b6f6197ef5e13dcd64ed91bf4
This commit is contained in:
Dave Chen
Steve Martinelli
parent
f468f32d8f
commit
5070039812
|
|
@ -91,7 +91,8 @@ class Manager(manager.Manager):
|
|||
inheritance.
|
||||
|
||||
:returns: a list of role ids.
|
||||
:raises: keystone.exception.ProjectNotFound
|
||||
:raises keystone.exception.ProjectNotFound: If the project doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
self.resource_api.get_project(tenant_id)
|
||||
|
|
@ -104,7 +105,7 @@ class Manager(manager.Manager):
|
|||
"""Get the roles associated with a user within given domain.
|
||||
|
||||
:returns: a list of role ids.
|
||||
:raises: keystone.exception.DomainNotFound
|
||||
:raises keystone.exception.DomainNotFound: If the domain doesn't exist.
|
||||
|
||||
"""
|
||||
self.resource_api.get_domain(domain_id)
|
||||
|
|
@ -131,8 +132,9 @@ class Manager(manager.Manager):
|
|||
def add_user_to_project(self, tenant_id, user_id):
|
||||
"""Add user to a tenant by creating a default role relationship.
|
||||
|
||||
:raises: keystone.exception.ProjectNotFound,
|
||||
keystone.exception.UserNotFound
|
||||
:raises keystone.exception.ProjectNotFound: If the project doesn't
|
||||
exist.
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
|
||||
"""
|
||||
self.resource_api.get_project(tenant_id)
|
||||
|
|
@ -182,8 +184,9 @@ class Manager(manager.Manager):
|
|||
def remove_user_from_project(self, tenant_id, user_id):
|
||||
"""Remove user from a tenant
|
||||
|
||||
:raises: keystone.exception.ProjectNotFound,
|
||||
keystone.exception.UserNotFound
|
||||
:raises keystone.exception.ProjectNotFound: If the project doesn't
|
||||
exist.
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
|
||||
"""
|
||||
roles = self.get_roles_for_user_and_project(user_id, tenant_id)
|
||||
|
|
@ -915,8 +918,8 @@ class AssignmentDriverV8(object):
|
|||
def add_role_to_user_and_project(self, user_id, tenant_id, role_id):
|
||||
"""Add a role to a user within given tenant.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
|
||||
:raises keystone.exception.Conflict: If a duplicate role assignment
|
||||
exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -925,7 +928,7 @@ class AssignmentDriverV8(object):
|
|||
def remove_role_from_user_and_project(self, user_id, tenant_id, role_id):
|
||||
"""Remove a role from a user within given tenant.
|
||||
|
||||
:raises: keystone.exception.RoleNotFound
|
||||
:raises keystone.exception.RoleNotFound: If the role doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -958,7 +961,8 @@ class AssignmentDriverV8(object):
|
|||
inherited_to_projects=False):
|
||||
"""Checks an assignment/grant role id.
|
||||
|
||||
:raises: keystone.exception.RoleAssignmentNotFound
|
||||
:raises keystone.exception.RoleAssignmentNotFound: If the role
|
||||
assignment doesn't exist.
|
||||
:returns: None or raises an exception if grant not found
|
||||
|
||||
"""
|
||||
|
|
@ -970,7 +974,8 @@ class AssignmentDriverV8(object):
|
|||
inherited_to_projects=False):
|
||||
"""Deletes assignments/grants.
|
||||
|
||||
:raises: keystone.exception.RoleAssignmentNotFound
|
||||
:raises keystone.exception.RoleAssignmentNotFound: If the role
|
||||
assignment doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1099,7 +1104,8 @@ class AssignmentDriverV8(object):
|
|||
def delete_project_assignments(self, project_id):
|
||||
"""Deletes all assignments for a project.
|
||||
|
||||
:raises: keystone.exception.ProjectNotFound
|
||||
:raises keystone.exception.ProjectNotFound: If the project doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1113,7 +1119,7 @@ class AssignmentDriverV8(object):
|
|||
def delete_user_assignments(self, user_id):
|
||||
"""Deletes all assignments for a user.
|
||||
|
||||
:raises: keystone.exception.RoleNotFound
|
||||
:raises keystone.exception.RoleNotFound: If the role doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1122,7 +1128,7 @@ class AssignmentDriverV8(object):
|
|||
def delete_group_assignments(self, group_id):
|
||||
"""Deletes all assignments for a group.
|
||||
|
||||
:raises: keystone.exception.RoleNotFound
|
||||
:raises keystone.exception.RoleNotFound: If the role doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1190,7 +1196,7 @@ class RoleDriverV8(object):
|
|||
def create_role(self, role_id, role):
|
||||
"""Creates a new role.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises keystone.exception.Conflict: If a duplicate role exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1226,7 +1232,7 @@ class RoleDriverV8(object):
|
|||
"""Get a role by ID.
|
||||
|
||||
:returns: role_ref
|
||||
:raises: keystone.exception.RoleNotFound
|
||||
:raises keystone.exception.RoleNotFound: If the role doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1235,8 +1241,8 @@ class RoleDriverV8(object):
|
|||
def update_role(self, role_id, role):
|
||||
"""Updates an existing role.
|
||||
|
||||
:raises: keystone.exception.RoleNotFound,
|
||||
keystone.exception.Conflict
|
||||
:raises keystone.exception.RoleNotFound: If the role doesn't exist.
|
||||
:raises keystone.exception.Conflict: If a duplicate role exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1245,7 +1251,7 @@ class RoleDriverV8(object):
|
|||
def delete_role(self, role_id):
|
||||
"""Deletes an existing role.
|
||||
|
||||
:raises: keystone.exception.RoleNotFound
|
||||
:raises keystone.exception.RoleNotFound: If the role doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
|
|||
|
|
@ -89,6 +89,6 @@ class AuthMethodHandler(object):
|
|||
Authentication payload in the form of a dictionary for the
|
||||
next authentication step if this is a multi step
|
||||
authentication.
|
||||
:raises: exception.Unauthorized for authentication failure
|
||||
:raises keystone.exception.Unauthorized: for authentication failure
|
||||
"""
|
||||
raise exception.Unauthorized()
|
||||
|
|
|
|||
|
|
@ -224,7 +224,8 @@ def setup_username(context, mapped_properties):
|
|||
:param mapped_properties: Properties issued by a RuleProcessor.
|
||||
:type: dictionary
|
||||
|
||||
:raises: exception.Unauthorized
|
||||
:raises keystone.exception.Unauthorized: If neither `user_name` nor
|
||||
`user_id` is set.
|
||||
:returns: dictionary with user identification
|
||||
:rtype: dict
|
||||
|
||||
|
|
|
|||
|
|
@ -164,7 +164,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_id: string
|
||||
:param project_id: identity of the project to be associated with
|
||||
:type project_id: string
|
||||
:raises: keystone.exception.Conflict,
|
||||
:raises: keystone.exception.Conflict: If the endpoint was already
|
||||
added to project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -177,7 +178,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_id: string
|
||||
:param project_id: identity of the project associated with
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint was not found
|
||||
in the project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -190,7 +192,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_id: string
|
||||
:param project_id: identity of the project associated with
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint was not found
|
||||
in the project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -241,7 +244,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
|
||||
:param endpoint_group: endpoint group to create
|
||||
:type endpoint_group: dictionary
|
||||
:raises: keystone.exception.Conflict,
|
||||
:raises: keystone.exception.Conflict: If a duplicate endpoint group
|
||||
already exists.
|
||||
:returns: an endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -252,7 +256,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
|
||||
:param endpoint_group_id: identity of endpoint group to retrieve
|
||||
:type endpoint_group_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group was not
|
||||
found.
|
||||
:returns: an endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -265,7 +270,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_group_id: string
|
||||
:param endpoint_group: A full or partial endpoint_group
|
||||
:type endpoint_group: dictionary
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group was not
|
||||
found.
|
||||
:returns: an endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -276,7 +282,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
|
||||
:param endpoint_group_id: identity of endpoint group to delete
|
||||
:type endpoint_group_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group was not
|
||||
found.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -289,7 +296,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_group_id: string
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: keystone.exception.Conflict,
|
||||
:raises keystone.exception.Conflict: If the endpoint group was already
|
||||
added to the project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -302,7 +310,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_group_id: string
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group to the
|
||||
project association was not found.
|
||||
:returns: a project endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -311,7 +320,6 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
def list_endpoint_groups(self):
|
||||
"""List all endpoint groups.
|
||||
|
||||
:raises: exception.NotFound
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -322,7 +330,6 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -333,7 +340,6 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
|
||||
:param endpoint_group_id: identity of endpoint to associate
|
||||
:type endpoint_group_id: string
|
||||
:raises: exception.NotFound
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -347,7 +353,8 @@ class Catalog(kvs.Base, catalog.CatalogDriverV8):
|
|||
:type endpoint_group_id: string
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If endpoint group project
|
||||
association was not found.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -349,8 +349,9 @@ class CatalogDriverV8(object):
|
|||
def create_region(self, region_ref):
|
||||
"""Creates a new region.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises: keystone.exception.RegionNotFound (if parent region invalid)
|
||||
:raises keystone.exception.Conflict: If the region already exists.
|
||||
:raises keystone.exception.RegionNotFound: If the parent region
|
||||
is invalid.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -373,7 +374,7 @@ class CatalogDriverV8(object):
|
|||
"""Get region by id.
|
||||
|
||||
:returns: region_ref dict
|
||||
:raises: keystone.exception.RegionNotFound
|
||||
:raises keystone.exception.RegionNotFound: If the region doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -383,7 +384,7 @@ class CatalogDriverV8(object):
|
|||
"""Update region by id.
|
||||
|
||||
:returns: region_ref dict
|
||||
:raises: keystone.exception.RegionNotFound
|
||||
:raises keystone.exception.RegionNotFound: If the region doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -392,7 +393,7 @@ class CatalogDriverV8(object):
|
|||
def delete_region(self, region_id):
|
||||
"""Deletes an existing region.
|
||||
|
||||
:raises: keystone.exception.RegionNotFound
|
||||
:raises keystone.exception.RegionNotFound: If the region doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -401,7 +402,7 @@ class CatalogDriverV8(object):
|
|||
def create_service(self, service_id, service_ref):
|
||||
"""Creates a new service.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises keystone.exception.Conflict: If a duplicate service exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -424,7 +425,8 @@ class CatalogDriverV8(object):
|
|||
"""Get service by id.
|
||||
|
||||
:returns: service_ref dict
|
||||
:raises: keystone.exception.ServiceNotFound
|
||||
:raises keystone.exception.ServiceNotFound: If the service doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -434,7 +436,8 @@ class CatalogDriverV8(object):
|
|||
"""Update service by id.
|
||||
|
||||
:returns: service_ref dict
|
||||
:raises: keystone.exception.ServiceNotFound
|
||||
:raises keystone.exception.ServiceNotFound: If the service doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -443,7 +446,8 @@ class CatalogDriverV8(object):
|
|||
def delete_service(self, service_id):
|
||||
"""Deletes an existing service.
|
||||
|
||||
:raises: keystone.exception.ServiceNotFound
|
||||
:raises keystone.exception.ServiceNotFound: If the service doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -452,8 +456,9 @@ class CatalogDriverV8(object):
|
|||
def create_endpoint(self, endpoint_id, endpoint_ref):
|
||||
"""Creates a new endpoint for a service.
|
||||
|
||||
:raises: keystone.exception.Conflict,
|
||||
keystone.exception.ServiceNotFound
|
||||
:raises keystone.exception.Conflict: If a duplicate endpoint exists.
|
||||
:raises keystone.exception.ServiceNotFound: If the service doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -463,7 +468,8 @@ class CatalogDriverV8(object):
|
|||
"""Get endpoint by id.
|
||||
|
||||
:returns: endpoint_ref dict
|
||||
:raises: keystone.exception.EndpointNotFound
|
||||
:raises keystone.exception.EndpointNotFound: If the endpoint doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -486,8 +492,10 @@ class CatalogDriverV8(object):
|
|||
"""Get endpoint by id.
|
||||
|
||||
:returns: endpoint_ref dict
|
||||
:raises: keystone.exception.EndpointNotFound
|
||||
keystone.exception.ServiceNotFound
|
||||
:raises keystone.exception.EndpointNotFound: If the endpoint doesn't
|
||||
exist.
|
||||
:raises keystone.exception.ServiceNotFound: If the service doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -496,7 +504,8 @@ class CatalogDriverV8(object):
|
|||
def delete_endpoint(self, endpoint_id):
|
||||
"""Deletes an endpoint for a service.
|
||||
|
||||
:raises: keystone.exception.EndpointNotFound
|
||||
:raises keystone.exception.EndpointNotFound: If the endpoint doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -521,7 +530,7 @@ class CatalogDriverV8(object):
|
|||
|
||||
:returns: A nested dict representing the service catalog or an
|
||||
empty dict.
|
||||
:raises: keystone.exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -553,7 +562,7 @@ class CatalogDriverV8(object):
|
|||
}]
|
||||
|
||||
:returns: A list representing the service catalog or an empty list
|
||||
:raises: keystone.exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint doesn't exist.
|
||||
|
||||
"""
|
||||
v2_catalog = self.get_catalog(user_id, tenant_id)
|
||||
|
|
@ -597,7 +606,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_id: string
|
||||
:param project_id: identity of the project to be associated with
|
||||
:type project_id: string
|
||||
:raises: keystone.exception.Conflict,
|
||||
:raises: keystone.exception.Conflict: If the endpoint was already
|
||||
added to project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -611,7 +621,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_id: string
|
||||
:param project_id: identity of the project associated with
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint was not found
|
||||
in the project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -625,7 +636,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_id: string
|
||||
:param project_id: identity of the project associated with
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint was not found
|
||||
in the project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -681,7 +693,8 @@ class CatalogDriverV8(object):
|
|||
|
||||
:param endpoint_group: endpoint group to create
|
||||
:type endpoint_group: dictionary
|
||||
:raises: keystone.exception.Conflict,
|
||||
:raises: keystone.exception.Conflict: If a duplicate endpoint group
|
||||
already exists.
|
||||
:returns: an endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -693,7 +706,8 @@ class CatalogDriverV8(object):
|
|||
|
||||
:param endpoint_group_id: identity of endpoint group to retrieve
|
||||
:type endpoint_group_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group was not
|
||||
found.
|
||||
:returns: an endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -707,7 +721,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_group_id: string
|
||||
:param endpoint_group: A full or partial endpoint_group
|
||||
:type endpoint_group: dictionary
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group was not
|
||||
found.
|
||||
:returns: an endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -719,7 +734,8 @@ class CatalogDriverV8(object):
|
|||
|
||||
:param endpoint_group_id: identity of endpoint group to delete
|
||||
:type endpoint_group_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group was not
|
||||
found.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -733,7 +749,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_group_id: string
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: keystone.exception.Conflict,
|
||||
:raises keystone.exception.Conflict: If the endpoint group was already
|
||||
added to the project.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -747,7 +764,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_group_id: string
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the endpoint group to the
|
||||
project association was not found.
|
||||
:returns: a project endpoint group representation.
|
||||
|
||||
"""
|
||||
|
|
@ -757,7 +775,6 @@ class CatalogDriverV8(object):
|
|||
def list_endpoint_groups(self):
|
||||
"""List all endpoint groups.
|
||||
|
||||
:raises: exception.NotFound
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -769,7 +786,6 @@ class CatalogDriverV8(object):
|
|||
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -781,7 +797,6 @@ class CatalogDriverV8(object):
|
|||
|
||||
:param endpoint_group_id: identity of endpoint to associate
|
||||
:type endpoint_group_id: string
|
||||
:raises: exception.NotFound
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
@ -796,7 +811,8 @@ class CatalogDriverV8(object):
|
|||
:type endpoint_group_id: string
|
||||
:param project_id: identity of project to associate
|
||||
:type project_id: string
|
||||
:raises: exception.NotFound
|
||||
:raises keystone.exception.NotFound: If endpoint group project
|
||||
association was not found.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -370,11 +370,10 @@ class DomainConfigUploadFiles(object):
|
|||
:param file_name: the file containing the config options
|
||||
:param domain_name: the domain name
|
||||
|
||||
:raises: ValueError: the domain does not exist or already has domain
|
||||
specific configurations defined
|
||||
:raises: Exceptions from oslo config: there is an issue with options
|
||||
defined in the config file or its
|
||||
format
|
||||
:raises ValueError: the domain does not exist or already has domain
|
||||
specific configurations defined.
|
||||
:raises Exceptions from oslo config: there is an issue with options
|
||||
defined in the config file or its format.
|
||||
|
||||
The caller of this method should catch the errors raised and handle
|
||||
appropriately in order that the best UX experience can be provided for
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ def utf8_encode(value):
|
|||
|
||||
:param value: A basestring
|
||||
:returns: UTF-8 encoded version of value
|
||||
:raises: TypeError if value is not basestring
|
||||
:raises TypeError: If value is not basestring
|
||||
"""
|
||||
if isinstance(value, six.text_type):
|
||||
return _utf8_encoder(value)[0]
|
||||
|
|
@ -84,7 +84,7 @@ def utf8_decode(value):
|
|||
|
||||
:param value: value to be returned as unicode
|
||||
:returns: value as unicode
|
||||
:raises: UnicodeDecodeError for invalid UTF-8 encoding
|
||||
:raises UnicodeDecodeError: for invalid UTF-8 encoding
|
||||
"""
|
||||
if isinstance(value, six.binary_type):
|
||||
return _utf8_decoder(value)[0]
|
||||
|
|
@ -1611,8 +1611,8 @@ class BaseLdap(object):
|
|||
:param member_list_dn: DN of group to which the
|
||||
member will be added.
|
||||
|
||||
:raises: exception.Conflict: If the user was already a member.
|
||||
self.NotFound: If the group entry didn't exist.
|
||||
:raises keystone.exception.Conflict: If the user was already a member.
|
||||
:raises self.NotFound: If the group entry didn't exist.
|
||||
"""
|
||||
with self.get_connection() as conn:
|
||||
try:
|
||||
|
|
@ -1634,8 +1634,8 @@ class BaseLdap(object):
|
|||
:param member_list_dn: DN of group from which the
|
||||
member will be removed.
|
||||
|
||||
:raises: self.NotFound: If the group entry didn't exist.
|
||||
ldap.NO_SUCH_ATTRIBUTE: If the user wasn't a member.
|
||||
:raises self.NotFound: If the group entry didn't exist.
|
||||
:raises ldap.NO_SUCH_ATTRIBUTE: If the user wasn't a member.
|
||||
"""
|
||||
with self.get_connection() as conn:
|
||||
try:
|
||||
|
|
|
|||
|
|
@ -512,7 +512,7 @@ def get_token_ref(context):
|
|||
"""Retrieves KeystoneToken object from the auth context and returns it.
|
||||
|
||||
:param dict context: The request context.
|
||||
:raises: exception.Unauthorized if auth context cannot be found.
|
||||
:raises keystone.exception.Unauthorized: If auth context cannot be found.
|
||||
:returns: The KeystoneToken object.
|
||||
"""
|
||||
try:
|
||||
|
|
|
|||
|
|
@ -247,7 +247,7 @@ class Ec2ControllerCommon(object):
|
|||
"""Return credentials from an ID.
|
||||
|
||||
:param credential_id: id of credential
|
||||
:raises exception.Unauthorized: when credential id is invalid
|
||||
:raises keystone.exception.Unauthorized: when credential id is invalid
|
||||
:returns: credential: dict of ec2 credential.
|
||||
"""
|
||||
ec2_credential_id = utils.hash_access_key(credential_id)
|
||||
|
|
@ -314,7 +314,7 @@ class Ec2Controller(Ec2ControllerCommon, controller.V2Controller):
|
|||
|
||||
:param context: standard context
|
||||
:param user_id: id of user
|
||||
:raises exception.Forbidden: when token is invalid
|
||||
:raises keystone.exception.Forbidden: when token is invalid
|
||||
|
||||
"""
|
||||
token_ref = utils.get_token_ref(context)
|
||||
|
|
@ -342,7 +342,7 @@ class Ec2Controller(Ec2ControllerCommon, controller.V2Controller):
|
|||
|
||||
:param user_id: expected credential owner
|
||||
:param credential_id: id of credential object
|
||||
:raises exception.Forbidden: on failure
|
||||
:raises keystone.exception.Forbidden: on failure
|
||||
|
||||
"""
|
||||
ec2_credential_id = utils.hash_access_key(credential_id)
|
||||
|
|
|
|||
|
|
@ -90,7 +90,8 @@ class ExampleDriver(object):
|
|||
|
||||
:param data: example data
|
||||
:type data: string
|
||||
:raises: keystone.exception,
|
||||
:raises keystone.exception.NotImplemented: If the operation was not
|
||||
implemented.
|
||||
:returns: None.
|
||||
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ class CredentialDriverV8(object):
|
|||
def create_credential(self, credential_id, credential):
|
||||
"""Creates a new credential.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises keystone.exception.Conflict: If a duplicate credential exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -92,7 +92,8 @@ class CredentialDriverV8(object):
|
|||
"""Get a credential by ID.
|
||||
|
||||
:returns: credential_ref
|
||||
:raises: keystone.exception.CredentialNotFound
|
||||
:raises keystone.exception.CredentialNotFound: If credential doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -101,8 +102,9 @@ class CredentialDriverV8(object):
|
|||
def update_credential(self, credential_id, credential):
|
||||
"""Updates an existing credential.
|
||||
|
||||
:raises: keystone.exception.CredentialNotFound,
|
||||
keystone.exception.Conflict
|
||||
:raises keystone.exception.CredentialNotFound: If credential doesn't
|
||||
exist.
|
||||
:raises keystone.exception.Conflict: If a duplicate credential exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -111,7 +113,8 @@ class CredentialDriverV8(object):
|
|||
def delete_credential(self, credential_id):
|
||||
"""Deletes an existing credential.
|
||||
|
||||
:raises: keystone.exception.CredentialNotFound
|
||||
:raises keystone.exception.CredentialNotFound: If credential doesn't
|
||||
exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
|
|||
|
|
@ -307,8 +307,8 @@ class EndpointPolicyDriverV8(object):
|
|||
:type service_id: string
|
||||
:param region_id: identity of the region to associate
|
||||
:type region_id: string
|
||||
:raises: keystone.exception.PolicyAssociationNotFound if there is no
|
||||
match for the specified association
|
||||
:raises keystone.exception.PolicyAssociationNotFound: If there is no
|
||||
match for the specified association.
|
||||
:returns: None
|
||||
|
||||
"""
|
||||
|
|
@ -346,8 +346,8 @@ class EndpointPolicyDriverV8(object):
|
|||
:type service_id: string
|
||||
:param region_id: identity of the region
|
||||
:type region_id: string
|
||||
:raises: keystone.exception.PolicyAssociationNotFound if there is no
|
||||
match for the specified association
|
||||
:raises keystone.exception.PolicyAssociationNotFound: If there is no
|
||||
match for the specified association.
|
||||
:returns: dict containing policy_id
|
||||
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ class Error(Exception):
|
|||
def _build_message(self, message, **kwargs):
|
||||
"""Builds and returns an exception message.
|
||||
|
||||
:raises: KeyError given insufficient kwargs
|
||||
:raises KeyError: given insufficient kwargs
|
||||
|
||||
"""
|
||||
if not message:
|
||||
|
|
|
|||
|
|
@ -255,9 +255,9 @@ class Auth(auth_controllers.Auth):
|
|||
value belongs to a list of trusted dashboards.
|
||||
|
||||
:param context: request's context
|
||||
:raises: exception.ValidationError: ``origin`` query parameter was not
|
||||
specified. The URL is deemed invalid.
|
||||
:raises: exception.Unauthorized: URL specified in origin query
|
||||
:raises keystone.exception.ValidationError: ``origin`` query parameter
|
||||
was not specified. The URL is deemed invalid.
|
||||
:raises keystone.exception.Unauthorized: URL specified in origin query
|
||||
parameter does not exist in list of websso trusted dashboards.
|
||||
:returns: URL with the originating dashboard
|
||||
|
||||
|
|
|
|||
|
|
@ -107,7 +107,8 @@ class FederationDriverV8(object):
|
|||
def delete_idp(self, idp_id):
|
||||
"""Delete an identity provider.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -116,7 +117,8 @@ class FederationDriverV8(object):
|
|||
def list_idps(self):
|
||||
"""List all identity providers.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -125,7 +127,8 @@ class FederationDriverV8(object):
|
|||
def get_idp(self, idp_id):
|
||||
"""Get an identity provider by ID.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -134,7 +137,8 @@ class FederationDriverV8(object):
|
|||
def get_idp_from_remote_id(self, remote_id):
|
||||
"""Get an identity provider by remote ID.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -143,7 +147,8 @@ class FederationDriverV8(object):
|
|||
def update_idp(self, idp_id, idp):
|
||||
"""Update an identity provider by ID.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -152,7 +157,8 @@ class FederationDriverV8(object):
|
|||
def create_protocol(self, idp_id, protocol_id, protocol):
|
||||
"""Add an IdP-Protocol configuration.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -161,8 +167,10 @@ class FederationDriverV8(object):
|
|||
def update_protocol(self, idp_id, protocol_id, protocol):
|
||||
"""Change an IdP-Protocol configuration.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound,
|
||||
keystone.exception.FederatedProtocolNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -171,8 +179,10 @@ class FederationDriverV8(object):
|
|||
def get_protocol(self, idp_id, protocol_id):
|
||||
"""Get an IdP-Protocol configuration.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound,
|
||||
keystone.exception.FederatedProtocolNotFound
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -181,7 +191,8 @@ class FederationDriverV8(object):
|
|||
def list_protocols(self, idp_id):
|
||||
"""List an IdP's supported protocols.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound,
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -190,8 +201,10 @@ class FederationDriverV8(object):
|
|||
def delete_protocol(self, idp_id, protocol_id):
|
||||
"""Delete an IdP-Protocol configuration.
|
||||
|
||||
:raises: keystone.exception.IdentityProviderNotFound,
|
||||
keystone.exception.FederatedProtocolNotFound,
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -260,8 +273,10 @@ class FederationDriverV8(object):
|
|||
:type idp_id: string
|
||||
:param protocol_id: id of the protocol
|
||||
:type protocol_id: string
|
||||
:raises: keystone.exception.IdentityProviderNotFound,
|
||||
keystone.exception.FederatedProtocolNotFound,
|
||||
:raises keystone.exception.IdentityProviderNotFound: If the IdP
|
||||
doesn't exist.
|
||||
:raises keystone.exception.FederatedProtocolNotFound: If the federated
|
||||
protocol cannot be found.
|
||||
:returns: mapping_ref
|
||||
|
||||
"""
|
||||
|
|
@ -289,7 +304,8 @@ class FederationDriverV8(object):
|
|||
:param sp_id: id of the service provider
|
||||
:type sp_id: string
|
||||
|
||||
:raises: keystone.exception.ServiceProviderNotFound
|
||||
:raises keystone.exception.ServiceProviderNotFound: If the service
|
||||
provider doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -312,7 +328,8 @@ class FederationDriverV8(object):
|
|||
:type sp_id: string
|
||||
|
||||
:returns: sp_ref
|
||||
:raises: keystone.exception.ServiceProviderNotFound
|
||||
:raises keystone.exception.ServiceProviderNotFound: If the service
|
||||
provider doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -329,7 +346,8 @@ class FederationDriverV8(object):
|
|||
:returns: sp_ref
|
||||
:rtype: dict
|
||||
|
||||
:raises: keystone.exception.ServiceProviderNotFound
|
||||
:raises keystone.exception.ServiceProviderNotFound: If the service
|
||||
provider doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
|
|||
|
|
@ -464,8 +464,8 @@ class MetadataGenerator(object):
|
|||
consumed by a federated Service Provider.
|
||||
|
||||
:return: XML <EntityDescriptor> object.
|
||||
:raises: keystone.exception.ValidationError: Raises if the required
|
||||
config options aren't set.
|
||||
:raises keystone.exception.ValidationError: If the required
|
||||
config options aren't set.
|
||||
|
||||
"""
|
||||
self._ensure_required_values_present()
|
||||
|
|
|
|||
|
|
@ -183,7 +183,7 @@ def validate_groups_cardinality(group_ids, mapping_id):
|
|||
:param group_ids: list of group ids
|
||||
:type group_ids: list of str
|
||||
|
||||
:raises exception.MissingGroups: if ``group_ids`` cardinality is 0
|
||||
:raises keystone.exception.MissingGroups: if ``group_ids`` cardinality is 0
|
||||
|
||||
"""
|
||||
if not group_ids:
|
||||
|
|
@ -249,7 +249,8 @@ def validate_groups_in_backend(group_ids, mapping_id, identity_api):
|
|||
backend
|
||||
:type identity_api: identity.Manager
|
||||
|
||||
:raises: exception.MappedGroupNotFound
|
||||
:raises keystone.exception.MappedGroupNotFound: If the group returned by
|
||||
mapping was not found in the backend.
|
||||
|
||||
"""
|
||||
for group_id in group_ids:
|
||||
|
|
@ -274,8 +275,10 @@ def validate_groups(group_ids, mapping_id, identity_api):
|
|||
backend
|
||||
:type identity_api: identity.Manager
|
||||
|
||||
:raises: exception.MappedGroupNotFound
|
||||
:raises: exception.MissingGroups
|
||||
:raises keystone.exception.MappedGroupNotFound: If the group returned by
|
||||
mapping was not found in the backend.
|
||||
:raises keystone.exception.MissingGroups: If ``group_ids`` cardinality
|
||||
is 0.
|
||||
|
||||
"""
|
||||
validate_groups_cardinality(group_ids, mapping_id)
|
||||
|
|
@ -320,7 +323,7 @@ def transform_to_group_ids(group_names, mapping_id,
|
|||
|
||||
:returns: generator object with group ids
|
||||
|
||||
:raises: excepton.MappedGroupNotFound: in case asked group doesn't
|
||||
:raises keystone.exception.MappedGroupNotFound: in case asked group doesn't
|
||||
exist in the backend.
|
||||
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -1173,7 +1173,7 @@ class IdentityDriverV8(object):
|
|||
def authenticate(self, user_id, password):
|
||||
"""Authenticate a given user and password.
|
||||
:returns: user_ref
|
||||
:raises: AssertionError
|
||||
:raises AssertionError: If user or password is invalid.
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
||||
|
|
@ -1183,7 +1183,7 @@ class IdentityDriverV8(object):
|
|||
def create_user(self, user_id, user):
|
||||
"""Creates a new user.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises keystone.exception.Conflict: If a duplicate user exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1218,7 +1218,7 @@ class IdentityDriverV8(object):
|
|||
"""Get a user by ID.
|
||||
|
||||
:returns: user_ref
|
||||
:raises: keystone.exception.UserNotFound
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1227,8 +1227,8 @@ class IdentityDriverV8(object):
|
|||
def update_user(self, user_id, user):
|
||||
"""Updates an existing user.
|
||||
|
||||
:raises: keystone.exception.UserNotFound,
|
||||
keystone.exception.Conflict
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
:raises keystone.exception.Conflict: If a duplicate user exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1237,8 +1237,8 @@ class IdentityDriverV8(object):
|
|||
def add_user_to_group(self, user_id, group_id):
|
||||
"""Adds a user to a group.
|
||||
|
||||
:raises: keystone.exception.UserNotFound,
|
||||
keystone.exception.GroupNotFound
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
:raises keystone.exception.GroupNotFound: If the group doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1247,8 +1247,8 @@ class IdentityDriverV8(object):
|
|||
def check_user_in_group(self, user_id, group_id):
|
||||
"""Checks if a user is a member of a group.
|
||||
|
||||
:raises: keystone.exception.UserNotFound,
|
||||
keystone.exception.GroupNotFound
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
:raises keystone.exception.GroupNotFound: If the group doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1257,7 +1257,7 @@ class IdentityDriverV8(object):
|
|||
def remove_user_from_group(self, user_id, group_id):
|
||||
"""Removes a user from a group.
|
||||
|
||||
:raises: keystone.exception.NotFound
|
||||
:raises keystone.exception.NotFound: If the entity not found.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1266,7 +1266,7 @@ class IdentityDriverV8(object):
|
|||
def delete_user(self, user_id):
|
||||
"""Deletes an existing user.
|
||||
|
||||
:raises: keystone.exception.UserNotFound
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1276,7 +1276,7 @@ class IdentityDriverV8(object):
|
|||
"""Get a user by name.
|
||||
|
||||
:returns: user_ref
|
||||
:raises: keystone.exception.UserNotFound
|
||||
:raises keystone.exception.UserNotFound: If the user doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1287,7 +1287,7 @@ class IdentityDriverV8(object):
|
|||
def create_group(self, group_id, group):
|
||||
"""Creates a new group.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises keystone.exception.Conflict: If a duplicate group exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1322,7 +1322,7 @@ class IdentityDriverV8(object):
|
|||
"""Get a group by ID.
|
||||
|
||||
:returns: group_ref
|
||||
:raises: keystone.exception.GroupNotFound
|
||||
:raises keystone.exception.GroupNotFound: If the group doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1332,7 +1332,7 @@ class IdentityDriverV8(object):
|
|||
"""Get a group by name.
|
||||
|
||||
:returns: group_ref
|
||||
:raises: keystone.exception.GroupNotFound
|
||||
:raises keystone.exception.GroupNotFound: If the group doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1341,8 +1341,8 @@ class IdentityDriverV8(object):
|
|||
def update_group(self, group_id, group):
|
||||
"""Updates an existing group.
|
||||
|
||||
:raises: keystone.exceptionGroupNotFound,
|
||||
keystone.exception.Conflict
|
||||
:raises keystone.exception.GroupNotFound: If the group doesn't exist.
|
||||
:raises keystone.exception.Conflict: If a duplicate group exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -1351,7 +1351,7 @@ class IdentityDriverV8(object):
|
|||
def delete_group(self, group_id):
|
||||
"""Deletes an existing group.
|
||||
|
||||
:raises: keystone.exception.GroupNotFound
|
||||
:raises keystone.exception.GroupNotFound: If the group doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ def enforce(credentials, action, target, do_raise=True):
|
|||
creation this should be a dictionary representing the
|
||||
location of the object e.g. {'project_id':
|
||||
object.project_id}
|
||||
:raises: `exception.Forbidden` if verification fails.
|
||||
:raises keystone.exception.Forbidden: If verification fails.
|
||||
|
||||
Actions should be colon separated for clarity. For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ class PolicyDriverV8(object):
|
|||
def create_policy(self, policy_id, policy):
|
||||
"""Store a policy blob.
|
||||
|
||||
:raises: keystone.exception.Conflict
|
||||
:raises keystone.exception.Conflict: If a duplicate policy exists.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -114,7 +114,7 @@ class PolicyDriverV8(object):
|
|||
def get_policy(self, policy_id):
|
||||
"""Retrieve a specific policy blob.
|
||||
|
||||
:raises: keystone.exception.PolicyNotFound
|
||||
:raises keystone.exception.PolicyNotFound: If the policy doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -123,7 +123,7 @@ class PolicyDriverV8(object):
|
|||
def update_policy(self, policy_id, policy):
|
||||
"""Update a policy blob.
|
||||
|
||||
:raises: keystone.exception.PolicyNotFound
|
||||
:raises keystone.exception.PolicyNotFound: If the policy doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -132,7 +132,7 @@ class PolicyDriverV8(object):
|
|||
def delete_policy(self, policy_id):
|
||||
"""Remove a policy blob.
|
||||
|
||||
:raises: keystone.exception.PolicyNotFound
|
||||
:raises keystone.exception.PolicyNotFound: If the policy doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
|
|||
|
|
@ -1474,8 +1474,8 @@ class DomainConfigDriverV8(object):
|
|||
|
||||
:param type: type of registration
|
||||
:returns: domain_id of who is registered.
|
||||
:raises: keystone.exception.ConfigRegistrationNotFound: nobody is
|
||||
registered.
|
||||
:raises keystone.exception.ConfigRegistrationNotFound: If nobody is
|
||||
registered.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
|
|||
|
|
@ -220,7 +220,7 @@ class Manager(manager.Manager):
|
|||
differences between v2 and v3. The checked values
|
||||
are a subset of the attributes of model.TokenEvent
|
||||
|
||||
:raises exception.TokenNotFound: if the token is invalid
|
||||
:raises keystone.exception.TokenNotFound: If the token is invalid.
|
||||
|
||||
"""
|
||||
if self._get_revoke_tree().is_revoked(token_values):
|
||||
|
|
|
|||
|
|
@ -240,7 +240,7 @@ class TokenDriverV8(object):
|
|||
:param token_id: identity of the token
|
||||
:type token_id: string
|
||||
:returns: token_ref
|
||||
:raises: keystone.exception.TokenNotFound
|
||||
:raises keystone.exception.TokenNotFound: If the token doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -276,7 +276,7 @@ class TokenDriverV8(object):
|
|||
:param token_id: identity of the token
|
||||
:type token_id: string
|
||||
:returns: None.
|
||||
:raises: keystone.exception.TokenNotFound
|
||||
:raises keystone.exception.TokenNotFound: If the token doesn't exist.
|
||||
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
|
@ -304,7 +304,7 @@ class TokenDriverV8(object):
|
|||
:param consumer_id: identity of the consumer
|
||||
:type consumer_id: string
|
||||
:returns: The tokens that have been deleted.
|
||||
:raises: keystone.exception.TokenNotFound
|
||||
:raises keystone.exception.TokenNotFound: If the token doesn't exist.
|
||||
|
||||
"""
|
||||
if not CONF.token.revoke_by_id:
|
||||
|
|
|
|||
|
|
@ -288,7 +288,7 @@ class V3TokenDataHelper(object):
|
|||
:domain_id: domain ID to scope to
|
||||
:user_id: user ID
|
||||
|
||||
:raises: exception.Unauthorized - when no roles were found for a
|
||||
:raises keystone.exception.Unauthorized: when no roles were found for a
|
||||
(group_ids, project_id) or (group_ids, domain_id) pairs.
|
||||
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -179,7 +179,7 @@ class Manager(manager.Manager):
|
|||
def delete_trust(self, trust_id, initiator=None):
|
||||
"""Remove a trust.
|
||||
|
||||
:raises: keystone.exception.TrustNotFound
|
||||
:raises keystone.exception.TrustNotFound: If the trust doesn't exist.
|
||||
|
||||
Recursively remove given and redelegated trusts
|
||||
"""
|
||||
|
|
@ -247,8 +247,9 @@ class TrustDriverV8(object):
|
|||
"""Consume one use when a trust was created with a limitation on its
|
||||
uses, provided there are still uses available.
|
||||
|
||||
:raises: keystone.exception.TrustUseLimitReached,
|
||||
keystone.exception.TrustNotFound
|
||||
:raises keystone.exception.TrustUseLimitReached: If no remaining uses
|
||||
for trust.
|
||||
:raises keystone.exception.TrustNotFound: If the trust doesn't exist.
|
||||
"""
|
||||
raise exception.NotImplemented() # pragma: no cover
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue