summaryrefslogtreecommitdiff
path: root/designate/api/versions.py
blob: cd47dbbdb6fa255bcb655c7cd465f3d6a96e58bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# Copyright 2012 Hewlett-Packard Development Company, L.P. All Rights Reserved.
#
# Author: Kiall Mac Innes <kiall@hpe.com>
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
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')

    @app.route('/', methods=['GET'])
    def version_list():
        if cfg.CONF['service:api'].enable_host_header:
            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': versions})

    return app