ami/tl-vikunja
1
0
Fork 0
Code

[skip ci] Updated swagger docs

Browse Source 
(cherry picked from commit 2b8515b91db6f90becfe150b351120e3b1afc726)
This commit is contained in:
Frederick [Bot] 2024-09-06 11:18:51 +00:00 committed by kolaente
parent 0b9f3070fd
commit 85445ea032
No known key found for this signature in database
GPG Key ID: F40E70337AB24C9B
3 changed files with 25 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
pkg/swagger/docs.go
View File

@ -4530,14 +4530,8 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "If set to true, a preview image will be returned if the attachment is an image.", "description": "The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px. If provided, a preview image will be returned if the attachment is an image.",
"name": "preview", "name": "preview_size",
"in": "query"
},
{
"type": "string",
"description": "The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px.",
"name": "size",
"in": "query" "in": "query"
} }
], ],
@ -7916,7 +7910,7 @@ const docTemplate = `{
} }
}, },
"attachments": { "attachments": {
"description": "All attachments this task has", "description": "All attachments this task has. This property is read-onlym, you must use the separate endpoint to add attachments to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.TaskAttachment" "$ref": "#/definitions/models.TaskAttachment"
@ -7984,7 +7978,7 @@ const docTemplate = `{
"type": "boolean" "type": "boolean"
}, },
"labels": { "labels": {
"description": "An array of labels which are associated with this task.", "description": "An array of labels which are associated with this task. This property is read-only, you must use the separate endpoint to add labels to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.Label" "$ref": "#/definitions/models.Label"
@ -8648,7 +8642,7 @@ const docTemplate = `{
} }
}, },
"attachments": { "attachments": {
"description": "All attachments this task has", "description": "All attachments this task has. This property is read-onlym, you must use the separate endpoint to add attachments to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.TaskAttachment" "$ref": "#/definitions/models.TaskAttachment"
@ -8716,7 +8710,7 @@ const docTemplate = `{
"type": "boolean" "type": "boolean"
}, },
"labels": { "labels": {
"description": "An array of labels which are associated with this task.", "description": "An array of labels which are associated with this task. This property is read-only, you must use the separate endpoint to add labels to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.Label" "$ref": "#/definitions/models.Label"

18
pkg/swagger/swagger.json
View File

@ -4522,14 +4522,8 @@
}, },
{ {
"type": "string", "type": "string",
"description": "If set to true, a preview image will be returned if the attachment is an image.", "description": "The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px. If provided, a preview image will be returned if the attachment is an image.",
"name": "preview", "name": "preview_size",
"in": "query"
},
{
"type": "string",
"description": "The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px.",
"name": "size",
"in": "query" "in": "query"
} }
], ],
@ -7908,7 +7902,7 @@
} }
}, },
"attachments": { "attachments": {
"description": "All attachments this task has", "description": "All attachments this task has. This property is read-onlym, you must use the separate endpoint to add attachments to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.TaskAttachment" "$ref": "#/definitions/models.TaskAttachment"
@ -7976,7 +7970,7 @@
"type": "boolean" "type": "boolean"
}, },
"labels": { "labels": {
"description": "An array of labels which are associated with this task.", "description": "An array of labels which are associated with this task. This property is read-only, you must use the separate endpoint to add labels to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.Label" "$ref": "#/definitions/models.Label"
@ -8640,7 +8634,7 @@
} }
}, },
"attachments": { "attachments": {
"description": "All attachments this task has", "description": "All attachments this task has. This property is read-onlym, you must use the separate endpoint to add attachments to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.TaskAttachment" "$ref": "#/definitions/models.TaskAttachment"
@ -8708,7 +8702,7 @@
"type": "boolean" "type": "boolean"
}, },
"labels": { "labels": {
"description": "An array of labels which are associated with this task.", "description": "An array of labels which are associated with this task. This property is read-only, you must use the separate endpoint to add labels to a task.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/models.Label" "$ref": "#/definitions/models.Label"

24
pkg/swagger/swagger.yaml
View File

@ -157,7 +157,8 @@ definitions:
$ref: '#/definitions/user.User' $ref: '#/definitions/user.User'
type: array type: array
attachments: attachments:
description: All attachments this task has description: All attachments this task has. This property is read-onlym, you
must use the separate endpoint to add attachments to a task.
items: items:
$ref: '#/definitions/models.TaskAttachment' $ref: '#/definitions/models.TaskAttachment'
type: array type: array
@ -213,7 +214,9 @@ definitions:
call to the api. call to the api.
type: boolean type: boolean
labels: labels:
description: An array of labels which are associated with this task. description: An array of labels which are associated with this task. This
property is read-only, you must use the separate endpoint to add labels
to a task.
items: items:
$ref: '#/definitions/models.Label' $ref: '#/definitions/models.Label'
type: array type: array
@ -726,7 +729,8 @@ definitions:
$ref: '#/definitions/user.User' $ref: '#/definitions/user.User'
type: array type: array
attachments: attachments:
description: All attachments this task has description: All attachments this task has. This property is read-onlym, you
must use the separate endpoint to add attachments to a task.
items: items:
$ref: '#/definitions/models.TaskAttachment' $ref: '#/definitions/models.TaskAttachment'
type: array type: array
@ -782,7 +786,9 @@ definitions:
call to the api. call to the api.
type: boolean type: boolean
labels: labels:
description: An array of labels which are associated with this task. description: An array of labels which are associated with this task. This
property is read-only, you must use the separate endpoint to add labels
to a task.
items: items:
$ref: '#/definitions/models.Label' $ref: '#/definitions/models.Label'
type: array type: array
@ -4625,15 +4631,11 @@ paths:
name: attachmentID name: attachmentID
required: true required: true
type: integer type: integer
- description: If set to true, a preview image will be returned if the attachment
is an image.
in: query
name: preview
type: string
- description: The size of the preview image. Can be sm = 100px, md = 200px, - description: The size of the preview image. Can be sm = 100px, md = 200px,
lg = 400px or xl = 800px. lg = 400px or xl = 800px. If provided, a preview image will be returned
if the attachment is an image.
in: query in: query
name: size name: preview_size
type: string type: string
produces: produces:
- application/octet-stream - application/octet-stream