Update our docs to point to the new api-ref

Now that we have a full API reference, point our docs at the
official location.

This patch also clarifies that the v1 API is in "SUPPORTED" status.

Change-Id: Icb64dd56ee6b875d5cc4915017e9e272b2efd46d
This commit is contained in:
Michael Johnson 2017-06-28 16:04:16 -07:00
parent bca6268b05
commit 84feb7c4b0
5 changed files with 29 additions and 20 deletions

View File

@ -11,15 +11,33 @@ Current API version
:doc:`Octavia API v2.0<v2/index>`
Supported API version
`Octavia API v1 <https://docs.openstack.org/developer/octavia/api/octaviaapi.html>`_
Deprecated API version
:doc:`Octavia API v1<v1/index>`
None
.. toctree::
:hidden:
v2/index
v1/index
The API status reflects the state of the endpoint on the service.
* Current indicates a stable version that is up-to-date, recent, and might
receive future versions. This endpoint should be prioritized over all
others.
* Supported is a stable version that is available on the server. However, it
is not likely the most recent available and might not be updated or might
be deprecated at some time in the future.
* Deprecated is a stable version that is still available but is being
deprecated and might be removed in the future.
* Experimental is not a stable version. This version is under development or
contains features that are otherwise subject to change. For more
information about API status values and version information, see
`Version Discovery <https://wiki.openstack.org/wiki/VersionDiscovery>`__.
.. rest_expand_all::

View File

@ -1,14 +0,0 @@
:tocdepth: 2
===========================
Octavia API v1 (Deprecated)
===========================
.. rest_expand_all::
--------------------
General API Overview
--------------------
Load Balancers
==============

View File

@ -1,9 +1,14 @@
Octavia API
===========
Octavia API v1 (SUPORTED)
=========================
Authentication
--------------
.. warning::
This API should be only used for internal access such as from the
neutron-lbaas octavia driver. It does not support access control.
Using the version 1 API
-----------------------

View File

@ -56,7 +56,7 @@ APIs
:glob:
:maxdepth: 1
api/octaviaapi.rst
Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>
api/haproxy-amphora-api.rst
====================

View File

@ -40,7 +40,7 @@ class RootController(rest.RestController):
self.v1 = v1_controller.V1Controller()
self._versions.append(
{
'status': 'CURRENT',
'status': 'SUPPORTED',
'updated': '2014-12-11T00:00:00Z',
'id': 'v1'
})