Skip to content

Commit 6c0b966

Browse files
Zuulopenstack-gerrit
Zuul
authored and
openstack-gerrit
committed
Merge "auto-generate docs for v3 identity resources"
2 parents 3abba6e + 0d94a76 commit 6c0b966

12 files changed

Lines changed: 134 additions & 996 deletions

‎doc/source/cli/command-objects/access-token.rst‎

Lines changed: 5 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,9 @@
22
access token
33
============
44

5-
Identity v3
5+
An **access token** is used by the Identity service's OS-OAUTH1 extension. It
6+
is used by the **consumer** to request new Identity API tokens on behalf of the
7+
authorizing **user**. Applicable to Identity v3.
68

7-
`Requires: OS-OAUTH1 extension`
8-
9-
access token create
10-
-------------------
11-
12-
Create an access token
13-
14-
.. program:: access token create
15-
.. code:: bash
16-
17-
openstack access token create
18-
--consumer-key <consumer-key>
19-
--consumer-secret <consumer-secret>
20-
--request-key <request-key>
21-
--request-secret <request-secret>
22-
--verifier <verifier>
23-
24-
.. option:: --consumer-key <consumer-key>
25-
26-
Consumer key (required)
27-
28-
.. option:: --consumer-secret <consumer-secret>
29-
30-
Consumer secret (required)
31-
32-
.. option:: --request-key <request-key>
33-
34-
Request token to exchange for access token (required)
35-
36-
.. option:: --request-secret <request-secret>
37-
38-
Secret associated with <request-key> (required)
39-
40-
.. option:: --verifier <verifier>
41-
42-
Verifier associated with <request-key> (required)
9+
.. autoprogram-cliff:: openstack.identity.v3
10+
:command: access token create

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

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,11 @@
22
catalog
33
=======
44

5-
Identity v2, v3
5+
A **catalog** lists OpenStack services that are available on the cloud.
6+
Applicable to Identity v2 and v3
67

7-
catalog list
8-
------------
8+
.. autoprogram-cliff:: openstack.identity.v3
9+
:command: catalog list
910

10-
List services in the service catalog
11-
12-
.. program:: catalog list
13-
.. code:: bash
14-
15-
openstack catalog list
16-
17-
catalog show
18-
------------
19-
20-
Display service catalog details
21-
22-
.. program:: catalog show
23-
.. code:: bash
24-
25-
openstack catalog show
26-
<service>
27-
28-
.. describe:: <service>
29-
30-
Service to display (type or name)
11+
.. autoprogram-cliff:: openstack.identity.v3
12+
:command: catalog show

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

Lines changed: 13 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -2,82 +2,21 @@
22
consumer
33
========
44

5-
Identity v3
5+
An **consumer** is used by the Identity service's OS-OAUTH1 extension. It
6+
is used to create a **request token** and **access token**. Applicable to
7+
Identity v3.
68

7-
`Requires: OS-OAUTH1 extension`
9+
.. autoprogram-cliff:: openstack.identity.v3
10+
:command: consumer create
811

9-
consumer create
10-
---------------
12+
.. autoprogram-cliff:: openstack.identity.v3
13+
:command: consumer delete
1114

12-
Create new consumer
15+
.. autoprogram-cliff:: openstack.identity.v3
16+
:command: consumer list
1317

14-
.. program:: consumer create
15-
.. code:: bash
18+
.. autoprogram-cliff:: openstack.identity.v3
19+
:command: consumer set
1620

17-
openstack consumer create
18-
[--description <description>]
19-
20-
.. option:: --description <description>
21-
22-
New consumer description
23-
24-
consumer delete
25-
---------------
26-
27-
Delete consumer(s)
28-
29-
.. program:: consumer delete
30-
.. code:: bash
31-
32-
openstack consumer delete
33-
<consumer> [<consumer> ...]
34-
35-
.. describe:: <consumer>
36-
37-
Consumer(s) to delete
38-
39-
consumer list
40-
-------------
41-
42-
List consumers
43-
44-
.. program:: consumer list
45-
.. code:: bash
46-
47-
openstack consumer list
48-
49-
consumer set
50-
------------
51-
52-
Set consumer properties
53-
54-
.. program:: consumer set
55-
.. code:: bash
56-
57-
openstack consumer set
58-
[--description <description>]
59-
<consumer>
60-
61-
.. option:: --description <description>
62-
63-
New consumer description
64-
65-
.. describe:: <consumer>
66-
67-
Consumer to modify
68-
69-
consumer show
70-
-------------
71-
72-
Display consumer details
73-
74-
.. program:: consumer show
75-
.. code:: bash
76-
77-
openstack consumer show
78-
<consumer>
79-
80-
.. _consumer_show-consumer:
81-
.. describe:: <consumer>
82-
83-
Consumer to display
21+
.. autoprogram-cliff:: openstack.identity.v3
22+
:command: consumer show

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

Lines changed: 13 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -2,114 +2,21 @@
22
domain
33
======
44

5-
Identity v3
5+
A **domain** is a collection of **users**, **groups**, and **projects**. Each
6+
**group** and **project** is owned by exactly one **domain**. Applies to
7+
Identity v3.
68

7-
domain create
8-
-------------
9+
.. autoprogram-cliff:: openstack.identity.v3
10+
:command: domain create
911

10-
Create new domain
12+
.. autoprogram-cliff:: openstack.identity.v3
13+
:command: domain delete
1114

12-
.. program:: domain create
13-
.. code:: bash
15+
.. autoprogram-cliff:: openstack.identity.v3
16+
:command: domain list
1417

15-
openstack domain create
16-
[--description <description>]
17-
[--enable | --disable]
18-
[--or-show]
19-
<domain-name>
18+
.. autoprogram-cliff:: openstack.identity.v3
19+
:command: domain set
2020

21-
.. option:: --description <description>
22-
23-
New domain description
24-
25-
.. option:: --enable
26-
27-
Enable domain (default)
28-
29-
.. option:: --disable
30-
31-
Disable domain
32-
33-
.. option:: --or-show
34-
35-
Return existing domain
36-
37-
If the domain already exists, return the existing domain data and do not fail.
38-
39-
.. describe:: <domain-name>
40-
41-
New domain name
42-
43-
domain delete
44-
-------------
45-
46-
Delete domain(s)
47-
48-
.. program:: domain delete
49-
.. code:: bash
50-
51-
openstack domain delete
52-
<domain> [<domain> ...]
53-
54-
.. describe:: <domain>
55-
56-
Domain(s) to delete (name or ID)
57-
58-
domain list
59-
-----------
60-
61-
List domains
62-
63-
.. program:: domain list
64-
.. code:: bash
65-
66-
openstack domain list
67-
68-
domain set
69-
----------
70-
71-
Set domain properties
72-
73-
.. program:: domain set
74-
.. code:: bash
75-
76-
openstack domain set
77-
[--name <name>]
78-
[--description <description>]
79-
[--enable | --disable]
80-
<domain>
81-
82-
.. option:: --name <name>
83-
84-
New domain name
85-
86-
.. option:: --description <description>
87-
88-
New domain description
89-
90-
.. option:: --enable
91-
92-
Enable domain
93-
94-
.. option:: --disable
95-
96-
Disable domain
97-
98-
.. describe:: <domain>
99-
100-
Domain to modify (name or ID)
101-
102-
domain show
103-
-----------
104-
105-
Display domain details
106-
107-
.. program:: domain show
108-
.. code:: bash
109-
110-
openstack domain show
111-
<domain>
112-
113-
.. describe:: <domain>
114-
115-
Domain to display (name or ID)
21+
.. autoprogram-cliff:: openstack.identity.v3
22+
:command: domain show

0 commit comments

Comments
 (0)