openstack/designate
Code Issues Proposed changes
d6eabef4de
designate/api-ref/source/index.rst
Michael Johnson 39652d7a51 Add simple API versioning to the Designate API 
Adds simple API versioning for Designate. Designate API minor releases are
additive to the API major revision and share the same URL path. Subsequent
minor versions are a superset of the previous versions of the same major
revision.
Updates the version discovery document to be compliant with OpenStack
version discovery.
Restructures the API reference to provide more information about the
versioning.

Depends-On: https://review.opendev.org/c/openstack/designate-tempest-plugin/+/848323
Change-Id: I13162711b521472ec8b796ced34d0b7107aaed36
2022-06-30 18:30:54 +00:00

2.1 KiB
Raw Blame History

tocdepth

2

Designate API

This is a reference for the OpenStack DNS API which is provided by the Designate project.

Current API version

Designate API v2<dns-api-v2-index>

Supported API version

None

dns-api-v2-index

Designate 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 Versions

Show all enabled API versions

List all API versions

  • 200
  • 400
  • 405
  • 500
  • 503

Request

No parameters needed

Response Parameters

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

Response Example

samples/versions/get-versions-response.json

Note

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