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

1 files changed, 23 insertions, 17 deletions

diff --git a/designate/api/versions.py b/designate/api/versions.py
index 56854eeb..cd47dbbd 100644
--- a/designate/api/versions.py
+++ b/designate/api/versions.py
@@ -16,9 +16,23 @@
 import flask
 from oslo_config import cfg
 
+from designate.common import constants
+
 cfg.CONF.import_opt('enable_host_header', 'designate.api', group='service:api')
 
 
+def _add_a_version(versions, version, api_url, status, timestamp):
+    versions.append({
+        'id': version,
+        'status': status,
+        'updated': timestamp,
+        'links': [{'href': api_url,
+                   'rel': 'self'},
+                  {'href': constants.API_REF_URL,
+                   'rel': 'help'}]
+    })
+
+
 def factory(global_config, **local_conf):
     app = flask.Flask('designate.api.versions')
 
@@ -28,23 +42,15 @@ def factory(global_config, **local_conf):
             url_root = flask.request.url_root
         else:
             url_root = cfg.CONF['service:api'].api_base_uri
+        api_url = url_root.rstrip('/') + '/v2'
+
+        versions = []
+        # Initial API version for v2 API
+        _add_a_version(versions, 'v2', api_url, constants.SUPPORTED,
+                       '2022-06-29T00:00:00Z')
+        _add_a_version(versions, 'v2.0', api_url, constants.CURRENT,
+                       '2022-06-29T00:00:00Z')
 
-        return flask.jsonify({
-            "versions": {
-                "values": [{
-                    'id': 'v2',
-                    'status': 'CURRENT',
-                    'links': [
-                        {
-                            'href': url_root.rstrip('/') + '/v2',
-                            'rel': 'self',
-                        }, {
-                            'rel': 'help',
-                            'href': 'https://docs.openstack.org/api-ref/dns'
-                        }
-                    ]
-                }]
-            }
-        })
+        return flask.jsonify({'versions': versions})
 
     return app