python-api/config.schema.json at master · eshopapi/python-api · GitHub

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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "properties": {
        "secret_key": {
            "type": "string",
            "title": "Secret key",
            "description": "The key used to sign JWT tokens and encrypt passwords. Keep it safe. You should not store the secret key in the config file and use `SHOPAPI__SECRET_KEY` env variable instead."
        },
        "access_token_expire": {
            "type": "integer",
            "title": "Access token expire (minutes)",
            "description": "Number of minutes the access token remains valid (default: 60 minutes). If the user opts for permanent login, the validty is 3 months.",
            "default": 60
        },
        "base_url": {
            "type": "string",
            "title": "Base url",
            "description": "Root url path used to generate absolute links.",
            "default": "http://localhost",
            "examples": [
                "https://www.example.com",
                "http://localhost",
                "https://my.website.com/lives/behind/proxy"
            ]
        },
        "support_contact": {
            "type": [
                "string",
                "null"
            ],
            "title": "Support contact",
            "description": "Contact that will be displayed to users if any unexpected error ocurrs"
        },
        "sso": {
            "type": "object",
            "properties": {
                "google": {
                    "type": "object",
                    "properties": {
                        "enabled": {
                            "type": "boolean",
                            "default": false
                        },
                        "client_id": {
                            "type": "string"
                        },
                        "client_secret": {
                            "type": "string"
                        }
                    }
                },
                "facebook": {
                    "type": "object",
                    "properties": {
                        "enabled": {
                            "type": "boolean",
                            "default": false
                        },
                        "client_id": {
                            "type": "string"
                        },
                        "client_secret": {
                            "type": "string"
                        }
                    }
                },
                "microsoft": {
                    "type": "object",
                    "properties": {
                        "enabled": {
                            "type": "boolean",
                            "default": false
                        },
                        "client_id": {
                            "type": "string"
                        },
                        "client_secret": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "database": {
            "type": "object",
            "properties": {
                "host": {
                    "type": "string",
                    "default": "db.sqlite3"
                },
                "port": {
                    "type": "integer"
                },
                "backend": {
                    "type": "string",
                    "enum": [
                        "sqlite",
                        "postgres"
                    ],
                    "default": "sqlite"
                },
                "user": {
                    "type": "string"
                },
                "password": {
                    "type": "string"
                },
                "database": {
                    "type": "string",
                    "default": "shopapi"
                }
            }
        }
    }
}