From 3ecc81094f292ece1c426fc81ff2e3c05bef3574 Mon Sep 17 00:00:00 2001 From: "Frederick [Bot]" Date: Fri, 19 Jul 2024 10:01:46 +0000 Subject: [PATCH] [skip ci] Updated swagger docs (cherry picked from commit 0984821b41f5f8c3eeddf81c4ad75df67c065d74) --- pkg/swagger/docs.go | 12 ++++++++++++ pkg/swagger/swagger.json | 12 ++++++++++++ pkg/swagger/swagger.yaml | 10 ++++++++++ 3 files changed, 34 insertions(+) diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index 1f0c57fe6..7c29b58e2 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -4527,6 +4527,18 @@ const docTemplate = `{ "name": "attachmentID", "in": "path", "required": true + }, + { + "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", + "in": "query" } ], "responses": { diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index 653edd99a..a30ca1570 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -4519,6 +4519,18 @@ "name": "attachmentID", "in": "path", "required": true + }, + { + "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", + "in": "query" } ], "responses": { diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index 63e863e9c..b472d8d8e 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -4629,6 +4629,16 @@ 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. + in: query + name: size + type: string produces: - application/octet-stream responses: