Merge "auto-generate object docs"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
5cc4d5b530
|
|
@ -2,149 +2,25 @@
|
||||||
container
|
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
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
.. code:: bash
|
:command: container list
|
||||||
|
|
||||||
openstack container create
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
<container-name> [<container-name> ...]
|
:command: container save
|
||||||
|
|
||||||
.. describe:: <container-name>
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
|
:command: container set
|
||||||
|
|
||||||
New container name(s)
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
|
:command: container show
|
||||||
|
|
||||||
container delete
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
----------------
|
:command: container unset
|
||||||
|
|
||||||
Delete container
|
|
||||||
|
|
||||||
.. program:: container delete
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack container delete
|
|
||||||
[-r] | [--recursive]
|
|
||||||
<container> [<container> ...]
|
|
||||||
|
|
||||||
.. option:: --recursive, -r
|
|
||||||
|
|
||||||
Recursively delete objects in container before container delete
|
|
||||||
|
|
||||||
.. describe:: <container>
|
|
||||||
|
|
||||||
Container(s) to delete
|
|
||||||
|
|
||||||
container list
|
|
||||||
--------------
|
|
||||||
|
|
||||||
List containers
|
|
||||||
|
|
||||||
.. program:: container list
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack container list
|
|
||||||
[--prefix <prefix>]
|
|
||||||
[--marker <marker>]
|
|
||||||
[--end-marker <end-marker>]
|
|
||||||
[--limit <num-containers>]
|
|
||||||
[--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 <num-containers>
|
|
||||||
|
|
||||||
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
|
|
||||||
<container>
|
|
||||||
|
|
||||||
.. describe:: <container>
|
|
||||||
|
|
||||||
Container to save
|
|
||||||
|
|
||||||
container set
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Set container properties
|
|
||||||
|
|
||||||
.. program:: container set
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack container set
|
|
||||||
[--property <key=value> [...] ]
|
|
||||||
<container>
|
|
||||||
|
|
||||||
.. option:: --property <key=value>
|
|
||||||
|
|
||||||
Set a property on this container (repeat option to set multiple properties)
|
|
||||||
|
|
||||||
.. describe:: <container>
|
|
||||||
|
|
||||||
Container to modify
|
|
||||||
|
|
||||||
container show
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Display container details
|
|
||||||
|
|
||||||
.. program:: container show
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack container show
|
|
||||||
<container>
|
|
||||||
|
|
||||||
.. describe:: <container>
|
|
||||||
|
|
||||||
Container to display
|
|
||||||
|
|
||||||
container unset
|
|
||||||
---------------
|
|
||||||
|
|
||||||
Unset container properties
|
|
||||||
|
|
||||||
.. program:: container unset
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack container unset
|
|
||||||
[--property <key>]
|
|
||||||
<container>
|
|
||||||
|
|
||||||
.. option:: --property <key>
|
|
||||||
|
|
||||||
Property to remove from container (repeat option to remove multiple properties)
|
|
||||||
|
|
||||||
.. describe:: <container>
|
|
||||||
|
|
||||||
Container to modify
|
|
||||||
|
|
|
||||||
|
|
@ -2,44 +2,14 @@
|
||||||
object store account
|
object store account
|
||||||
====================
|
====================
|
||||||
|
|
||||||
Object Storage v1
|
An **object store account** represents the top-level of the hierarchy that
|
||||||
|
is comprised of **containers** and **objects**. Applies to Object Storage v1.
|
||||||
|
|
||||||
object store account set
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
------------------------
|
:command: object store account set
|
||||||
|
|
||||||
Set account properties
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
|
:command: object store account show
|
||||||
|
|
||||||
.. program:: object store account set
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
.. code:: bash
|
:command: object store account unset
|
||||||
|
|
||||||
openstack object store account set
|
|
||||||
[--property <key=value> [...] ]
|
|
||||||
|
|
||||||
.. option:: --property <key=value>
|
|
||||||
|
|
||||||
Set a property on this account (repeat option to set multiple properties)
|
|
||||||
|
|
||||||
object store account show
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
Display account details
|
|
||||||
|
|
||||||
.. program:: object store account show
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack object store account show
|
|
||||||
|
|
||||||
object store account unset
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
Unset account properties
|
|
||||||
|
|
||||||
.. program:: object store account unset
|
|
||||||
.. code:: bash
|
|
||||||
|
|
||||||
openstack object store account unset
|
|
||||||
[--property <key>]
|
|
||||||
|
|
||||||
.. option:: --property <key>
|
|
||||||
|
|
||||||
Property to remove from account (repeat option to remove multiple properties)
|
|
||||||
|
|
|
||||||
|
|
@ -2,195 +2,26 @@
|
||||||
object
|
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
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
.. code:: bash
|
:command: object list
|
||||||
|
|
||||||
openstack object create
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
[--name <name>]
|
:command: object save
|
||||||
<container>
|
|
||||||
<filename> [<filename> ...]
|
|
||||||
|
|
||||||
.. 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>
|
.. autoprogram-cliff:: openstack.object_store.v1
|
||||||
|
:command: object unset
|
||||||
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
|
|
||||||
|
|
|
||||||
|
|
@ -281,4 +281,4 @@ autoprogram_cliff_application = 'openstack'
|
||||||
|
|
||||||
autoprogram_cliff_ignored = [
|
autoprogram_cliff_ignored = [
|
||||||
'--help', '--format', '--column', '--max-width', '--fit-width',
|
'--help', '--format', '--column', '--max-width', '--fit-width',
|
||||||
'--print-empty', '--prefix', '--noindent']
|
'--print-empty', '--prefix', '--noindent', '--quote']
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue