Michael Johnson 84feb7c4b0 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
2017-06-28 19:08:05 -07:00

1.9 KiB

tocdepth

2

Octavia API

This is a reference for the OpenStack Load Balancing API which is provided by the Octavia project.

Current API version

Octavia API v2.0<v2/index>

Supported API version

Octavia API v1

Deprecated API version

None

v2/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.

API Discovery

List All Major Versions

This fetches all the information about all known major API versions in the deployment.

Response codes

  • 200
  • 500

Response

  • id: api_version_id
  • status: api_version_status
  • updated_at: updated_at

Response Example

examples/versions-get-resp.json

Note

This is just an example output and does not represent the current API versions available.