Michael Johnson 9097c575c0 Clarify the current status of Octavia in README

There was some legacy (neutron-lbaas) language in the README.rst
file for Octavia. This patch updates that and highlights the API
version status documentation.

Change-Id: I16bff7fc1a1359f8c34f4e154aa6dd29a5dd7a9b

2020-08-18 17:23:06 +00:00

2.1 KiB

Raw Blame History

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

Supported API version

None

v2/index

Octavia API minor releases are additive to the API major revision and share the same URL path. Minor revision changes to the API are called out in the API reference in the section the change occurred in. Subsequent minor versions are a superset of the previous versions of the same major revision.

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 Versions

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

Response codes

200

500

Response

id: api_version_id

links: links

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.

2.1 KiB Raw Blame History