chore(core): Deprecate PreviewController::getPreview() endpoint

provokateurin · provokateurin · commit 03f892c4d9d1 · 2025-02-03T10:58:39.000+01:00
Signed-off-by: provokateurin &lt;kate@provokateurin.de&gt;
diff --git a/core/Controller/PreviewController.php b/core/Controller/PreviewController.php
@@ -42,6 +42,8 @@ public function __construct(
 	/**
 	 * Get a preview by file path
 	 *
+	 * Deprecated: Use getPreviewByFileId instead
+	 * @deprecated Use getPreviewByFileId instead
 	 * @param string $file Path of the file
 	 * @param int $x Width of the preview. A width of -1 will use the original image width.
 	 * @param int $y Height of the preview. A height of -1 will use the original image height.
diff --git a/core/openapi-full.json b/core/openapi-full.json
@@ -8197,6 +8197,8 @@
             "get": {
                 "operationId": "preview-get-preview",
                 "summary": "Get a preview by file path",
+                "description": "Deprecated: Use getPreviewByFileId instead",
+                "deprecated": true,
                 "tags": [
                     "preview"
                 ],
diff --git a/core/openapi.json b/core/openapi.json
@@ -8197,6 +8197,8 @@
             "get": {
                 "operationId": "preview-get-preview",
                 "summary": "Get a preview by file path",
+                "description": "Deprecated: Use getPreviewByFileId instead",
+                "deprecated": true,
                 "tags": [
                     "preview"
                 ],

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,8 @@ public function __construct(`
`42`	`42`	`/**`
`43`	`43`	`* Get a preview by file path`
`44`	`44`	`*`
	`45`	`+ * Deprecated: Use getPreviewByFileId instead`
	`46`	`+ * @deprecated Use getPreviewByFileId instead`
`45`	`47`	`* @param string $file Path of the file`
`46`	`48`	`* @param int $x Width of the preview. A width of -1 will use the original image width.`
`47`	`49`	`* @param int $y Height of the preview. A height of -1 will use the original image height.`