diff options
Diffstat (limited to 'core/Controller/ReferenceController.php')
| -rw-r--r-- | core/Controller/ReferenceController.php | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/core/Controller/ReferenceController.php b/core/Controller/ReferenceController.php index a8a489aeeab..cec2dc90cf5 100644 --- a/core/Controller/ReferenceController.php +++ b/core/Controller/ReferenceController.php @@ -5,6 +5,7 @@ declare(strict_types=1); * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net> * * @author Julius Härtl <jus@bitgrid.net> + * @author Kate Döen <kate.doeen@nextcloud.com> * * @license GNU AGPL version 3 or any later version * @@ -24,7 +25,6 @@ declare(strict_types=1); namespace OC\Core\Controller; -use OCP\AppFramework\Http\Response; use OCP\Collaboration\Reference\IReferenceManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; @@ -48,10 +48,16 @@ class ReferenceController extends Controller { /** * @PublicPage * @NoCSRFRequired + * + * Get a preview for a reference + * * @param string $referenceId the reference cache key - * @return Response + * @return DataDownloadResponse<Http::STATUS_OK, string, array{}>|DataResponse<Http::STATUS_NOT_FOUND, '', array{}> + * + * 200: Preview returned + * 404: Reference not found */ - public function preview(string $referenceId): Response { + public function preview(string $referenceId): DataDownloadResponse|DataResponse { $reference = $this->referenceManager->getReferenceByCacheKey($referenceId); try { |