remove /v2.1/{tenant_id} from all urls

As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.

This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.

Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

1 files changed, 26 insertions, 0 deletions

diff --git a/api-ref/source/urls.inc b/api-ref/source/urls.inc
new file mode 100644
index 0000000000..fe867dd44f
--- /dev/null
+++ b/api-ref/source/urls.inc
@@ -0,0 +1,26 @@
+.. -*- rst -*-
+
+==============
+ Service URLs
+==============
+
+All API calls through the rest of this document require authentication
+with the OpenStack Identity service. They also required a base
+``service url`` that is extracted from the Identity token of type
+``compute``. This will be the root url that every call below will be
+added to build a full path.
+
+For instance, if the ``service url`` is
+``http://mycompute.pvt/compute/v2.1`` then the full API call for
+``/servers`` is ``http://mycompute.pvt/compute/v2.1/servers``.
+
+Depending on the deployment the compute service url might be http or
+https, a custom port, a custom path, and include your tenant id. The
+only way to know the urls for your deployment is by using the service
+catalog. The compute URL should never be hard coded in applications,
+even if they are only expected to work at a single site. It should
+always be discovered from the Identity token.
+
+As such, for the rest of this document we will be using short hand
+where ``GET /servers`` really means ``GET
+{your_compute_service_url}/servers``.