From 9a8b3d6dc64ee3464cf9108a02c2d046766e077e Mon Sep 17 00:00:00 2001 From: Nisha Yadav Date: Tue, 16 Aug 2016 20:00:15 +0530 Subject: [PATCH] Improve docs for v3 auth In preparation to add functional tests for v3 auth, this change proposes to detail the method docs, because the tests need to be based on them. Change-Id: Idc60cb077d7e403a47cf9d6ad72f9d1a215c3f3b Partial-Bug: #1330769 --- keystoneclient/v3/auth.py | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/keystoneclient/v3/auth.py b/keystoneclient/v3/auth.py index c228586f7..a1bf06476 100644 --- a/keystoneclient/v3/auth.py +++ b/keystoneclient/v3/auth.py @@ -20,14 +20,15 @@ class Project(base.Resource): Attributes: * id: a uuid that identifies the project - * name: project name - * description: project description - * enabled: boolean to indicate if project is enabled - * parent_id: a uuid representing this project's parent in hierarchy - * parents: a list or a structured dict containing the parents of this - project in the hierarchy - * subtree: a list or a structured dict containing the subtree of this - project in the hierarchy + * name: the name of the project + * description: a description of the project + * enabled: determines whether the project is enabled + * parent_id: a uuid that identifies the specified project's parent + in hierarchy + * parents: a list or a structured dict containing the parents of the + specified project in the hierarchy + * subtree: a list or a structured dict containing the subtree of the + specified project in the hierarchy """ @@ -37,6 +38,9 @@ class Domain(base.Resource): Attributes: * id: a uuid that identifies the domain + * name: the name of the domain + * description: a description of the domain + * enabled: determines whether the domain is enabled """ @@ -46,7 +50,7 @@ class Domain(base.Resource): class AuthManager(base.Manager): """Retrieve auth context specific information. - The information returned by the /auth routes are entirely dependant on the + The information returned by the auth routes is entirely dependant on the authentication information provided by the user. """ @@ -54,7 +58,12 @@ class AuthManager(base.Manager): _DOMAINS_URL = '/auth/domains' def projects(self): - """List projects that this token can be rescoped to.""" + """List projects that the specified token can be rescoped to. + + :returns: a list of projects. + :rtype: list of :class:`keystoneclient.v3.projects.Project` + + """ try: return self._list(self._PROJECTS_URL, 'projects', @@ -67,7 +76,12 @@ class AuthManager(base.Manager): endpoint_filter=endpoint_filter) def domains(self): - """List Domains that this token can be rescoped to.""" + """List Domains that the specified token can be rescoped to. + + :returns: a list of domains. + :rtype: list of :class:`keystoneclient.v3.domains.Domain`. + + """ try: return self._list(self._DOMAINS_URL, 'domains',