aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_trashbin/lib/Controller
diff options
context:
space:
mode:
authorjld3103 <jld3103yt@gmail.com>2023-06-14 16:36:05 +0200
committerjld3103 <jld3103yt@gmail.com>2023-07-13 06:26:58 +0200
commit99dc010670c91b2cbe062fbeea22ae6d9e48c6e0 (patch)
tree889d727dc19ab7eb478697787b1da541f28224cb /apps/files_trashbin/lib/Controller
parent706c141fffce928d344fe2f039da549fad065393 (diff)
downloadnextcloud-server-99dc010670c91b2cbe062fbeea22ae6d9e48c6e0.tar.gz
nextcloud-server-99dc010670c91b2cbe062fbeea22ae6d9e48c6e0.zip
files_trashbin: Add OpenAPI spec
Signed-off-by: jld3103 <jld3103yt@gmail.com>
Diffstat (limited to 'apps/files_trashbin/lib/Controller')
-rw-r--r--apps/files_trashbin/lib/Controller/PreviewController.php13
1 files changed, 12 insertions, 1 deletions
diff --git a/apps/files_trashbin/lib/Controller/PreviewController.php b/apps/files_trashbin/lib/Controller/PreviewController.php
index 9f60cc8b0b2..e62a793a98f 100644
--- a/apps/files_trashbin/lib/Controller/PreviewController.php
+++ b/apps/files_trashbin/lib/Controller/PreviewController.php
@@ -85,7 +85,18 @@ class PreviewController extends Controller {
* @NoAdminRequired
* @NoCSRFRequired
*
- * @return DataResponse|Http\FileDisplayResponse
+ * Get the preview for a file
+ *
+ * @param int $fileId ID of the file
+ * @param int $x Width of the preview
+ * @param int $y Height of the preview
+ * @param bool $a Whether to not crop the preview
+ *
+ * @return Http\FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+ *
+ * 200: Preview returned
+ * 400: Getting preview is not possible
+ * 404: Preview not found
*/
public function getPreview(
int $fileId = -1,