From 4d7b4efeb508f63afbb4b12b9a4506f9fb940d7e Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 17 Aug 2017 16:46:31 -0400 Subject: auto-generate object docs Change-Id: I832eade2ddab754664e5f57b9764e524e655e616 --- doc/source/cli/command-objects/container.rst | 154 +++------------------------ 1 file changed, 15 insertions(+), 139 deletions(-) (limited to 'doc/source/cli/command-objects/container.rst') diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst index e68955ad..83deeb81 100644 --- a/doc/source/cli/command-objects/container.rst +++ b/doc/source/cli/command-objects/container.rst @@ -2,149 +2,25 @@ container ========= -Object Storage v1 +A **container** defines a namespace for **objects**. Applies to Object Storage v1 -container create ----------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container create -Create new container +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container delete -.. program:: container create -.. code:: bash +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container list - openstack container create - [ ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container save -.. describe:: +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container set - New container name(s) +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container show -container delete ----------------- - -Delete container - -.. program:: container delete -.. code:: bash - - openstack container delete - [-r] | [--recursive] - [ ...] - -.. option:: --recursive, -r - - Recursively delete objects in container before container delete - -.. describe:: - - Container(s) to delete - -container list --------------- - -List containers - -.. program:: container list -.. code:: bash - - openstack container list - [--prefix ] - [--marker ] - [--end-marker ] - [--limit ] - [--long] - [--all] - -.. option:: --prefix - - Filter list using - -.. option:: --marker - - Anchor for paging - -.. option:: --end-marker - - End anchor for paging - -.. option:: --limit - - Limit the number of containers returned - -.. option:: --long - - List additional fields in output - -.. option:: --all - - List all containers (default is 10000) - -container save --------------- - -Save container contents locally - -.. program:: container save -.. code:: bash - - openstack container save - - -.. describe:: - - Container to save - -container set -------------- - -Set container properties - -.. program:: container set -.. code:: bash - - openstack container set - [--property [...] ] - - -.. option:: --property - - Set a property on this container (repeat option to set multiple properties) - -.. describe:: - - Container to modify - -container show --------------- - -Display container details - -.. program:: container show -.. code:: bash - - openstack container show - - -.. describe:: - - Container to display - -container unset ---------------- - -Unset container properties - -.. program:: container unset -.. code:: bash - - openstack container unset - [--property ] - - -.. option:: --property - - Property to remove from container (repeat option to remove multiple properties) - -.. describe:: - - Container to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container unset -- cgit v1.2.1