openstack/openstacksdk
Code Issues Proposed changes

Fix documentation warnings

Browse Source 
Change-Id: Ib9e3652764f923bcf4804d1af4064d3034c96f7e
This commit is contained in:
Terry Howe 2015-05-20 18:20:46 -07:00
parent ae45a0726c
commit e074646d0d
3 changed files with 79 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/users/proxies/keystore.rst
View File

@ -6,7 +6,7 @@ For details on how to use keystore, see :doc:`/users/userguides/keystore`
.. automodule:: openstack.keystore.v1._proxy .. automodule:: openstack.keystore.v1._proxy
The Keystore Class The Keystore Class
------------- ------------------
The keystore high-level interface is available through the ``keystore`` The keystore high-level interface is available through the ``keystore``
member of a :class:`~openstack.connection.Connection` object. The member of a :class:`~openstack.connection.Connection` object. The

59
openstack/compute/v2/_proxy.py
View File

@ -95,7 +95,7 @@ class Proxy(proxy.BaseProxy):
:class:`~openstack.compute.v2.flavor.FlavorDetail` objects, :class:`~openstack.compute.v2.flavor.FlavorDetail` objects,
otherwise :class:`~openstack.compute.v2.flavor.Flavor`. otherwise :class:`~openstack.compute.v2.flavor.Flavor`.
*Default: ``True``* *Default: ``True``*
:param kwargs **query: Optional query parameters to be sent to limit :param kwargs \*\*query: Optional query parameters to be sent to limit
the flavors being returned. the flavors being returned.
:returns: A generator of flavor objects :returns: A generator of flavor objects
@ -158,7 +158,7 @@ class Proxy(proxy.BaseProxy):
:class:`~openstack.compute.v2.image.ImageDetail` objects, :class:`~openstack.compute.v2.image.ImageDetail` objects,
otherwise :class:`~openstack.compute.v2.image.Image`. otherwise :class:`~openstack.compute.v2.image.Image`.
*Default: ``True``* *Default: ``True``*
:param kwargs **query: Optional query parameters to be sent to limit :param kwargs \*\*query: Optional query parameters to be sent to limit
the flavors being returned. the flavors being returned.
:returns: A generator of image objects :returns: A generator of image objects
@ -299,45 +299,32 @@ class Proxy(proxy.BaseProxy):
will be returned. The default, ``True``, will cause will be returned. The default, ``True``, will cause
:class:`~openstack.compute.v2.server.ServerDetail` :class:`~openstack.compute.v2.server.ServerDetail`
instances to be returned. instances to be returned.
:param kwargs **query: Optional query parameters to be sent to limit :param kwargs \*\*query: Optional query parameters to be sent to limit
the servers being returned. the servers being returned. Available parameters include:
Available parameters include:
* changes_since: A time/date stamp for when * changes_since: A time/date stamp for when the server last changed
the server last changed
status. status.
* image: An image resource or ID. * image: An image resource or ID.
* flavor: A flavor resource or ID. * flavor: A flavor resource or ID.
* name: Name of the server as a string. * name: Name of the server as a string. Can be queried with
Can be queried with regular regular expressions. The regular expression
expressions. The regular expression ?name=bob returns both bob and bobb. If you must match on
?name=bob returns both bob and bobb. only bob, you can use a regular expression that
If you must match on only bob, matches the syntax of the underlying database server that
you can use a regular expression that is implemented for Compute, such as MySQL or PostgreSQL.
matches the syntax of the underlying * status: Value of the status of the server so that you can filter
database server that is implemented on "ACTIVE" for example.
for Compute, such as MySQL or
PostgreSQL.
* status: Value of the status of the server so
that you can filter on "ACTIVE" for
example.
* host: Name of the host as a string. * host: Name of the host as a string.
* limit: Requests a specified page size of * limit: Requests a specified page size of returned items from the
returned items from the query. query. Returns a number of items up to the specified
Returns a number of items up to the limit value. Use the limit parameter to make an initial
specified limit value. Use the limit limited request and use the ID of the last-seen item from
parameter to make an initial limited the response as the marker parameter value in a subsequent
request and use the ID of the limited request.
last-seen item from the response as * marker: Specifies the ID of the last-seen item. Use the limit
the marker parameter value in a parameter to make an initial limited request and use the
subsequent limited request. ID of the last-seen item from the response as the marker
* marker: Specifies the ID of the last-seen parameter value in a subsequent limited request.
item. Use the limit parameter to
make an initial limited request
and use the ID of the last-seen
item from the response as the
marker parameter value in a
subsequent limited request.
:returns: A generator of server instances. :returns: A generator of server instances.
""" """

79
openstack/network/v2/_proxy.py
View File

@ -418,13 +418,14 @@ class Proxy(proxy.BaseProxy):
def create_metering_label_rule(self, **attrs): def create_metering_label_rule(self, **attrs):
"""Create a new metering label rule from attributes """Create a new metering label rule from attributes
:param dict attrs: Keyword arguments which will be used to create :param dict attrs: Keyword arguments which will be used to create a
a :class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`, :class:`~openstack.network.v2.metering_label_rule.\
comprised of the properties on the MeteringLabelRule class. MeteringLabelRule`, comprised of the properties on
the MeteringLabelRule class.
:returns: The results of metering label rule creation :returns: The results of metering label rule creation
:rtype: :rtype: :class:`~openstack.network.v2.metering_label_rule.\
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule` MeteringLabelRule`
""" """
return self._create(metering_label_rule.MeteringLabelRule, **attrs) return self._create(metering_label_rule.MeteringLabelRule, **attrs)
@ -432,14 +433,13 @@ class Proxy(proxy.BaseProxy):
"""Delete a metering label rule """Delete a metering label rule
:param value: The value can be either the ID of a metering label rule :param value: The value can be either the ID of a metering label rule
or a or a :class:`~openstack.network.v2.metering_label_rule.\
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule` MeteringLabelRule` instance.
instance.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be raised
raised when the metering label rule does not exist. when the metering label rule does not exist. When set to ``True``,
When set to ``True``, no exception will be set when no exception will be set when attempting to delete a nonexistent
attempting to delete a nonexistent metering label rule. metering label rule.
:returns: ``None`` :returns: ``None``
""" """
@ -460,11 +460,12 @@ class Proxy(proxy.BaseProxy):
"""Get a single metering label rule """Get a single metering label rule
:param value: The value can be the ID of a metering label rule or a :param value: The value can be the ID of a metering label rule or a
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule` :class:`~openstack.network.v2.metering_label_rule.\
instance. MeteringLabelRule` instance.
:returns: One :returns: One
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule` :class:`~openstack.network.v2.metering_label_rule.\
MeteringLabelRule`
:raises: :class:`~openstack.exceptions.ResourceNotFound` :raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found. when no resource can be found.
""" """
@ -503,8 +504,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the Network class. comprised of the properties on the Network class.
:returns: The results of network creation :returns: The results of network creation
:rtype: :rtype: :class:`~openstack.network.v2.network.Network`
:class:`~openstack.network.v2.network.Network`
""" """
return self._create(network.Network, **attrs) return self._create(network.Network, **attrs)
@ -572,8 +572,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the Pool class. comprised of the properties on the Pool class.
:returns: The results of pool creation :returns: The results of pool creation
:rtype: :rtype: :class:`~openstack.network.v2.pool.Pool`
:class:`~openstack.network.v2.pool.Pool`
""" """
return self._create(pool.Pool, **attrs) return self._create(pool.Pool, **attrs)
@ -641,8 +640,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the PoolMember class. comprised of the properties on the PoolMember class.
:returns: The results of pool member creation :returns: The results of pool member creation
:rtype: :rtype: :class:`~openstack.network.v2.pool_member.PoolMember`
:class:`~openstack.network.v2.pool_member.PoolMember`
""" """
return self._create(pool_member.PoolMember, **attrs) return self._create(pool_member.PoolMember, **attrs)
@ -714,8 +712,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the Port class. comprised of the properties on the Port class.
:returns: The results of port creation :returns: The results of port creation
:rtype: :rtype: :class:`~openstack.network.v2.port.Port`
:class:`~openstack.network.v2.port.Port`
""" """
return self._create(port.Port, **attrs) return self._create(port.Port, **attrs)
@ -808,8 +805,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the Router class. comprised of the properties on the Router class.
:returns: The results of router creation :returns: The results of router creation
:rtype: :rtype: :class:`~openstack.network.v2.router.Router`
:class:`~openstack.network.v2.router.Router`
""" """
return self._create(router.Router, **attrs) return self._create(router.Router, **attrs)
@ -883,8 +879,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the SecurityGroup class. comprised of the properties on the SecurityGroup class.
:returns: The results of security group creation :returns: The results of security group creation
:rtype: :rtype: :class:`~openstack.network.v2.security_group.SecurityGroup`
:class:`~openstack.network.v2.security_group.SecurityGroup`
""" """
return self._create(security_group.SecurityGroup, **attrs) return self._create(security_group.SecurityGroup, **attrs)
@ -939,8 +934,7 @@ class Proxy(proxy.BaseProxy):
"""Update a security group """Update a security group
:param value: Either the id of a security group or a :param value: Either the id of a security group or a
:class:`~openstack.network.v2.security_group. :class:`~openstack.network.v2.security_group.SecurityGroup`
SecurityGroup`
instance. instance.
:attrs kwargs: The attributes to update on the security group :attrs kwargs: The attributes to update on the security group
represented by ``value``. represented by ``value``.
@ -977,13 +971,14 @@ class Proxy(proxy.BaseProxy):
def create_security_group_rule(self, **attrs): def create_security_group_rule(self, **attrs):
"""Create a new security group rule from attributes """Create a new security group rule from attributes
:param dict attrs: Keyword arguments which will be used to create :param dict attrs: Keyword arguments which will be used to create a
a :class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`, :class:`~openstack.network.v2.security_group_rule.
comprised of the properties on the SecurityGroupRule class. SecurityGroupRule`, comprised of the properties on the
SecurityGroupRule class.
:returns: The results of security group rule creation :returns: The results of security group rule creation
:rtype: :rtype: :class:`~openstack.network.v2.security_group_rule.\
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule` SecurityGroupRule`
""" """
return self._create(security_group_rule.SecurityGroupRule, **attrs) return self._create(security_group_rule.SecurityGroupRule, **attrs)
@ -991,9 +986,8 @@ class Proxy(proxy.BaseProxy):
"""Delete a security group rule """Delete a security group rule
:param value: The value can be either the ID of a security group rule :param value: The value can be either the ID of a security group rule
or a or a :class:`~openstack.network.v2.security_group_rule.
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule` SecurityGroupRule` instance.
instance.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the security group rule does not exist. raised when the security group rule does not exist.
@ -1019,11 +1013,11 @@ class Proxy(proxy.BaseProxy):
"""Get a single security group rule """Get a single security group rule
:param value: The value can be the ID of a security group rule or a :param value: The value can be the ID of a security group rule or a
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule` :class:`~openstack.network.v2.security_group_rule.\
instance. SecurityGroupRule` instance.
:returns: One :returns: :class:`~openstack.network.v2.security_group_rule.\
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule` SecurityGroupRule`
:raises: :class:`~openstack.exceptions.ResourceNotFound` :raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found. when no resource can be found.
""" """
@ -1062,8 +1056,7 @@ class Proxy(proxy.BaseProxy):
comprised of the properties on the Subnet class. comprised of the properties on the Subnet class.
:returns: The results of subnet creation :returns: The results of subnet creation
:rtype: :rtype: :class:`~openstack.network.v2.subnet.Subnet`
:class:`~openstack.network.v2.subnet.Subnet`
""" """
return self._create(subnet.Subnet, **attrs) return self._create(subnet.Subnet, **attrs)