diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 17:16:34 -0600 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2020-06-08 16:34:27 -0500 |
| commit | 26878e7d53a531adb67c9ddde8fd6d3c3092ce34 (patch) | |
| tree | 1ebf5ccc543312981f9861fb21e813959f82d2fd /doc/source/cli/command-objects/endpoint.rst | |
| parent | 00e88822e3fcb288d9fe8d019ee7d1bf8dd74630 (diff) | |
| download | python-openstackclient-26878e7d53a531adb67c9ddde8fd6d3c3092ce34.tar.gz | |
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
Diffstat (limited to 'doc/source/cli/command-objects/endpoint.rst')
| -rw-r--r-- | doc/source/cli/command-objects/endpoint.rst | 275 |
1 files changed, 0 insertions, 275 deletions
diff --git a/doc/source/cli/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst deleted file mode 100644 index 6d025327..00000000 --- a/doc/source/cli/command-objects/endpoint.rst +++ /dev/null @@ -1,275 +0,0 @@ -======== -endpoint -======== - -Identity v2, v3 - -endpoint add project --------------------- - -Associate a project to an endpoint for endpoint filtering - -.. program:: endpoint add project -.. code:: bash - - openstack endpoint add project - [--project-domain <project-domain>] - <endpoint> - <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _endpoint_add_project-endpoint: -.. describe:: <endpoint> - - Endpoint to associate with specified project (name or ID) - -.. _endpoint_add_project-project: -.. describe:: <project> - - Project to associate with specified endpoint (name or ID) - -endpoint create ---------------- - -Create new endpoint - -*Identity version 2 only* - -.. program:: endpoint create (v2) -.. code:: bash - - openstack endpoint create - --publicurl <url> - [--adminurl <url>] - [--internalurl <url>] - [--region <region-id>] - <service> - -.. option:: --publicurl <url> - - New endpoint public URL (required) - -.. option:: --adminurl <url> - - New endpoint admin URL - -.. option:: --internalurl <url> - - New endpoint internal URL - -.. option:: --region <region-id> - - New endpoint region ID - -.. _endpoint_create-endpoint: -.. describe:: <service> - - Service to be associated with new endpoint (name or ID) - -*Identity version 3 only* - -.. program:: endpoint create (v3) -.. code:: bash - - openstack endpoint create - [--region <region-id>] - [--enable | --disable] - <service> - <interface> - <url> - -.. option:: --region <region-id> - - New endpoint region ID - -.. option:: --enable - - Enable endpoint (default) - -.. option:: --disable - - Disable endpoint - -.. describe:: <service> - - Service to be associated with new endpoint(name or ID) - -.. describe:: <interface> - - New endpoint interface type (admin, public or internal) - -.. describe:: <url> - - New endpoint URL - -endpoint delete ---------------- - -Delete endpoint(s) - -.. program:: endpoint delete -.. code:: bash - - openstack endpoint delete - <endpoint-id> [<endpoint-id> ...] - -.. _endpoint_delete-endpoint: -.. describe:: <endpoint-id> - - Endpoint(s) to delete (ID only) - -endpoint list -------------- - -List endpoints - -.. program:: endpoint list -.. code:: bash - - openstack endpoint list - [--service <service>] - [--interface <interface>] - [--region <region-id>] - [--long] - [--endpoint <endpoint> | - --project <project> [--project-domain <project-domain>]] - -.. option:: --service <service> - - Filter by service (type, name or ID) - - *Identity version 3 only* - -.. option:: --interface <interface> - - Filter by interface type (admin, public or internal) - - *Identity version 3 only* - -.. option:: --region <region-id> - - Filter by region ID - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - - *Identity version 2 only* - -.. option:: --endpoint - - List projects that have access to that endpoint using - endpoint filtering - - *Identity version 3 only* - -.. option:: --project - - List endpoints available for the project using - endpoint filtering - - *Identity version 3 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - *Identity version 3 only* - -endpoint remove project ------------------------ - -Dissociate a project from an endpoint. - -.. program:: endpoint remove project -.. code:: bash - - openstack endpoint remove project - [--project-domain <project-domain>] - <endpoint> - <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _endpoint_remove_project-endpoint: -.. describe:: <endpoint> - - Endpoint to dissociate with specified project (name or ID) - -.. _endpoint_remove_project-project: -.. describe:: <project> - - Project to dissociate with specified endpoint (name or ID) - -endpoint set ------------- - -Set endpoint properties - -*Identity version 3 only* - -.. program:: endpoint set -.. code:: bash - - openstack endpoint set - [--region <region-id>] - [--interface <interface>] - [--url <url>] - [--service <service>] - [--enable | --disable] - <endpoint-id> - -.. option:: --region <region-id> - - New endpoint region ID - -.. option:: --interface <interface> - - New endpoint interface type (admin, public or internal) - -.. option:: --url <url> - - New endpoint URL - -.. option:: --service <service> - - New endpoint service (name or ID) - -.. option:: --enable - - Enable endpoint - -.. option:: --disable - - Disable endpoint - -.. _endpoint_set-endpoint: -.. describe:: <endpoint-id> - - Endpoint to modify (ID only) - -endpoint show -------------- - -Display endpoint details - -.. program:: endpoint show -.. code:: bash - - openstack endpoint show - <endpoint> - -.. _endpoint_show-endpoint: -.. describe:: <endpoint> - - Endpoint to display (endpoint ID, service ID, service name, service type) |
