yfrake.openapi.components   A
last analyzed

Complexity

Total Complexity 0

Size/Duplication

Total Lines 55
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 22
dl 0
loc 55
rs 10
c 0
b 0
f 0
wmc 0
1
# ================================================================================== #
2
#   components.py - This file is part of the yfrake package.                         #
3
# ================================================================================== #
4
#                                                                                    #
5
#   MIT License                                                                      #
6
#                                                                                    #
7
#   Copyright (c) 2022 Mattias Aabmets                                               #
8
#                                                                                    #
9
#   Permission is hereby granted, free of charge, to any person obtaining a copy     #
10
#   of this software and associated documentation files (the "Software"), to deal    #
11
#   in the Software without restriction, including without limitation the rights     #
12
#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell        #
13
#   copies of the Software, and to permit persons to whom the Software is            #
14
#   furnished to do so, subject to the following conditions:                         #
15
#                                                                                    #
16
#   The above copyright notice and this permission notice shall be included in all   #
17
#   copies or substantial portions of the Software.                                  #
18
#                                                                                    #
19
#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR       #
20
#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,         #
21
#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE      #
22
#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER           #
23
#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,    #
24
#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE    #
25
#   SOFTWARE.                                                                        #
26
#                                                                                    #
27
# ================================================================================== #
28
components: dict = {
29
    'schemas': {
30
        'BaseResponse': {
31
            'type': 'object',
32
            'properties': {
33
                'endpoint': {
34
                    'type': 'string'
35
                },
36
                'error': {
37
                    'nullable': True,
38
                    'type': 'object',
39
                    'properties': {
40
                        'type': {
41
                            'type': 'string'
42
                        },
43
                        'code': {
44
                            'type': 'integer'
45
                        },
46
                        'msg': {
47
                            'type': 'string'
48
                        }
49
                    }
50
                },
51
                'data': {
52
                    'nullable': True,
53
                    'type': 'object',
54
                    'properties': {}
55
                }
56
            }
57
        }
58
    }
59
}
60