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
This commit is contained in:
@@ -66,3 +66,4 @@ Current Library APIs
|
|||||||
library/rest_client
|
library/rest_client
|
||||||
library/utils
|
library/utils
|
||||||
library/api_microversion_testing
|
library/api_microversion_testing
|
||||||
|
library/auth
|
||||||
|
@@ -180,7 +180,7 @@ class AuthProvider(object):
|
|||||||
:param headers: HTTP headers of the request
|
:param headers: HTTP headers of the request
|
||||||
:param body: HTTP body in case of POST / PUT
|
:param body: HTTP body in case of POST / PUT
|
||||||
:param filters: select a base URL out of the catalog
|
: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)
|
orig_req = dict(url=url, headers=headers, body=body)
|
||||||
|
|
||||||
@@ -224,6 +224,7 @@ class AuthProvider(object):
|
|||||||
Configure auth provider to provide alt authentication data
|
Configure auth provider to provide alt authentication data
|
||||||
on a part of the *next* auth_request. If credentials are None,
|
on a part of the *next* auth_request. If credentials are None,
|
||||||
set invalid data.
|
set invalid data.
|
||||||
|
|
||||||
:param request_part: request part to contain invalid auth: url,
|
:param request_part: request part to contain invalid auth: url,
|
||||||
headers, body
|
headers, body
|
||||||
:param auth_data: alternative auth_data from which to get the
|
:param auth_data: alternative auth_data from which to get the
|
||||||
@@ -370,16 +371,19 @@ class KeystoneV2AuthProvider(KeystoneAuthProvider):
|
|||||||
"""Base URL from catalog
|
"""Base URL from catalog
|
||||||
|
|
||||||
:param filters: Used to filter results
|
:param filters: Used to filter results
|
||||||
Filters can be:
|
|
||||||
- service: service type name such as compute, image, etc.
|
Filters can be:
|
||||||
- region: service region name
|
|
||||||
- name: service name, only if service exists
|
- service: service type name such as compute, image, etc.
|
||||||
- endpoint_type: type of endpoint such as
|
- region: service region name
|
||||||
adminURL, publicURL, internalURL
|
- name: service name, only if service exists
|
||||||
- api_version: the version of api used to replace catalog version
|
- endpoint_type: type of endpoint such as
|
||||||
- skip_path: skips the suffix path of the url and uses base URL
|
adminURL, publicURL, internalURL
|
||||||
:rtype string
|
- api_version: the version of api used to replace catalog version
|
||||||
:return url with filters applied
|
- 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:
|
if auth_data is None:
|
||||||
auth_data = self.get_auth()
|
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.
|
'identity', we can use the original auth URL to build the base_url.
|
||||||
|
|
||||||
:param filters: Used to filter results
|
:param filters: Used to filter results
|
||||||
Filters can be:
|
|
||||||
- service: service type name such as compute, image, etc.
|
Filters can be:
|
||||||
- region: service region name
|
|
||||||
- name: service name, only if service exists
|
- service: service type name such as compute, image, etc.
|
||||||
- endpoint_type: type of endpoint such as
|
- region: service region name
|
||||||
adminURL, publicURL, internalURL
|
- name: service name, only if service exists
|
||||||
- api_version: the version of api used to replace catalog version
|
- endpoint_type: type of endpoint such as
|
||||||
- skip_path: skips the suffix path of the url and uses base URL
|
adminURL, publicURL, internalURL
|
||||||
:rtype string
|
- api_version: the version of api used to replace catalog version
|
||||||
:return url with filters applied
|
- 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:
|
if auth_data is None:
|
||||||
auth_data = self.get_auth()
|
auth_data = self.get_auth()
|
||||||
|
Reference in New Issue
Block a user