From 719cb11d44985b3fb812ebf50f3a74ce39cece72 Mon Sep 17 00:00:00 2001 From: "Frederick [Bot]" Date: Mon, 16 Jun 2025 14:10:07 +0000 Subject: [PATCH] [skip ci] Updated swagger docs --- pkg/swagger/docs.go | 70 ++++++++++++++++++++-------------------- pkg/swagger/swagger.json | 70 ++++++++++++++++++++-------------------- pkg/swagger/swagger.yaml | 50 ++++++++++++++-------------- 3 files changed, 96 insertions(+), 94 deletions(-) diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index ab8433634..5b4f6b328 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -6733,7 +6733,7 @@ const docTemplate = `{ "JWTKeyAuth": [] } ], - "description": "Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, default.", + "description": "Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, marble, ldap (synced from LDAP server), openid (synced from OpenID provider), default.", "consumes": [ "application/json" ], @@ -7739,6 +7739,38 @@ const docTemplate = `{ } } }, + "code_vikunja_io_api_pkg_modules_auth_openid.Provider": { + "type": "object", + "properties": { + "auth_url": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "email_fallback": { + "type": "boolean" + }, + "force_user_info": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "logout_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "scope": { + "type": "string" + }, + "username_fallback": { + "type": "boolean" + } + } + }, "files.File": { "type": "object", "properties": { @@ -9327,38 +9359,6 @@ const docTemplate = `{ } } }, - "openid.Provider": { - "type": "object", - "properties": { - "auth_url": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "email_fallback": { - "type": "boolean" - }, - "force_user_info": { - "type": "boolean" - }, - "key": { - "type": "string" - }, - "logout_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "username_fallback": { - "type": "boolean" - } - } - }, "todoist.Migration": { "type": "object", "properties": { @@ -9522,7 +9522,7 @@ const docTemplate = `{ "type": "object", "properties": { "avatar_provider": { - "description": "The avatar provider. Valid types are ` + "`" + `gravatar` + "`" + ` (uses the user email), ` + "`" + `upload` + "`" + `, ` + "`" + `initials` + "`" + `, ` + "`" + `marble` + "`" + ` (generates a random avatar for each user), ` + "`" + `default` + "`" + `.", + "description": "The avatar provider. Valid types are ` + "`" + `gravatar` + "`" + ` (uses the user email), ` + "`" + `upload` + "`" + `, ` + "`" + `initials` + "`" + `, ` + "`" + `marble` + "`" + ` (generates a random avatar for each user), ` + "`" + `ldap` + "`" + ` (synced from LDAP server), ` + "`" + `openid` + "`" + ` (synced from OpenID provider), ` + "`" + `default` + "`" + `.", "type": "string" } } @@ -9725,7 +9725,7 @@ const docTemplate = `{ "providers": { "type": "array", "items": { - "$ref": "#/definitions/openid.Provider" + "$ref": "#/definitions/code_vikunja_io_api_pkg_modules_auth_openid.Provider" } } } diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index d0555f48a..0f95681db 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -6725,7 +6725,7 @@ "JWTKeyAuth": [] } ], - "description": "Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, default.", + "description": "Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, marble, ldap (synced from LDAP server), openid (synced from OpenID provider), default.", "consumes": [ "application/json" ], @@ -7731,6 +7731,38 @@ } } }, + "code_vikunja_io_api_pkg_modules_auth_openid.Provider": { + "type": "object", + "properties": { + "auth_url": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "email_fallback": { + "type": "boolean" + }, + "force_user_info": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "logout_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "scope": { + "type": "string" + }, + "username_fallback": { + "type": "boolean" + } + } + }, "files.File": { "type": "object", "properties": { @@ -9319,38 +9351,6 @@ } } }, - "openid.Provider": { - "type": "object", - "properties": { - "auth_url": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "email_fallback": { - "type": "boolean" - }, - "force_user_info": { - "type": "boolean" - }, - "key": { - "type": "string" - }, - "logout_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "username_fallback": { - "type": "boolean" - } - } - }, "todoist.Migration": { "type": "object", "properties": { @@ -9514,7 +9514,7 @@ "type": "object", "properties": { "avatar_provider": { - "description": "The avatar provider. Valid types are `gravatar` (uses the user email), `upload`, `initials`, `marble` (generates a random avatar for each user), `default`.", + "description": "The avatar provider. Valid types are `gravatar` (uses the user email), `upload`, `initials`, `marble` (generates a random avatar for each user), `ldap` (synced from LDAP server), `openid` (synced from OpenID provider), `default`.", "type": "string" } } @@ -9717,7 +9717,7 @@ "providers": { "type": "array", "items": { - "$ref": "#/definitions/openid.Provider" + "$ref": "#/definitions/code_vikunja_io_api_pkg_modules_auth_openid.Provider" } } } diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index 20484241a..f3c2dbc7f 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -20,6 +20,27 @@ definitions: url: type: string type: object + code_vikunja_io_api_pkg_modules_auth_openid.Provider: + properties: + auth_url: + type: string + client_id: + type: string + email_fallback: + type: boolean + force_user_info: + type: boolean + key: + type: string + logout_url: + type: string + name: + type: string + scope: + type: string + username_fallback: + type: boolean + type: object files.File: properties: created: @@ -1254,27 +1275,6 @@ definitions: scope: type: string type: object - openid.Provider: - properties: - auth_url: - type: string - client_id: - type: string - email_fallback: - type: boolean - force_user_info: - type: boolean - key: - type: string - logout_url: - type: string - name: - type: string - scope: - type: string - username_fallback: - type: boolean - type: object todoist.Migration: properties: code: @@ -1393,7 +1393,8 @@ definitions: avatar_provider: description: The avatar provider. Valid types are `gravatar` (uses the user email), `upload`, `initials`, `marble` (generates a random avatar for each - user), `default`. + user), `ldap` (synced from LDAP server), `openid` (synced from OpenID provider), + `default`. type: string type: object v1.UserDeletionRequestConfirm: @@ -1549,7 +1550,7 @@ definitions: type: boolean providers: items: - $ref: '#/definitions/openid.Provider' + $ref: '#/definitions/code_vikunja_io_api_pkg_modules_auth_openid.Provider' type: array type: object v1.vikunjaInfos: @@ -6246,7 +6247,8 @@ paths: consumes: - application/json description: Changes the user avatar. Valid types are gravatar (uses the user - email), upload, initials, default. + email), upload, initials, marble, ldap (synced from LDAP server), openid (synced + from OpenID provider), default. parameters: - description: The user's avatar setting in: body