From b56da8dde2ef78f057e67b0b307ee7ce2dff2d7d Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Tue, 30 Dec 2014 17:46:02 -0600 Subject: Add endpoint v3 docs (update: change version description formats for API versioning) Change-Id: I499ea1d80ad6ad6392468305f761e695d7261e33 --- doc/source/command-objects/endpoint.rst | 161 +++++++++++++++++++++++++++++++- 1 file changed, 156 insertions(+), 5 deletions(-) (limited to 'doc/source/command-objects') diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index 128ddfa0..7846a1b1 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -7,39 +7,190 @@ Identity v2, v3 endpoint create --------------- +Create new endpoint + +*Identity version 2 only* + +.. program:: endpoint create +.. code:: bash + + os endpoint create + --publicurl + [--adminurl ] + [--internalurl ] + [--region ] + + +.. option:: --publicurl + + New endpoint public URL (required) + +.. option:: --adminurl + + New endpoint admin URL + +.. option:: --internalurl + + New endpoint internal URL + +.. option:: --region + + New endpoint region ID + +.. _endpoint_create-endpoint: +.. describe:: + + New endpoint service (name or ID) + +*Identity version 3 only* + .. program:: endpoint create .. code:: bash os endpoint create - --publicurl - [--adminurl ] - [--internalurl ] - [--region ] + [--region + [--enable | --disable] + + + +.. option:: --region + + New endpoint region ID + +.. option:: --enable + + Enable endpoint (default) + +.. option:: --disable + + Disable endpoint + +.. describe:: + + New endpoint service (name or ID) + +.. describe:: + + New endpoint interface type (admin, public or internal) + +.. describe:: + + New endpoint URL endpoint delete --------------- +Delete endpoint + .. program:: endpoint delete .. code:: bash os endpoint delete +.. _endpoint_delete-endpoint: +.. describe:: + + Endpoint ID to delete + endpoint list ------------- +List endpoints + .. program:: endpoint list .. code:: bash os endpoint list + [--service ] + [--region ] [--long] +.. option:: --service + + Filter by service + + *Identity version 3 only* + +.. option:: --interface + + Filter by interface type (admin, public or internal) + + *Identity version 3 only* + +.. option:: --region + + Filter by region ID + + *Identity version 3 only* + +.. option:: --long + + List additional fields in output + + *Identity version 2 only* + +endpoint set +------------ + +Set endpoint properties + +*Identity version 3 only* + +.. program:: endpoint set +.. code:: bash + + os endpoint set + [--region ] + [--interface ] + [--url ] + [--service ] + [--enable | --disable] + + +.. option:: --region + + New endpoint region ID + +.. option:: --interface + + New endpoint interface type (admin, public or internal) + +.. option:: --url + + New endpoint URL + +.. option:: --service + + New endpoint service (name or ID) + +.. option:: --enable + + Enable endpoint + +.. option:: --disable + + Disable endpoint + +.. _endpoint_set-endpoint: +.. describe:: + + Endpoint ID to modify + endpoint show ------------- +Display endpoint details + .. program:: endpoint show .. code:: bash os endpoint show - + + +.. _endpoint_show-endpoint: +.. describe:: + + Endpoint ID to display -- cgit v1.2.1