From 4d7b4efeb508f63afbb4b12b9a4506f9fb940d7e Mon Sep 17 00:00:00 2001
From: Steve Martinelli <s.martinelli@gmail.com>
Date: Thu, 17 Aug 2017 16:46:31 -0400
Subject: auto-generate object docs

Change-Id: I832eade2ddab754664e5f57b9764e524e655e616
---
 doc/source/cli/command-objects/object.rst | 201 +++---------------------------
 1 file changed, 16 insertions(+), 185 deletions(-)

(limited to 'doc/source/cli/command-objects/object.rst')

diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst
index 4cba38ee..8b328bd5 100644
--- a/doc/source/cli/command-objects/object.rst
+++ b/doc/source/cli/command-objects/object.rst
@@ -2,195 +2,26 @@
 object
 ======
 
-Object Storage v1
+An **object** stores data content, such as documents, images, and so on. They
+can also store custom metadata with an object. Applies to Object Storage v1.
 
-object create
--------------
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object create
 
-Upload object to container
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object delete
 
-.. program:: object create
-.. code:: bash
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object list
 
-    openstack object create
-        [--name <name>]
-        <container>
-        <filename> [<filename> ...]
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object save
 
-.. option:: --name <name>
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object set
 
-    Upload a file and rename it. Can only be used when uploading a single object
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object show
 
-.. describe:: <container>
-
-    Container for new object
-
-.. describe:: <filename>
-
-    Local filename(s) to upload
-
-object delete
--------------
-
-Delete object from container
-
-.. program:: object delete
-.. code:: bash
-
-    openstack object delete
-        <container>
-        <object> [<object> ...]
-
-.. describe:: <container>
-
-    Delete object(s) from <container>
-
-.. describe:: <object>
-
-    Object(s) to delete
-
-object list
------------
-
-List objects
-
-.. program object list
-.. code:: bash
-
-    openstack object list
-        [--prefix <prefix>]
-        [--delimiter <delimiter>]
-        [--marker <marker>]
-        [--end-marker <end-marker>]
-        [--limit <num-objects>]
-        [--long]
-        [--all]
-        <container>
-
-.. option:: --prefix <prefix>
-
-    Filter list using <prefix>
-
-.. option:: --delimiter <delimiter>
-
-    Roll up items with <delimiter>
-
-.. option:: --marker <marker>
-
-    Anchor for paging
-
-.. option:: --end-marker <end-marker>
-
-    End anchor for paging
-
-.. option:: --limit <num-objects>
-
-    Limit number of objects returned
-
-.. option:: --long
-
-    List additional fields in output
-
-.. option:: --all
-
-    List all objects in <container> (default is 10000)
-
-.. describe:: <container>
-
-    Container to list
-
-object save
------------
-
-Save object locally
-
-.. program:: object save
-.. code:: bash
-
-    openstack object save
-        [--file <filename>]
-        <container>
-        <object>
-
-.. option:: --file <filename>
-
-    Destination filename (defaults to object name);
-    using - as the filename will print the file to stdout
-
-.. describe:: <container>
-
-    Download <object> from <container>
-
-.. describe:: <object>
-
-    Object to save
-
-object set
-----------
-
-Set object properties
-
-.. program:: object set
-.. code:: bash
-
-    openstack object set
-        [--property <key=value> [...] ]
-        <container>
-        <object>
-
-.. option:: --property <key=value>
-
-    Set a property on this object (repeat option to set multiple properties)
-
-.. describe:: <container>
-
-    Modify <object> from <container>
-
-.. describe:: <object>
-
-    Object to modify
-
-object show
------------
-
-Display object details
-
-.. program:: object show
-.. code:: bash
-
-    openstack object show
-        <container>
-        <object>
-
-.. describe:: <container>
-
-    Display <object> from <container>
-
-.. describe:: <object>
-
-    Object to display
-
-object unset
-------------
-
-Unset object properties
-
-.. program:: object unset
-.. code:: bash
-
-    openstack object unset
-        [--property <key>]
-        <container>
-        <object>
-
-.. option:: --property <key>
-
-    Property to remove from object (repeat option to remove multiple properties)
-
-.. describe:: <container>
-
-    Modify <object> from <container>
-
-.. describe:: <object>
-
-    Object to modify
+.. autoprogram-cliff:: openstack.object_store.v1
+   :command: object unset
-- 
cgit v1.2.1