Skip to content

Commit ed6a4ff

Browse files
committed
docs: add auth config descriptions to config schema and regenerate reference doc
1 parent 95363db commit ed6a4ff

File tree

2 files changed

+323
-24
lines changed

2 files changed

+323
-24
lines changed

config.schema.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,13 +197,17 @@
197197
"description": "Configuration for an authentication source",
198198
"oneOf": [
199199
{
200+
"title": "Local Auth Config",
201+
"description": "Configuration for the use of the local database as the authentication source.",
200202
"properties": {
201203
"type": { "type": "string", "const": "local" },
202204
"enabled": { "type": "boolean" }
203205
},
204206
"required": ["type", "enabled"]
205207
},
206208
{
209+
"title": "Active Directory Auth Config",
210+
"description": "Configuration for Active Directory authentication.",
207211
"properties": {
208212
"type": { "type": "string", "const": "ActiveDirectory" },
209213
"enabled": { "type": "boolean" },
@@ -243,6 +247,8 @@
243247
"required": ["type", "enabled", "adminGroup", "userGroup", "domain"]
244248
},
245249
{
250+
"title": "Open ID Connect Auth Config",
251+
"description": "Configuration for Open ID Connect authentication.",
246252
"properties": {
247253
"type": { "type": "string", "const": "openidconnect" },
248254
"enabled": { "type": "boolean" },
@@ -262,6 +268,8 @@
262268
"required": ["type", "enabled", "oidcConfig"]
263269
},
264270
{
271+
"title": "JWT Auth Config",
272+
"description": "Configuration for JWT authentication.",
265273
"properties": {
266274
"type": { "type": "string", "const": "jwt" },
267275
"enabled": { "type": "boolean" },

0 commit comments

Comments
 (0)