Merge "Command object docs: container, object"

Author: Jenkins

doc/source/command-objects/container.rst

@@ -0,0 +1,105 @@
+=========
+container
+=========
+
+Object Store v1
+
+container create
+----------------
+
+Create new container
+
+.. program:: container create
+.. code:: bash
+
+    os container create
+        <container-name> [<container-name> ...]
+
+.. option:: <container-name>
+
+    New container name(s)
+
+container delete
+----------------
+
+Delete container
+
+.. program:: container delete
+.. code:: bash
+
+    os container delete
+        <container> [<container> ...]
+
+.. option:: <container>
+
+    Container(s) to delete
+
+container list
+--------------
+
+List containers
+
+.. program:: container list
+.. code::bash
+
+    os container list
+        [--prefix <prefix>]
+        [--marker <marker>]
+        [--end-marker <end-marker>]
+        [--limit <limit>]
+        [--long]
+        [--all]
+
+.. option:: --prefix <prefix>
+
+    Filter list using <prefix>
+
+.. option:: --marker <marker>
+
+    Anchor for paging
+
+.. option:: --end-marker <end-marker>
+
+    End anchor for paging
+
+.. option:: --limit <limit>
+
+    Limit the number of containers returned
+
+.. option:: --long
+
+    List additional fields in output
+
+.. options:: --all
+
+    List all containers (default is 10000)
+
+container save
+--------------
+
+Save container contents locally
+
+.. program:: container save
+.. code:: bash
+
+    os container save
+        <container>
+
+.. option:: <container>
+
+    Container to save
+
+container show
+--------------
+
+Show container details
+
+.. program:: container show
+.. code:: bash
+
+    os container show
+        [<container>]
+
+.. option:: <container>
+
+    Container to display

doc/source/command-objects/object.rst

@@ -0,0 +1,140 @@
+======
+object
+======
+
+Object Store v1
+
+object create
+-------------
+
+Upload object to container
+
+.. program:: object create
+.. code:: bash
+
+    os object create
+        <container>
+        <filename> [<filename> ...]
+
+.. option:: <container>
+
+    Container for new object
+
+.. option:: <filename>
+
+    Local filename(s) to upload
+
+object delete
+-------------
+
+Delete object from container
+
+.. program:: object delete
+.. code:: bash
+
+    os object delete
+        <container>
+        <object> [<object> ...]
+
+.. option:: <container>
+
+    Delete object(s) from <container>
+
+.. option:: <object>
+
+    Object(s) to delete
+
+list object
+-----------
+
+List objects
+
+.. program object list
+.. code:: bash
+
+    os object list
+        [--prefix <prefix>]
+        [--delimiter <delimiter>]
+        [--marker <marker>]
+        [--end-marker <end-marker>]
+        [--limit <limit>]
+        [--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 <limit>
+
+    Limit number of objects returned
+
+.. option:: --long
+
+    List additional fields in output
+
+.. options:: --all
+
+    List all objects in <container> (default is 10000)
+
+.. option:: <container>
+
+    Container to list
+
+object save
+-----------
+
+Save object locally
+
+.. program:: object save
+.. code:: bash
+
+    os object save
+        [--file <filename>]
+        [<container>]
+        [<object>]
+
+.. option:: --file <filename>
+
+    Destination filename (defaults to object name)
+
+.. option:: <container>
+
+    Download <object> from <container>
+
+.. option:: <object>
+
+    Object to save
+
+object show
+-----------
+
+Show object details
+
+.. program:: object show
+.. code:: bash
+
+    os object show
+        <container>
+        <object>
+
+.. option:: <container>
+
+    Display <object> from <container>
+
+.. option:: <object>
+
+    Object to display

openstackclient/object/v1/container.py

@@ -27,17 +27,17 @@
 
 
 class CreateContainer(lister.Lister):
-    """Create a container"""
+    """Create new container"""
 
     log = logging.getLogger(__name__ + '.CreateContainer')
 
     def get_parser(self, prog_name):
         parser = super(CreateContainer, self).get_parser(prog_name)
         parser.add_argument(
             'containers',
-            metavar='<container>',
+            metavar='<container-name>',
             nargs="+",
-            help='Container name(s) to create',
+            help='New container name(s)',
         )
         return parser
 
@@ -60,7 +60,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteContainer(command.Command):
-    """Delete a container"""
+    """Delete container"""
 
     log = logging.getLogger(__name__ + '.DeleteContainer')
 
@@ -70,7 +70,7 @@ def get_parser(self, prog_name):
             'containers',
             metavar='<container>',
             nargs="+",
-            help='Container name(s) to delete',
+            help='Container(s) to delete',
         )
         return parser
 
@@ -157,7 +157,7 @@ def take_action(self, parsed_args):
 
 
 class SaveContainer(command.Command):
-    """Save the contents of a container locally"""
+    """Save container contents locally"""
 
     log = logging.getLogger(__name__ + ".SaveContainer")
 
@@ -166,7 +166,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'container',
             metavar='<container>',
-            help='Container name to save',
+            help='Container to save',
         )
         return parser
 
@@ -179,7 +179,7 @@ def take_action(self, parsed_args):
 
 
 class ShowContainer(show.ShowOne):
-    """Show container information"""
+    """Show container details"""
 
     log = logging.getLogger(__name__ + '.ShowContainer')
 
@@ -188,7 +188,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'container',
             metavar='<container>',
-            help='Container name to display',
+            help='Container to display',
         )
         return parser