summaryrefslogtreecommitdiff
path: root/grafana_dashboards/schema/links.py
blob: 74e7e57c848e7112f17fa4a341f84cd02acba24d (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# Copyright 2018 Red Hat, Inc.
#
# 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 voluptuous as v


class Links(object):
    icons = [
        'bolt',
        'external link',
        'cloud',
        'dashboard',
        'doc',
        'info',
        'question',
    ]

    link_base = {
        v.Required('type'): v.Any('dashboards', 'link'),
        v.Optional('asDropdown'): v.All(bool),
        v.Optional('icon', default='external link'): v.Any(*icons),
        v.Optional('includeVars', default=False): v.All(bool),
        v.Optional('keepTime', default=False): v.All(bool),
        v.Optional('tags'): v.All([str]),
        v.Optional('targetBlank', default=False): v.All(bool),
        v.Optional('title'): v.All(str),
    }

    def _validate(self):

        def f(data):
            res = []
            if not isinstance(data, list):
                raise v.Invalid('Should be a list')

            for link in data:
                validate = v.Schema(self.link_base, extra=True)
                validate(link)

                if link['type'] == 'dashboards':
                    link_dashboards = {
                        v.Optional('asDropdown'): v.All(bool),
                        v.Optional('tags'): v.All([str]),
                    }
                    link_dashboards.update(self.link_base)
                    schema = v.Schema(link_dashboards)
                elif link['type'] == 'link':
                    link_link = {
                        v.Optional('tooltip'): v.All(str),
                        v.Required('url'): v.All(str),
                    }
                    link_link.update(self.link_base)
                    schema = v.Schema(link_link)

                res.append(schema(link))

            return res

        return f

    def get_schema(self):
        schema = v.Schema({
            v.Optional('links'): v.All(self._validate()),
        })

        return schema