From eb11b259a728778183c669e9813bf94617c9d98b Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Fri, 10 Jun 2016 10:40:02 +0900 Subject: [PATCH] Fix docs warnings of auth This commit fixes some docs auth warnings[1] such as * Field list ends without a blank line; unexpected unindent * Unexpected indentation * Block quote ends without a blank line; unexpected unindent * document isn't included in any toctree [1]: http://logs.openstack.org/79/327579/1/check/gate-tempest-docs/fb1e2bd/console.html#_2016-06-09_22_25_45_335 Change-Id: I78b52a7c737c9fae12040321861aaeef2e3513cb --- doc/source/library.rst | 1 + tempest/lib/auth.py | 49 ++++++++++++++++++++++++------------------ 2 files changed, 29 insertions(+), 21 deletions(-) diff --git a/doc/source/library.rst b/doc/source/library.rst index a89512c670..6a2fb830b5 100644 --- a/doc/source/library.rst +++ b/doc/source/library.rst @@ -66,3 +66,4 @@ Current Library APIs library/rest_client library/utils library/api_microversion_testing + library/auth diff --git a/tempest/lib/auth.py b/tempest/lib/auth.py index 9c5ad8ecad..217c1ceeb6 100644 --- a/tempest/lib/auth.py +++ b/tempest/lib/auth.py @@ -180,7 +180,7 @@ class AuthProvider(object): :param headers: HTTP headers of the request :param body: HTTP body in case of POST / PUT :param filters: select a base URL out of the catalog - :returns a Tuple (url, headers, body) + :return: a Tuple (url, headers, body) """ orig_req = dict(url=url, headers=headers, body=body) @@ -224,6 +224,7 @@ class AuthProvider(object): Configure auth provider to provide alt authentication data on a part of the *next* auth_request. If credentials are None, set invalid data. + :param request_part: request part to contain invalid auth: url, headers, body :param auth_data: alternative auth_data from which to get the @@ -370,16 +371,19 @@ class KeystoneV2AuthProvider(KeystoneAuthProvider): """Base URL from catalog :param filters: Used to filter results - Filters can be: - - service: service type name such as compute, image, etc. - - region: service region name - - name: service name, only if service exists - - endpoint_type: type of endpoint such as - adminURL, publicURL, internalURL - - api_version: the version of api used to replace catalog version - - skip_path: skips the suffix path of the url and uses base URL - :rtype string - :return url with filters applied + + Filters can be: + + - service: service type name such as compute, image, etc. + - region: service region name + - name: service name, only if service exists + - endpoint_type: type of endpoint such as + adminURL, publicURL, internalURL + - api_version: the version of api used to replace catalog version + - skip_path: skips the suffix path of the url and uses base URL + + :rtype: string + :return: url with filters applied """ if auth_data is None: auth_data = self.get_auth() @@ -499,16 +503,19 @@ class KeystoneV3AuthProvider(KeystoneAuthProvider): 'identity', we can use the original auth URL to build the base_url. :param filters: Used to filter results - Filters can be: - - service: service type name such as compute, image, etc. - - region: service region name - - name: service name, only if service exists - - endpoint_type: type of endpoint such as - adminURL, publicURL, internalURL - - api_version: the version of api used to replace catalog version - - skip_path: skips the suffix path of the url and uses base URL - :rtype string - :return url with filters applied + + Filters can be: + + - service: service type name such as compute, image, etc. + - region: service region name + - name: service name, only if service exists + - endpoint_type: type of endpoint such as + adminURL, publicURL, internalURL + - api_version: the version of api used to replace catalog version + - skip_path: skips the suffix path of the url and uses base URL + + :rtype: string + :return: url with filters applied """ if auth_data is None: auth_data = self.get_auth()