kodev-org
/
vikunja
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[skip ci] Updated swagger docs

This commit is contained in:
Frederick [Bot] 2026-06-11 07:42:32 +00:00
parent 28af57bc93
commit 05b10e34d8
3 changed files with 122 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
pkg/swagger/docs.go
View File

@ -7848,7 +7848,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UserSettings"
"$ref": "#/definitions/models.UserGeneralSettings"
}
}
],
@ -10630,6 +10630,49 @@ const docTemplate = `{
}
}
},
"models.UserGeneralSettings": {
"type": "object",
"properties": {
"default_project_id": {
"type": "integer"
},
"discoverable_by_email": {
"type": "boolean"
},
"discoverable_by_name": {
"type": "boolean"
},
"email_reminders_enabled": {
"type": "boolean"
},
"extra_settings_links": {
"description": "Server/OpenID-provided; populated on read, ignored on write.",
"type": "object",
"additionalProperties": {}
},
"frontend_settings": {},
"language": {
"type": "string"
},
"name": {
"type": "string"
},
"overdue_tasks_reminders_enabled": {
"type": "boolean"
},
"overdue_tasks_reminders_time": {
"type": "string"
},
"timezone": {
"type": "string"
},
"week_start": {
"type": "integer",
"maximum": 6,
"minimum": 0
}
}
},
"models.UserWithPermission": {
"type": "object",
"properties": {
@ -11027,59 +11070,6 @@ const docTemplate = `{
}
}
},
"v1.UserSettings": {
"type": "object",
"properties": {
"default_project_id": {
"description": "If a task is created without a specified project this value should be used. Applies\nto tasks made directly in API and from clients.",
"type": "integer"
},
"discoverable_by_email": {
"description": "If true, the user can be found when searching for their exact email.",
"type": "boolean"
},
"discoverable_by_name": {
"description": "If true, this user can be found by their name or parts of it when searching for it.",
"type": "boolean"
},
"email_reminders_enabled": {
"description": "If enabled, sends email reminders of tasks to the user.",
"type": "boolean"
},
"extra_settings_links": {
"description": "Additional settings links as provided by openid",
"type": "object",
"additionalProperties": {}
},
"frontend_settings": {
"description": "Additional settings only used by the frontend"
},
"language": {
"description": "The user's language",
"type": "string"
},
"name": {
"description": "The new name of the current user.",
"type": "string"
},
"overdue_tasks_reminders_enabled": {
"description": "If enabled, the user will get an email for their overdue tasks each morning.",
"type": "boolean"
},
"overdue_tasks_reminders_time": {
"description": "The time when the daily summary of overdue tasks will be sent via email.",
"type": "string"
},
"timezone": {
"description": "The user's time zone. Used to send task reminders in the time zone of the user.",
"type": "string"
},
"week_start": {
"description": "The day when the week starts for this user. 0 = sunday, 1 = monday, etc.",
"type": "integer"
}
}
},
"v1.UserWithSettings": {
"type": "object",
"properties": {
@ -11117,7 +11107,7 @@ const docTemplate = `{
"type": "string"
},
"settings": {
"$ref": "#/definitions/v1.UserSettings"
"$ref": "#/definitions/models.UserGeneralSettings"
},
"updated": {
"description": "A timestamp when this task was last updated. You cannot change this value.",

100
pkg/swagger/swagger.json
View File

@ -7840,7 +7840,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UserSettings"
"$ref": "#/definitions/models.UserGeneralSettings"
}
}
],
@ -10622,6 +10622,49 @@
}
}
},
"models.UserGeneralSettings": {
"type": "object",
"properties": {
"default_project_id": {
"type": "integer"
},
"discoverable_by_email": {
"type": "boolean"
},
"discoverable_by_name": {
"type": "boolean"
},
"email_reminders_enabled": {
"type": "boolean"
},
"extra_settings_links": {
"description": "Server/OpenID-provided; populated on read, ignored on write.",
"type": "object",
"additionalProperties": {}
},
"frontend_settings": {},
"language": {
"type": "string"
},
"name": {
"type": "string"
},
"overdue_tasks_reminders_enabled": {
"type": "boolean"
},
"overdue_tasks_reminders_time": {
"type": "string"
},
"timezone": {
"type": "string"
},
"week_start": {
"type": "integer",
"maximum": 6,
"minimum": 0
}
}
},
"models.UserWithPermission": {
"type": "object",
"properties": {
@ -11019,59 +11062,6 @@
}
}
},
"v1.UserSettings": {
"type": "object",
"properties": {
"default_project_id": {
"description": "If a task is created without a specified project this value should be used. Applies\nto tasks made directly in API and from clients.",
"type": "integer"
},
"discoverable_by_email": {
"description": "If true, the user can be found when searching for their exact email.",
"type": "boolean"
},
"discoverable_by_name": {
"description": "If true, this user can be found by their name or parts of it when searching for it.",
"type": "boolean"
},
"email_reminders_enabled": {
"description": "If enabled, sends email reminders of tasks to the user.",
"type": "boolean"
},
"extra_settings_links": {
"description": "Additional settings links as provided by openid",
"type": "object",
"additionalProperties": {}
},
"frontend_settings": {
"description": "Additional settings only used by the frontend"
},
"language": {
"description": "The user's language",
"type": "string"
},
"name": {
"description": "The new name of the current user.",
"type": "string"
},
"overdue_tasks_reminders_enabled": {
"description": "If enabled, the user will get an email for their overdue tasks each morning.",
"type": "boolean"
},
"overdue_tasks_reminders_time": {
"description": "The time when the daily summary of overdue tasks will be sent via email.",
"type": "string"
},
"timezone": {
"description": "The user's time zone. Used to send task reminders in the time zone of the user.",
"type": "string"
},
"week_start": {
"description": "The day when the week starts for this user. 0 = sunday, 1 = monday, etc.",
"type": "integer"
}
}
},
"v1.UserWithSettings": {
"type": "object",
"properties": {
@ -11109,7 +11099,7 @@
"type": "string"
},
"settings": {
"$ref": "#/definitions/v1.UserSettings"
"$ref": "#/definitions/models.UserGeneralSettings"
},
"updated": {
"description": "A timestamp when this task was last updated. You cannot change this value.",

81
pkg/swagger/swagger.yaml
View File

@ -1333,6 +1333,36 @@ definitions:
this value.
type: string
type: object
models.UserGeneralSettings:
properties:
default_project_id:
type: integer
discoverable_by_email:
type: boolean
discoverable_by_name:
type: boolean
email_reminders_enabled:
type: boolean
extra_settings_links:
additionalProperties: {}
description: Server/OpenID-provided; populated on read, ignored on write.
type: object
frontend_settings: {}
language:
type: string
name:
type: string
overdue_tasks_reminders_enabled:
type: boolean
overdue_tasks_reminders_time:
type: string
timezone:
type: string
week_start:
maximum: 6
minimum: 0
type: integer
type: object
models.UserWithPermission:
properties:
bot_owner_id:
@ -1640,53 +1670,6 @@ definitions:
minLength: 3
type: string
type: object
v1.UserSettings:
properties:
default_project_id:
description: |-
If a task is created without a specified project this value should be used. Applies
to tasks made directly in API and from clients.
type: integer
discoverable_by_email:
description: If true, the user can be found when searching for their exact
email.
type: boolean
discoverable_by_name:
description: If true, this user can be found by their name or parts of it
when searching for it.
type: boolean
email_reminders_enabled:
description: If enabled, sends email reminders of tasks to the user.
type: boolean
extra_settings_links:
additionalProperties: {}
description: Additional settings links as provided by openid
type: object
frontend_settings:
description: Additional settings only used by the frontend
language:
description: The user's language
type: string
name:
description: The new name of the current user.
type: string
overdue_tasks_reminders_enabled:
description: If enabled, the user will get an email for their overdue tasks
each morning.
type: boolean
overdue_tasks_reminders_time:
description: The time when the daily summary of overdue tasks will be sent
via email.
type: string
timezone:
description: The user's time zone. Used to send task reminders in the time
zone of the user.
type: string
week_start:
description: The day when the week starts for this user. 0 = sunday, 1 = monday,
etc.
type: integer
type: object
v1.UserWithSettings:
properties:
auth_provider:
@ -1717,7 +1700,7 @@ definitions:
description: The full name of the user.
type: string
settings:
$ref: '#/definitions/v1.UserSettings'
$ref: '#/definitions/models.UserGeneralSettings'
updated:
description: A timestamp when this task was last updated. You cannot change
this value.
@ -7199,7 +7182,7 @@ paths:
name: avatar
required: true
schema:
$ref: '#/definitions/v1.UserSettings'
$ref: '#/definitions/models.UserGeneralSettings'
produces:
- application/json
responses: