cdd14f209e
This patch init api-ref document structure and adding some requirements based on the guidance of OpenStack API team. Get ready for os-api-ref sphinx theme change Change-Id: I896c8752fbcf15ec8e5bc6b3862a1ed040936215 Implements: blueprint magnum-doc-rest-api
32 lines
1.4 KiB
ReStructuredText
32 lines
1.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=================
|
|
Magnum Base URLs
|
|
=================
|
|
|
|
All API calls through the rest of this document require authentication
|
|
with the OpenStack Identity service. They also required a ``url`` that
|
|
is extracted from the Identity token of type
|
|
``container-infra``. This will be the root url that every call below will be
|
|
added to build a full path.
|
|
|
|
Note that if using OpenStack Identity service API v2, ``url`` can be
|
|
represented via ``adminURL``, ``internalURL`` or ``publicURL`` in endpoint
|
|
catalog. In Identity service API v3, ``url`` is represented with field
|
|
``interface`` including ``admin``, ``internal`` and ``public``.
|
|
|
|
For instance, if the ``url`` is
|
|
``http://my-container-infra.org/magnum/v1`` then the full API call for
|
|
``/clusters`` is ``http://my-container-infra.org/magnum/v1/clusters``.
|
|
|
|
Depending on the deployment the container infrastructure management service
|
|
url might be http or https, a custom port, a custom path, and include your
|
|
project id. The only way to know the urls for your deployment is by using the
|
|
service catalog. The container infrastructure management 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 /clusters`` really means
|
|
``GET {your_container_infra_url}/clusters``.
|