From ea0c9fbe94092cdd8a84ad616c81fce10357aa6a Mon Sep 17 00:00:00 2001 From: "Frederick [Bot]" Date: Thu, 11 Jun 2026 20:24:56 +0000 Subject: [PATCH] [skip ci] Updated swagger docs --- pkg/swagger/docs.go | 264 +++++++++++++++++++-------------------- pkg/swagger/swagger.json | 264 +++++++++++++++++++-------------------- pkg/swagger/swagger.yaml | 210 +++++++++++++++---------------- 3 files changed, 369 insertions(+), 369 deletions(-) diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index 7921a5fe3..e0ef37ad7 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -42,7 +42,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.Overview" + "$ref": "#/definitions/models.Overview" } }, "404": { @@ -207,7 +207,7 @@ const docTemplate = `{ "schema": { "type": "array", "items": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } } }, @@ -243,7 +243,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/admin.CreateUserBody" + "$ref": "#/definitions/models.CreateUserBody" } } ], @@ -251,7 +251,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } }, "400": { @@ -352,7 +352,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } }, "400": { @@ -410,7 +410,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } }, "400": { @@ -8884,44 +8884,6 @@ const docTemplate = `{ } }, "definitions": { - "admin.CreateUserBody": { - "type": "object", - "properties": { - "email": { - "description": "The user's email address", - "type": "string", - "maxLength": 250 - }, - "is_admin": { - "description": "Mark the new user as an instance admin.", - "type": "boolean" - }, - "language": { - "description": "The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.", - "type": "string" - }, - "name": { - "description": "The full name of the new user. Optional.", - "type": "string" - }, - "password": { - "description": "The user's password in clear text. Only used when registering the user. The maximum limi is 72 bytes, which may be less than 72 characters. This is due to the limit in the bcrypt hashing algorithm used to store passwords in Vikunja.", - "type": "string", - "maxLength": 72, - "minLength": 8 - }, - "skip_email_confirm": { - "description": "Activate the new user immediately without email confirmation.", - "type": "boolean" - }, - "username": { - "description": "The user's username. Cannot contain anything that looks like an url or whitespaces.", - "type": "string", - "maxLength": 250, - "minLength": 3 - } - } - }, "admin.IsAdminPatch": { "type": "object", "properties": { @@ -8931,29 +8893,6 @@ const docTemplate = `{ } } }, - "admin.Overview": { - "type": "object", - "properties": { - "license": { - "$ref": "#/definitions/license.Info" - }, - "projects": { - "type": "integer" - }, - "shares": { - "$ref": "#/definitions/admin.ShareCounts" - }, - "tasks": { - "type": "integer" - }, - "teams": { - "type": "integer" - }, - "users": { - "type": "integer" - } - } - }, "admin.OwnerPatch": { "type": "object", "properties": { @@ -8962,20 +8901,6 @@ const docTemplate = `{ } } }, - "admin.ShareCounts": { - "type": "object", - "properties": { - "link_shares": { - "type": "integer" - }, - "team_shares": { - "type": "integer" - }, - "user_shares": { - "type": "integer" - } - } - }, "admin.StatusPatch": { "type": "object", "properties": { @@ -8989,57 +8914,6 @@ const docTemplate = `{ } } }, - "admin.User": { - "type": "object", - "properties": { - "auth_provider": { - "type": "string" - }, - "bot_owner_id": { - "description": "BotOwnerID is the ID of the owning (human) user if this user is a bot.\nA non-zero value means this user is a bot and cannot authenticate via password.", - "type": "integer" - }, - "created": { - "description": "A timestamp when this task was created. You cannot change this value.", - "type": "string" - }, - "email": { - "description": "The user's email address.", - "type": "string", - "maxLength": 250 - }, - "id": { - "description": "The unique, numeric id of this user.", - "type": "integer" - }, - "is_admin": { - "type": "boolean" - }, - "issuer": { - "type": "string" - }, - "name": { - "description": "The full name of the user.", - "type": "string" - }, - "status": { - "$ref": "#/definitions/user.Status" - }, - "subject": { - "type": "string" - }, - "updated": { - "description": "A timestamp when this task was last updated. You cannot change this value.", - "type": "string" - }, - "username": { - "description": "The username of the user. Is always unique.", - "type": "string", - "maxLength": 250, - "minLength": 1 - } - } - }, "auth.Token": { "type": "object", "properties": { @@ -9470,6 +9344,44 @@ const docTemplate = `{ } } }, + "models.CreateUserBody": { + "type": "object", + "properties": { + "email": { + "description": "The user's email address", + "type": "string", + "maxLength": 250 + }, + "is_admin": { + "description": "Mark the new user as an instance admin.", + "type": "boolean" + }, + "language": { + "description": "The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.", + "type": "string" + }, + "name": { + "description": "The full name of the new user. Optional.", + "type": "string" + }, + "password": { + "description": "The user's password in clear text. Only used when registering the user. The maximum limi is 72 bytes, which may be less than 72 characters. This is due to the limit in the bcrypt hashing algorithm used to store passwords in Vikunja.", + "type": "string", + "maxLength": 72, + "minLength": 8 + }, + "skip_email_confirm": { + "description": "Activate the new user immediately without email confirmation.", + "type": "boolean" + }, + "username": { + "description": "The user's username. Cannot contain anything that looks like an url or whitespaces.", + "type": "string", + "maxLength": 250, + "minLength": 3 + } + } + }, "models.DatabaseNotifications": { "type": "object", "properties": { @@ -9629,6 +9541,29 @@ const docTemplate = `{ } } }, + "models.Overview": { + "type": "object", + "properties": { + "license": { + "$ref": "#/definitions/license.Info" + }, + "projects": { + "type": "integer" + }, + "shares": { + "$ref": "#/definitions/models.ShareCounts" + }, + "tasks": { + "type": "integer" + }, + "teams": { + "type": "integer" + }, + "users": { + "type": "integer" + } + } + }, "models.Permission": { "type": "integer", "enum": [ @@ -10001,6 +9936,20 @@ const docTemplate = `{ } } }, + "models.ShareCounts": { + "type": "object", + "properties": { + "link_shares": { + "type": "integer" + }, + "team_shares": { + "type": "integer" + }, + "user_shares": { + "type": "integer" + } + } + }, "models.SharingType": { "type": "integer", "enum": [ @@ -10809,6 +10758,57 @@ const docTemplate = `{ } } }, + "shared.AdminUser": { + "type": "object", + "properties": { + "auth_provider": { + "type": "string" + }, + "bot_owner_id": { + "description": "BotOwnerID is the ID of the owning (human) user if this user is a bot.\nA non-zero value means this user is a bot and cannot authenticate via password.", + "type": "integer" + }, + "created": { + "description": "A timestamp when this task was created. You cannot change this value.", + "type": "string" + }, + "email": { + "description": "The user's email address.", + "type": "string", + "maxLength": 250 + }, + "id": { + "description": "The unique, numeric id of this user.", + "type": "integer" + }, + "is_admin": { + "type": "boolean" + }, + "issuer": { + "type": "string" + }, + "name": { + "description": "The full name of the user.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/user.Status" + }, + "subject": { + "type": "string" + }, + "updated": { + "description": "A timestamp when this task was last updated. You cannot change this value.", + "type": "string" + }, + "username": { + "description": "The username of the user. Is always unique.", + "type": "string", + "maxLength": 250, + "minLength": 1 + } + } + }, "todoist.Migration": { "type": "object", "properties": { diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index fc04db4bf..26d826b75 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -34,7 +34,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.Overview" + "$ref": "#/definitions/models.Overview" } }, "404": { @@ -199,7 +199,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } } }, @@ -235,7 +235,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/admin.CreateUserBody" + "$ref": "#/definitions/models.CreateUserBody" } } ], @@ -243,7 +243,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } }, "400": { @@ -344,7 +344,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } }, "400": { @@ -402,7 +402,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/admin.User" + "$ref": "#/definitions/shared.AdminUser" } }, "400": { @@ -8876,44 +8876,6 @@ } }, "definitions": { - "admin.CreateUserBody": { - "type": "object", - "properties": { - "email": { - "description": "The user's email address", - "type": "string", - "maxLength": 250 - }, - "is_admin": { - "description": "Mark the new user as an instance admin.", - "type": "boolean" - }, - "language": { - "description": "The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.", - "type": "string" - }, - "name": { - "description": "The full name of the new user. Optional.", - "type": "string" - }, - "password": { - "description": "The user's password in clear text. Only used when registering the user. The maximum limi is 72 bytes, which may be less than 72 characters. This is due to the limit in the bcrypt hashing algorithm used to store passwords in Vikunja.", - "type": "string", - "maxLength": 72, - "minLength": 8 - }, - "skip_email_confirm": { - "description": "Activate the new user immediately without email confirmation.", - "type": "boolean" - }, - "username": { - "description": "The user's username. Cannot contain anything that looks like an url or whitespaces.", - "type": "string", - "maxLength": 250, - "minLength": 3 - } - } - }, "admin.IsAdminPatch": { "type": "object", "properties": { @@ -8923,29 +8885,6 @@ } } }, - "admin.Overview": { - "type": "object", - "properties": { - "license": { - "$ref": "#/definitions/license.Info" - }, - "projects": { - "type": "integer" - }, - "shares": { - "$ref": "#/definitions/admin.ShareCounts" - }, - "tasks": { - "type": "integer" - }, - "teams": { - "type": "integer" - }, - "users": { - "type": "integer" - } - } - }, "admin.OwnerPatch": { "type": "object", "properties": { @@ -8954,20 +8893,6 @@ } } }, - "admin.ShareCounts": { - "type": "object", - "properties": { - "link_shares": { - "type": "integer" - }, - "team_shares": { - "type": "integer" - }, - "user_shares": { - "type": "integer" - } - } - }, "admin.StatusPatch": { "type": "object", "properties": { @@ -8981,57 +8906,6 @@ } } }, - "admin.User": { - "type": "object", - "properties": { - "auth_provider": { - "type": "string" - }, - "bot_owner_id": { - "description": "BotOwnerID is the ID of the owning (human) user if this user is a bot.\nA non-zero value means this user is a bot and cannot authenticate via password.", - "type": "integer" - }, - "created": { - "description": "A timestamp when this task was created. You cannot change this value.", - "type": "string" - }, - "email": { - "description": "The user's email address.", - "type": "string", - "maxLength": 250 - }, - "id": { - "description": "The unique, numeric id of this user.", - "type": "integer" - }, - "is_admin": { - "type": "boolean" - }, - "issuer": { - "type": "string" - }, - "name": { - "description": "The full name of the user.", - "type": "string" - }, - "status": { - "$ref": "#/definitions/user.Status" - }, - "subject": { - "type": "string" - }, - "updated": { - "description": "A timestamp when this task was last updated. You cannot change this value.", - "type": "string" - }, - "username": { - "description": "The username of the user. Is always unique.", - "type": "string", - "maxLength": 250, - "minLength": 1 - } - } - }, "auth.Token": { "type": "object", "properties": { @@ -9462,6 +9336,44 @@ } } }, + "models.CreateUserBody": { + "type": "object", + "properties": { + "email": { + "description": "The user's email address", + "type": "string", + "maxLength": 250 + }, + "is_admin": { + "description": "Mark the new user as an instance admin.", + "type": "boolean" + }, + "language": { + "description": "The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.", + "type": "string" + }, + "name": { + "description": "The full name of the new user. Optional.", + "type": "string" + }, + "password": { + "description": "The user's password in clear text. Only used when registering the user. The maximum limi is 72 bytes, which may be less than 72 characters. This is due to the limit in the bcrypt hashing algorithm used to store passwords in Vikunja.", + "type": "string", + "maxLength": 72, + "minLength": 8 + }, + "skip_email_confirm": { + "description": "Activate the new user immediately without email confirmation.", + "type": "boolean" + }, + "username": { + "description": "The user's username. Cannot contain anything that looks like an url or whitespaces.", + "type": "string", + "maxLength": 250, + "minLength": 3 + } + } + }, "models.DatabaseNotifications": { "type": "object", "properties": { @@ -9621,6 +9533,29 @@ } } }, + "models.Overview": { + "type": "object", + "properties": { + "license": { + "$ref": "#/definitions/license.Info" + }, + "projects": { + "type": "integer" + }, + "shares": { + "$ref": "#/definitions/models.ShareCounts" + }, + "tasks": { + "type": "integer" + }, + "teams": { + "type": "integer" + }, + "users": { + "type": "integer" + } + } + }, "models.Permission": { "type": "integer", "enum": [ @@ -9993,6 +9928,20 @@ } } }, + "models.ShareCounts": { + "type": "object", + "properties": { + "link_shares": { + "type": "integer" + }, + "team_shares": { + "type": "integer" + }, + "user_shares": { + "type": "integer" + } + } + }, "models.SharingType": { "type": "integer", "enum": [ @@ -10801,6 +10750,57 @@ } } }, + "shared.AdminUser": { + "type": "object", + "properties": { + "auth_provider": { + "type": "string" + }, + "bot_owner_id": { + "description": "BotOwnerID is the ID of the owning (human) user if this user is a bot.\nA non-zero value means this user is a bot and cannot authenticate via password.", + "type": "integer" + }, + "created": { + "description": "A timestamp when this task was created. You cannot change this value.", + "type": "string" + }, + "email": { + "description": "The user's email address.", + "type": "string", + "maxLength": 250 + }, + "id": { + "description": "The unique, numeric id of this user.", + "type": "integer" + }, + "is_admin": { + "type": "boolean" + }, + "issuer": { + "type": "string" + }, + "name": { + "description": "The full name of the user.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/user.Status" + }, + "subject": { + "type": "string" + }, + "updated": { + "description": "A timestamp when this task was last updated. You cannot change this value.", + "type": "string" + }, + "username": { + "description": "The username of the user. Is always unique.", + "type": "string", + "maxLength": 250, + "minLength": 1 + } + } + }, "todoist.Migration": { "type": "object", "properties": { diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index 0482c4e30..0e248ba95 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -1,39 +1,5 @@ basePath: /api/v1 definitions: - admin.CreateUserBody: - properties: - email: - description: The user's email address - maxLength: 250 - type: string - is_admin: - description: Mark the new user as an instance admin. - type: boolean - language: - description: The language of the new user. Must be a valid IETF BCP 47 language - code and exist in Vikunja. - type: string - name: - description: The full name of the new user. Optional. - type: string - password: - description: The user's password in clear text. Only used when registering - the user. The maximum limi is 72 bytes, which may be less than 72 characters. - This is due to the limit in the bcrypt hashing algorithm used to store passwords - in Vikunja. - maxLength: 72 - minLength: 8 - type: string - skip_email_confirm: - description: Activate the new user immediately without email confirmation. - type: boolean - username: - description: The user's username. Cannot contain anything that looks like - an url or whitespaces. - maxLength: 250 - minLength: 3 - type: string - type: object admin.IsAdminPatch: properties: is_admin: @@ -41,35 +7,11 @@ definitions: silently demote otherwise. type: boolean type: object - admin.Overview: - properties: - license: - $ref: '#/definitions/license.Info' - projects: - type: integer - shares: - $ref: '#/definitions/admin.ShareCounts' - tasks: - type: integer - teams: - type: integer - users: - type: integer - type: object admin.OwnerPatch: properties: owner_id: type: integer type: object - admin.ShareCounts: - properties: - link_shares: - type: integer - team_shares: - type: integer - user_shares: - type: integer - type: object admin.StatusPatch: properties: status: @@ -78,47 +20,6 @@ definitions: description: Pointer to distinguish "omitted" from StatusActive; an empty body would silently re-enable otherwise. type: object - admin.User: - properties: - auth_provider: - type: string - bot_owner_id: - description: |- - BotOwnerID is the ID of the owning (human) user if this user is a bot. - A non-zero value means this user is a bot and cannot authenticate via password. - type: integer - created: - description: A timestamp when this task was created. You cannot change this - value. - type: string - email: - description: The user's email address. - maxLength: 250 - type: string - id: - description: The unique, numeric id of this user. - type: integer - is_admin: - type: boolean - issuer: - type: string - name: - description: The full name of the user. - type: string - status: - $ref: '#/definitions/user.Status' - subject: - type: string - updated: - description: A timestamp when this task was last updated. You cannot change - this value. - type: string - username: - description: The username of the user. Is always unique. - maxLength: 250 - minLength: 1 - type: string - type: object auth.Token: properties: token: @@ -423,6 +324,40 @@ definitions: values: $ref: '#/definitions/models.Task' type: object + models.CreateUserBody: + properties: + email: + description: The user's email address + maxLength: 250 + type: string + is_admin: + description: Mark the new user as an instance admin. + type: boolean + language: + description: The language of the new user. Must be a valid IETF BCP 47 language + code and exist in Vikunja. + type: string + name: + description: The full name of the new user. Optional. + type: string + password: + description: The user's password in clear text. Only used when registering + the user. The maximum limi is 72 bytes, which may be less than 72 characters. + This is due to the limit in the bcrypt hashing algorithm used to store passwords + in Vikunja. + maxLength: 72 + minLength: 8 + type: string + skip_email_confirm: + description: Activate the new user immediately without email confirmation. + type: boolean + username: + description: The user's username. Cannot contain anything that looks like + an url or whitespaces. + maxLength: 250 + minLength: 3 + type: string + type: object models.DatabaseNotifications: properties: created: @@ -545,6 +480,21 @@ definitions: description: A standard message. type: string type: object + models.Overview: + properties: + license: + $ref: '#/definitions/license.Info' + projects: + type: integer + shares: + $ref: '#/definitions/models.ShareCounts' + tasks: + type: integer + teams: + type: integer + users: + type: integer + type: object models.Permission: enum: - 0 @@ -835,6 +785,15 @@ definitions: this value. type: string type: object + models.ShareCounts: + properties: + link_shares: + type: integer + team_shares: + type: integer + user_shares: + type: integer + type: object models.SharingType: enum: - 0 @@ -1474,6 +1433,47 @@ definitions: receiving a 412 with error code 1017. See GHSA-8jvc-mcx6-r4cg. type: string type: object + shared.AdminUser: + properties: + auth_provider: + type: string + bot_owner_id: + description: |- + BotOwnerID is the ID of the owning (human) user if this user is a bot. + A non-zero value means this user is a bot and cannot authenticate via password. + type: integer + created: + description: A timestamp when this task was created. You cannot change this + value. + type: string + email: + description: The user's email address. + maxLength: 250 + type: string + id: + description: The unique, numeric id of this user. + type: integer + is_admin: + type: boolean + issuer: + type: string + name: + description: The full name of the user. + type: string + status: + $ref: '#/definitions/user.Status' + subject: + type: string + updated: + description: A timestamp when this task was last updated. You cannot change + this value. + type: string + username: + description: The username of the user. Is always unique. + maxLength: 250 + minLength: 1 + type: string + type: object todoist.Migration: properties: code: @@ -2001,7 +2001,7 @@ paths: "200": description: OK schema: - $ref: '#/definitions/admin.Overview' + $ref: '#/definitions/models.Overview' "404": description: Not Found schema: @@ -2109,7 +2109,7 @@ paths: description: OK schema: items: - $ref: '#/definitions/admin.User' + $ref: '#/definitions/shared.AdminUser' type: array "404": description: Not Found @@ -2131,14 +2131,14 @@ paths: name: body required: true schema: - $ref: '#/definitions/admin.CreateUserBody' + $ref: '#/definitions/models.CreateUserBody' produces: - application/json responses: "200": description: OK schema: - $ref: '#/definitions/admin.User' + $ref: '#/definitions/shared.AdminUser' "400": description: Bad Request schema: @@ -2206,7 +2206,7 @@ paths: "200": description: OK schema: - $ref: '#/definitions/admin.User' + $ref: '#/definitions/shared.AdminUser' "400": description: Bad Request schema: @@ -2243,7 +2243,7 @@ paths: "200": description: OK schema: - $ref: '#/definitions/admin.User' + $ref: '#/definitions/shared.AdminUser' "400": description: Bad Request schema: