[skip ci] Updated swagger docs

This commit is contained in:
Frederick [Bot] 2025-03-02 15:09:28 +00:00 committed by kolaente
parent 35a60b5482
commit b489703d6f
3 changed files with 83 additions and 82 deletions

View File

@ -3829,12 +3829,12 @@ const docTemplate = `{
"summary": "Register",
"parameters": [
{
"description": "The user credentials",
"description": "The user with credentials to create",
"name": "credentials",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/user.APIUserPassword"
"$ref": "#/definitions/v1.UserRegister"
}
}
],
@ -9379,32 +9379,6 @@ const docTemplate = `{
}
}
},
"user.APIUserPassword": {
"type": "object",
"properties": {
"email": {
"description": "The user's email address",
"type": "string",
"maxLength": 250
},
"id": {
"description": "The unique, numeric id of this user.",
"type": "integer"
},
"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
},
"username": {
"description": "The user's username. Cannot contain anything that looks like an url or whitespaces.",
"type": "string",
"maxLength": 250,
"minLength": 3
}
}
},
"user.EmailConfirm": {
"type": "object",
"properties": {
@ -9584,6 +9558,32 @@ const docTemplate = `{
}
}
},
"v1.UserRegister": {
"type": "object",
"properties": {
"email": {
"description": "The user's email address",
"type": "string",
"maxLength": 250
},
"language": {
"description": "The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.",
"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
},
"username": {
"description": "The user's username. Cannot contain anything that looks like an url or whitespaces.",
"type": "string",
"maxLength": 250,
"minLength": 3
}
}
},
"v1.UserSettings": {
"type": "object",
"properties": {

View File

@ -3821,12 +3821,12 @@
"summary": "Register",
"parameters": [
{
"description": "The user credentials",
"description": "The user with credentials to create",
"name": "credentials",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/user.APIUserPassword"
"$ref": "#/definitions/v1.UserRegister"
}
}
],
@ -9371,32 +9371,6 @@
}
}
},
"user.APIUserPassword": {
"type": "object",
"properties": {
"email": {
"description": "The user's email address",
"type": "string",
"maxLength": 250
},
"id": {
"description": "The unique, numeric id of this user.",
"type": "integer"
},
"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
},
"username": {
"description": "The user's username. Cannot contain anything that looks like an url or whitespaces.",
"type": "string",
"maxLength": 250,
"minLength": 3
}
}
},
"user.EmailConfirm": {
"type": "object",
"properties": {
@ -9576,6 +9550,32 @@
}
}
},
"v1.UserRegister": {
"type": "object",
"properties": {
"email": {
"description": "The user's email address",
"type": "string",
"maxLength": 250
},
"language": {
"description": "The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.",
"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
},
"username": {
"description": "The user's username. Cannot contain anything that looks like an url or whitespaces.",
"type": "string",
"maxLength": 250,
"minLength": 3
}
}
},
"v1.UserSettings": {
"type": "object",
"properties": {

View File

@ -1291,30 +1291,6 @@ definitions:
code:
type: string
type: object
user.APIUserPassword:
properties:
email:
description: The user's email address
maxLength: 250
type: string
id:
description: The unique, numeric id of this user.
type: integer
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
username:
description: The user's username. Cannot contain anything that looks like
an url or whitespaces.
maxLength: 250
minLength: 3
type: string
type: object
user.EmailConfirm:
properties:
token:
@ -1443,6 +1419,31 @@ definitions:
password:
type: string
type: object
v1.UserRegister:
properties:
email:
description: The user's email address
maxLength: 250
type: string
language:
description: The language of the new user. Must be a valid IETF BCP 47 language
code and exist in Vikunja.
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
username:
description: The user's username. Cannot contain anything that looks like
an url or whitespaces.
maxLength: 250
minLength: 3
type: string
type: object
v1.UserSettings:
properties:
default_project_id:
@ -4309,12 +4310,12 @@ paths:
- application/json
description: Creates a new user account.
parameters:
- description: The user credentials
- description: The user with credentials to create
in: body
name: credentials
required: true
schema:
$ref: '#/definitions/user.APIUserPassword'
$ref: '#/definitions/v1.UserRegister'
produces:
- application/json
responses: