diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index 23f46aacc..9846cd078 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -4530,14 +4530,8 @@ const docTemplate = `{ }, { "type": "string", - "description": "If set to true, a preview image will be returned if the attachment is an image.", - "name": "preview", - "in": "query" - }, - { - "type": "string", - "description": "The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px.", - "name": "size", + "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_size", "in": "query" } ], @@ -7916,7 +7910,7 @@ const docTemplate = `{ } }, "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", "items": { "$ref": "#/definitions/models.TaskAttachment" @@ -7984,7 +7978,7 @@ const docTemplate = `{ "type": "boolean" }, "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", "items": { "$ref": "#/definitions/models.Label" @@ -8648,7 +8642,7 @@ const docTemplate = `{ } }, "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", "items": { "$ref": "#/definitions/models.TaskAttachment" @@ -8716,7 +8710,7 @@ const docTemplate = `{ "type": "boolean" }, "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", "items": { "$ref": "#/definitions/models.Label" diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index aa456388f..e55f8e430 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -4522,14 +4522,8 @@ }, { "type": "string", - "description": "If set to true, a preview image will be returned if the attachment is an image.", - "name": "preview", - "in": "query" - }, - { - "type": "string", - "description": "The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px.", - "name": "size", + "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_size", "in": "query" } ], @@ -7908,7 +7902,7 @@ } }, "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", "items": { "$ref": "#/definitions/models.TaskAttachment" @@ -7976,7 +7970,7 @@ "type": "boolean" }, "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", "items": { "$ref": "#/definitions/models.Label" @@ -8640,7 +8634,7 @@ } }, "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", "items": { "$ref": "#/definitions/models.TaskAttachment" @@ -8708,7 +8702,7 @@ "type": "boolean" }, "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", "items": { "$ref": "#/definitions/models.Label" diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index 9ce883586..2776d7ff4 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -157,7 +157,8 @@ definitions: $ref: '#/definitions/user.User' type: array 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: $ref: '#/definitions/models.TaskAttachment' type: array @@ -213,7 +214,9 @@ definitions: call to the api. type: boolean 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: $ref: '#/definitions/models.Label' type: array @@ -726,7 +729,8 @@ definitions: $ref: '#/definitions/user.User' type: array 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: $ref: '#/definitions/models.TaskAttachment' type: array @@ -782,7 +786,9 @@ definitions: call to the api. type: boolean 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: $ref: '#/definitions/models.Label' type: array @@ -4625,15 +4631,11 @@ paths: name: attachmentID required: true 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, - 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 - name: size + name: preview_size type: string produces: - application/octet-stream