Skip to content

Commit 09970d4

Browse files
Zuulopenstack-gerrit
Zuul
authored and
openstack-gerrit
committed
Merge "identity: autogenerate docs"
2 parents f6810ed + 26878e7 commit 09970d4

50 files changed

Lines changed: 271 additions & 2458 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/source/_extra/.htaccess‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ redirectmatch 301 ^/python-openstackclient/([^/]+)/specs/([^/.]+).html$ /python-
99

1010
redirectmatch 301 ^/python-openstackclient/([^/]+)/(command-(beta|errors|logs|options|wrappers)|developing|humaninterfaceguide|plugins).html$ /python-openstackclient/$1/contributor/$2.html
1111
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands/index.html
12+
# Identity pages were split into -v2 and -v3 for common subcommand names.
13+
# The unversioned page is hidden but contains links to the versioned pages so links in the wild redirect somewhere sane.
14+
redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials|endpoint|project|role|service|token|user).html$ /python-openstackclient/$1/cli/_hidden/$2.html

‎doc/source/cli/_hidden/ec2-credentials.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
===============
2+
ec2 credentials
3+
===============
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/ec2-credentials-v2
13+
../command-objects/ec2-credentials-v3

‎doc/source/cli/_hidden/endpoint.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
========
2+
endpoint
3+
========
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/endpoint-v2
13+
../command-objects/endpoint-v3

‎doc/source/cli/_hidden/project.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
project
3+
=======
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/project-v2
13+
../command-objects/project-v3

‎doc/source/cli/_hidden/role.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
====
2+
role
3+
====
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/role-v2
13+
../command-objects/role-v3

‎doc/source/cli/_hidden/service.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
service
3+
=======
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/service-v2
13+
../command-objects/service-v3

‎doc/source/cli/_hidden/token.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=====
2+
token
3+
=====
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/token-v2
13+
../command-objects/token-v3

‎doc/source/cli/_hidden/user.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
====
2+
user
3+
====
4+
5+
.. NOTE(efried): This page is hidden from the main TOC; it's here so links in
6+
the wild redirect somewhere sane, because previously identity v2 and v3 were
7+
combined in a single page.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
../command-objects/user-v2
13+
../command-objects/user-v3

‎doc/source/cli/command-objects/application-credentials.rst‎

Lines changed: 2 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -8,109 +8,6 @@ With application credentials, a user can grant their applications limited
88
access to their cloud resources. Once created, users can authenticate with an
99
application credential by using the ``v3applicationcredential`` auth type.
1010

11-
application credential create
12-
-----------------------------
1311

14-
Create new application credential
15-
16-
.. program:: application credential create
17-
.. code:: bash
18-
19-
openstack application credential create
20-
[--secret <secret>]
21-
[--role <role>]
22-
[--expiration <expiration>]
23-
[--description <description>]
24-
[--restricted|--unrestricted]
25-
[--access-rules <access-rules>]
26-
<name>
27-
28-
.. option:: --secret <secret>
29-
30-
Secret to use for authentication (if not provided, one will be generated)
31-
32-
.. option:: --role <role>
33-
34-
Roles to authorize (name or ID) (repeat option to set multiple values)
35-
36-
.. option:: --expiration <expiration>
37-
38-
Sets an expiration date for the application credential (format of
39-
YYYY-mm-ddTHH:MM:SS)
40-
41-
.. option:: --description <description>
42-
43-
Application credential description
44-
45-
.. option:: --unrestricted
46-
47-
Enable application credential to create and delete other application
48-
credentials and trusts (this is potentially dangerous behavior and is
49-
disabled by default)
50-
51-
.. option:: --restricted
52-
53-
Prohibit application credential from creating and deleting other
54-
application credentials and trusts (this is the default behavior)
55-
56-
.. option:: --access-rules
57-
58-
Either a string or file path containing a JSON-formatted list of access
59-
rules, each containing a request method, path, and service, for example
60-
'[{"method": "GET", "path": "/v2.1/servers", "service": "compute"}]'
61-
62-
.. describe:: <name>
63-
64-
Name of the application credential
65-
66-
67-
application credential delete
68-
-----------------------------
69-
70-
Delete application credential(s)
71-
72-
.. program:: application credential delete
73-
.. code:: bash
74-
75-
openstack application credential delete
76-
<application-credential> [<application-credential> ...]
77-
78-
.. describe:: <application-credential>
79-
80-
Application credential(s) to delete (name or ID)
81-
82-
application credential list
83-
---------------------------
84-
85-
List application credentials
86-
87-
.. program:: application credential list
88-
.. code:: bash
89-
90-
openstack application credential list
91-
[--user <user>]
92-
[--user-domain <user-domain>]
93-
94-
.. option:: --user
95-
96-
User whose application credentials to list (name or ID)
97-
98-
.. option:: --user-domain
99-
100-
Domain the user belongs to (name or ID). This can be
101-
used in case collisions between user names exist.
102-
103-
application credential show
104-
---------------------------
105-
106-
Display application credential details
107-
108-
.. program:: application credential show
109-
.. code:: bash
110-
111-
openstack application credential show
112-
<application-credential>
113-
114-
.. describe:: <application-credential>
115-
116-
Application credential to display (name or ID)
12+
.. autoprogram-cliff:: openstack.identity.v3
13+
:command: application credential *

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,4 @@ A **catalog** lists OpenStack services that are available on the cloud.
66
Applicable to Identity v2 and v3
77

88
.. autoprogram-cliff:: openstack.identity.v3
9-
:command: catalog list
10-
11-
.. autoprogram-cliff:: openstack.identity.v3
12-
:command: catalog show
9+
:command: catalog *

0 commit comments

Comments
 (0)