Clean up document warnings

Change-Id: I20223a40f9a3866bb845898b159553637b0cfb55
This commit is contained in:
TerryHowe 2015-07-15 17:33:00 -06:00
parent f1da4ecd86
commit 8c51218a82
2 changed files with 14 additions and 9 deletions

View File

@ -41,23 +41,29 @@ class Instance(resource.Resource):
volume = resource.prop('volume')
def enable_root_user(self, session):
"""Enable login for the root user
"""Enable login for the root user.
This operation enables login from any host for the root user
and provides the user with a generated root password.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:returns: A dictionary with keys ``name`` and ``password`` specifying
the login credentials.
the login credentials.
"""
url = utils.urljoin(self.base_path, self.id, 'root')
resp = session.post(url, service=self.service).body
return resp['user']
def is_root_enabled(self, session):
"""Determine if root is enabled on an instance
"""Determine if root is enabled on an instance.
Determine if root is enabled on this particular instance.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:returns: ``True`` if root user is enabled for a specified database
instance or ``False`` otherwise.
instance or ``False`` otherwise.
"""
url = utils.urljoin(self.base_path, self.id, 'root')
resp = session.get(url, service=self.service).body

View File

@ -36,13 +36,12 @@ class Endpoint(resource.Resource):
#: following values:
#:
#: - `public`: intended for consumption by end users, generally on a
#: publicly available network interface
#:
#: publicly available network interface
#: - `internal`: not intended for consumption by end users, generally on an
#: unmetered internal network interface
#:
#: unmetered internal network interface
#: - `admin`: intended only for consumption by those needing administrative
#: access to the service, generally on a secure network interface
#: access to the service, generally on a secure network interface
#:
#: *Type: string*
interface = resource.prop('interface')
#: Represents the containing region of the service endpoint. *New in v3.2*