Skip to content

Commit 4d7b4ef

Browse files
stevemarstevemar
committed
auto-generate object docs
Change-Id: I832eade2ddab754664e5f57b9764e524e655e616
1 parent 53bea90 commit 4d7b4ef

File tree

4 files changed

+40
-363
lines changed

4 files changed

+40
-363
lines changed

‎doc/source/cli/command-objects/container.rst‎

Lines changed: 15 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -2,149 +2,25 @@
22
container
33
=========
44

5-
Object Storage v1
5+
A **container** defines a namespace for **objects**. Applies to Object Storage v1
66

7-
container create
8-
----------------
7+
.. autoprogram-cliff:: openstack.object_store.v1
8+
:command: container create
99

10-
Create new container
10+
.. autoprogram-cliff:: openstack.object_store.v1
11+
:command: container delete
1112

12-
.. program:: container create
13-
.. code:: bash
13+
.. autoprogram-cliff:: openstack.object_store.v1
14+
:command: container list
1415

15-
openstack container create
16-
<container-name> [<container-name> ...]
16+
.. autoprogram-cliff:: openstack.object_store.v1
17+
:command: container save
1718

18-
.. describe:: <container-name>
19+
.. autoprogram-cliff:: openstack.object_store.v1
20+
:command: container set
1921

20-
New container name(s)
22+
.. autoprogram-cliff:: openstack.object_store.v1
23+
:command: container show
2124

22-
container delete
23-
----------------
24-
25-
Delete container
26-
27-
.. program:: container delete
28-
.. code:: bash
29-
30-
openstack container delete
31-
[-r] | [--recursive]
32-
<container> [<container> ...]
33-
34-
.. option:: --recursive, -r
35-
36-
Recursively delete objects in container before container delete
37-
38-
.. describe:: <container>
39-
40-
Container(s) to delete
41-
42-
container list
43-
--------------
44-
45-
List containers
46-
47-
.. program:: container list
48-
.. code:: bash
49-
50-
openstack container list
51-
[--prefix <prefix>]
52-
[--marker <marker>]
53-
[--end-marker <end-marker>]
54-
[--limit <num-containers>]
55-
[--long]
56-
[--all]
57-
58-
.. option:: --prefix <prefix>
59-
60-
Filter list using <prefix>
61-
62-
.. option:: --marker <marker>
63-
64-
Anchor for paging
65-
66-
.. option:: --end-marker <end-marker>
67-
68-
End anchor for paging
69-
70-
.. option:: --limit <num-containers>
71-
72-
Limit the number of containers returned
73-
74-
.. option:: --long
75-
76-
List additional fields in output
77-
78-
.. option:: --all
79-
80-
List all containers (default is 10000)
81-
82-
container save
83-
--------------
84-
85-
Save container contents locally
86-
87-
.. program:: container save
88-
.. code:: bash
89-
90-
openstack container save
91-
<container>
92-
93-
.. describe:: <container>
94-
95-
Container to save
96-
97-
container set
98-
-------------
99-
100-
Set container properties
101-
102-
.. program:: container set
103-
.. code:: bash
104-
105-
openstack container set
106-
[--property <key=value> [...] ]
107-
<container>
108-
109-
.. option:: --property <key=value>
110-
111-
Set a property on this container (repeat option to set multiple properties)
112-
113-
.. describe:: <container>
114-
115-
Container to modify
116-
117-
container show
118-
--------------
119-
120-
Display container details
121-
122-
.. program:: container show
123-
.. code:: bash
124-
125-
openstack container show
126-
<container>
127-
128-
.. describe:: <container>
129-
130-
Container to display
131-
132-
container unset
133-
---------------
134-
135-
Unset container properties
136-
137-
.. program:: container unset
138-
.. code:: bash
139-
140-
openstack container unset
141-
[--property <key>]
142-
<container>
143-
144-
.. option:: --property <key>
145-
146-
Property to remove from container (repeat option to remove multiple properties)
147-
148-
.. describe:: <container>
149-
150-
Container to modify
25+
.. autoprogram-cliff:: openstack.object_store.v1
26+
:command: container unset

‎doc/source/cli/command-objects/object-store-account.rst‎

Lines changed: 8 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,14 @@
22
object store account
33
====================
44

5-
Object Storage v1
5+
An **object store account** represents the top-level of the hierarchy that
6+
is comprised of **containers** and **objects**. Applies to Object Storage v1.
67

7-
object store account set
8-
------------------------
8+
.. autoprogram-cliff:: openstack.object_store.v1
9+
:command: object store account set
910

10-
Set account properties
11+
.. autoprogram-cliff:: openstack.object_store.v1
12+
:command: object store account show
1113

12-
.. program:: object store account set
13-
.. code:: bash
14-
15-
openstack object store account set
16-
[--property <key=value> [...] ]
17-
18-
.. option:: --property <key=value>
19-
20-
Set a property on this account (repeat option to set multiple properties)
21-
22-
object store account show
23-
-------------------------
24-
25-
Display account details
26-
27-
.. program:: object store account show
28-
.. code:: bash
29-
30-
openstack object store account show
31-
32-
object store account unset
33-
--------------------------
34-
35-
Unset account properties
36-
37-
.. program:: object store account unset
38-
.. code:: bash
39-
40-
openstack object store account unset
41-
[--property <key>]
42-
43-
.. option:: --property <key>
44-
45-
Property to remove from account (repeat option to remove multiple properties)
14+
.. autoprogram-cliff:: openstack.object_store.v1
15+
:command: object store account unset

0 commit comments

Comments
 (0)