openstack/python-openstackclient
Code Issues Proposed changes
0a7f2692c6
python-openstackclient/doc/source/cli/command-objects/mapping.rst

10 lines
260 B
ReStructuredText
Raw Normal View History

Command doc: mapping Also tweaked the code for `mapping set` as it was previously using cliff Show instead of cliff Command. Change-Id: I0ea1383a9f2dddf4b2f717b2aa16bbd60ab1720c
2015-01-06 01:43:49 -05:00
=======
mapping
=======
auto-generate docs for v3 identity resources skipped shared v2/v3 identity resources. Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
2017-08-17 12:17:39 -04:00
A **mapping** is used by the Identity service's OS-FEDERATION
extension. It is used by **federation protocols** and **identity providers**.
Applicable to Identity v3.
Command doc: mapping Also tweaked the code for `mapping set` as it was previously using cliff Show instead of cliff Command. Change-Id: I0ea1383a9f2dddf4b2f717b2aa16bbd60ab1720c
2015-01-06 01:43:49 -05:00
auto-generate docs for v3 identity resources skipped shared v2/v3 identity resources. Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
2017-08-17 12:17:39 -04:00
.. autoprogram-cliff:: openstack.identity.v3
identity: autogenerate docs $namespace = openstack.identity.v{2|3} The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. Special things: - Some reorganization happened here. Certain subcommand names, such as `endpoint` and `project`, are shared by identify v2 and v3. Previously the hardcoded documents had them combined and interleaved. Attempting to preserve this with autoprogram-cliff would have required significant additional infrastructure. However, since most readers care completely about one and not at all about the other, we instead split the v2 and v3 versions of these commands into separate pages. In case links to the old pages exist in the wild, they are preserved, but moved (with redirects) to a hidden directory, and populated simply with links to the new version-specific generated documents. - The `federation domain` and `federation project` subcommands were previously absent from the docs. They are added. These are such small commands and they seem related, so they're put into a single document. - Some pages were already being generated but were listing operations individually instead of using wildcards (possibly because they were created before wildcarding was supported by cliff). These are changed to use wildcarding. (We want to do this wherever possible as it is more future-proof in the event that more operations are added to a subcommand later.) - The `service provider` document was incorrectly titled `identity provider`. Fixed. Change-Id: I2030f9fe370038c5908b6eb6bed9692a73fe5067
2019-11-04 17:16:34 -06:00
:command: mapping *
Copy Permalink