Skip to content

Commit ba77b6a

Browse files
committed
Schema formatting fixes, list all default values
1 parent b68e43e commit ba77b6a

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

schemas/qwc-db-auth.json

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,73 +25,73 @@
2525
"type": "string"
2626
},
2727
"qwc_config_schema": {
28-
"description": "The name of the DB schema which stores the qwc config. Default: qwc_config",
28+
"description": "The name of the DB schema which stores the qwc config. Default: `qwc_config`",
2929
"type": "string"
3030
},
3131
"password_min_length": {
32-
"description": "Min password length",
32+
"description": "Min password length. Default: `8`",
3333
"type": "integer"
3434
},
3535
"password_max_length": {
36-
"description": "Max password length",
36+
"description": "Max password length, or `-1` to disable. Default: `-1`",
3737
"type": "integer"
3838
},
3939
"password_constraints": {
40-
"description": "List of RegExes for additional password constraints",
40+
"description": "List of RegExes for additional password constraints. Default: `[]`",
4141
"type": "array",
4242
"items": {
4343
"type": "string"
4444
}
4545
},
4646
"password_min_constraints": {
47-
"description": "Min number of password_constraints to match for password to be valid",
47+
"description": "Min number of password_constraints to match for password to be valid. Default: `0`",
4848
"type": "integer"
4949
},
5050
"password_constraints_message": {
51-
"description": "Validation message if password constraints are not met",
51+
"description": "Validation message if password constraints are not met. Default: `Password does not match constraints`",
5252
"type": "string"
5353
},
5454
"password_expiry": {
55-
"description": "Number of days until password expires, or -1 to disable",
55+
"description": "Number of days until password expires, or `-1` to disable. Default: `-1`",
5656
"type": "integer"
5757
},
5858
"password_expiry_notice": {
59-
"description": "Show an expiry notice within this number of days before a password expires, or `-1` to disable",
59+
"description": "Show an expiry notice within this number of days before a password expires, or `-1` to disable. Default: `-1`",
6060
"type": "integer"
6161
},
6262
"password_update_interval": {
63-
"description": "Min number of seconds before password may be changed again, or -1 to disable",
63+
"description": "Min number of seconds before password may be changed again, or -1 to disable. Default: `-1`",
6464
"type": "integer"
6565
},
6666
"password_allow_reuse": {
67-
"description": "Set whether previous passwords may be reused or not",
67+
"description": "Set whether previous passwords may be reused or not. Default: `true`",
6868
"type": "boolean"
6969
},
7070
"user_info_fields": {
71-
"description": "List of user info fields to include in JWT identity",
71+
"description": "List of user info fields to include in JWT identity. Default: `[]`",
7272
"type": "array",
7373
"items": {
7474
"type": "string"
7575
}
7676
},
7777
"logo_image_url": {
78-
"description": "URL to a logo image to show in the login form",
78+
"description": "URL to a logo image to show in the login form. Default: `null`",
7979
"type": "string"
8080
},
8181
"background_image_url": {
82-
"description": "URL to a background image for the login page",
82+
"description": "URL to a background image for the login page. Default: `null`",
8383
"type": "string"
8484
},
8585
"customstylesheet": {
86-
"description": "URL of custom stylesheet.",
86+
"description": "URL of custom stylesheet. Default: `null`",
8787
"type": "string"
8888
},
8989
"terms_url": {
90-
"description": "URL to terms of use",
90+
"description": "URL to terms of use. Default: `null`",
9191
"type": "string"
9292
},
9393
"login_hint": {
94-
"description": "Login hint text, shown above login form fields. Either a string, or dictionary `{\"<lang>\": \"<text>\"}`. When providing a dictionary, the entry matching the current locale will be searched, with fallback to `en` if no entry for the current locale exists, and fallback to an empty string if no `en` entry exists.",
94+
"description": "Login hint text, shown above login form fields. Either a string, or dictionary `{\"<lang>\": \"<text>\"}`. When providing a dictionary, the entry matching the current locale will be searched, with fallback to `en` if no entry for the current locale exists, and fallback to an empty string if no `en` entry exists. Default: `null`",
9595
"oneOf":[
9696
{"type": "string"},
9797
{
@@ -105,31 +105,31 @@
105105
]
106106
},
107107
"post_param_login": {
108-
"description": "Whether 'username' and 'password', and possibly additional parameters, are passed as POST parameters. Additional parameters are appended to the target url query. Default: false",
108+
"description": "Whether 'username' and 'password', and possibly additional parameters, are passed as POST parameters. Additional parameters are appended to the target url query. Default: `false`",
109109
"type": "boolean"
110110
},
111111
"max_login_attempts": {
112-
"description": "Maximum login attempts before login is blocked. Default: 20",
112+
"description": "Maximum login attempts before login is blocked. Default: `20`",
113113
"type": "integer"
114114
},
115115
"totp_enabled": {
116-
"description": "Enable two factor authentication using TOTP. Default: false",
116+
"description": "Enable two factor authentication using TOTP. Default: `false`",
117117
"type": "boolean"
118118
},
119119
"totp_enabled_for_admin": {
120-
"description": "Whether to enable two-factor authentication using TOTP for admin. Default: false",
120+
"description": "Whether to enable two-factor authentication using TOTP for admin. Default: `false`",
121121
"type": "boolean"
122122
},
123123
"totp_issuer_name": {
124-
"description": "Issuer name for QR code URI. Default: 'QWC Services'",
124+
"description": "Issuer name for QR code URI. Default: `QWC Services`",
125125
"type": "string"
126126
},
127127
"ip_blacklist_duration": {
128-
"description": "How many seconds an IP will remain in the blacklist. See also ip_blacklist_max_attempt_count. Default: 300",
128+
"description": "How many seconds an IP will remain in the blacklist. See also `ip_blacklist_max_attempt_count`. Default: `300`",
129129
"type": "integer"
130130
},
131131
"ip_blacklist_max_attempt_count": {
132-
"description": "After how many failed login attempts an IP will be blacklisted. Should be less than max_login_attempts. See also ip_blacklist_duration. Default: 10",
132+
"description": "After how many failed login attempts an IP will be blacklisted. Should be less `than max_login_attempts`. See also `ip_blacklist_duration`. Default: `10`",
133133
"type": "integer"
134134
},
135135
"force_password_change_first_login": {

0 commit comments

Comments
 (0)