openstack/nova
Code Issues Proposed changes
e83b884cf6
nova/api-ref/source/urls.inc

27 lines
1.1 KiB
PHP
Raw Normal View History

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
2016-06-02 08:50:03 -04:00
.. -*- rst -*-
==============
Service URLs
==============
[api-ref] Minor text clean-up, formatting - Cleaned up some wording, and formatted two rst notes. - Moved cloudpipe.inc in index.rst to be located with other deprecated apis. Change-Id: Ic3740540e8cc626110c77214acf87338e1abdd76
2016-11-29 12:31:46 -05:00
All API calls described throughout the rest of this document require
authentication with the OpenStack Identity service. After authentication,
a base ``service url`` can be extracted from the Identity token of type
``compute``. This ``service url`` will be the root url that every API call
uses to build a full path.
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
2016-06-02 08:50:03 -04:00
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``.
[api-ref] Minor text clean-up, formatting - Cleaned up some wording, and formatted two rst notes. - Moved cloudpipe.inc in index.rst to be located with other deprecated apis. Change-Id: Ic3740540e8cc626110c77214acf87338e1abdd76
2016-11-29 12:31:46 -05:00
Depending on the deployment, the Compute ``service url`` might be http or
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
2016-06-02 08:50:03 -04:00
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
[api-ref] Minor text clean-up, formatting - Cleaned up some wording, and formatted two rst notes. - Moved cloudpipe.inc in index.rst to be located with other deprecated apis. Change-Id: Ic3740540e8cc626110c77214acf87338e1abdd76
2016-11-29 12:31:46 -05:00
catalog. The Compute URL should never be hard coded in applications,
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
2016-06-02 08:50:03 -04:00
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``.
Copy Permalink