openstack/deb-python-openstacksdk
Code Issues Proposed changes

Reorganize object_store docs

Browse Source 
This change organizes the object_store docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.

Change-Id: I495770aaaa1bf97dd728339b3dde42ad1770e384
This commit is contained in:
Brian Curtin
2017-02-28 13:29:47 -05:00
parent adfbf65c14
commit 650c8a5b44
1 changed files with 36 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/source/users/proxies/object_store.rst
View File

@@ -11,5 +11,40 @@ The Object Store Class
The Object Store high-level interface is exposed as the ``object_store``
object on :class:`~openstack.connection.Connection` objects.
Account Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.object_store.v1._proxy.Proxy
:members:
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_account_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.set_account_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_account_metadata
Container Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.object_store.v1._proxy.Proxy
.. automethod:: openstack.object_store.v1._proxy.Proxy.create_container
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_container
.. automethod:: openstack.object_store.v1._proxy.Proxy.containers
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_container_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.set_container_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_container_metadata
Object Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.object_store.v1._proxy.Proxy
.. automethod:: openstack.object_store.v1._proxy.Proxy.upload_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.download_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.copy_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_object
.. automethod:: openstack.object_store.v1._proxy.Proxy.objects
.. automethod:: openstack.object_store.v1._proxy.Proxy.get_object_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.set_object_metadata
.. automethod:: openstack.object_store.v1._proxy.Proxy.delete_object_metadata