diff options
Diffstat (limited to 'apps/files_sharing/lib/Controller/DeletedShareAPIController.php')
| -rw-r--r-- | apps/files_sharing/lib/Controller/DeletedShareAPIController.php | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/apps/files_sharing/lib/Controller/DeletedShareAPIController.php b/apps/files_sharing/lib/Controller/DeletedShareAPIController.php index 33bd9eeb4cd..ddd3816022e 100644 --- a/apps/files_sharing/lib/Controller/DeletedShareAPIController.php +++ b/apps/files_sharing/lib/Controller/DeletedShareAPIController.php @@ -11,6 +11,7 @@ declare(strict_types=1); * @author John Molakvoæ <skjnldsv@protonmail.com> * @author Julius Härtl <jus@bitgrid.net> * @author Roeland Jago Douma <roeland@famdouma.nl> + * @author Kate Döen <kate.doeen@nextcloud.com> * * @license GNU AGPL version 3 or any later version * @@ -30,7 +31,9 @@ declare(strict_types=1); */ namespace OCA\Files_Sharing\Controller; +use OCA\Files_Sharing\ResponseDefinitions; use OCP\App\IAppManager; +use OCP\AppFramework\Http; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCS\OCSException; use OCP\AppFramework\OCS\OCSNotFoundException; @@ -47,6 +50,9 @@ use OCP\Share\Exceptions\ShareNotFound; use OCP\Share\IManager as ShareManager; use OCP\Share\IShare; +/** + * @psalm-import-type FilesSharingDeletedShare from ResponseDefinitions + */ class DeletedShareAPIController extends OCSController { /** @var ShareManager */ @@ -92,6 +98,8 @@ class DeletedShareAPIController extends OCSController { /** * @suppress PhanUndeclaredClassMethod + * + * @return FilesSharingDeletedShare */ private function formatShare(IShare $share): array { $result = [ @@ -176,6 +184,10 @@ class DeletedShareAPIController extends OCSController { /** * @NoAdminRequired + * + * Get a list of all deleted shares + * + * @return DataResponse<Http::STATUS_OK, FilesSharingDeletedShare[], array{}> */ public function index(): DataResponse { $groupShares = $this->shareManager->getDeletedSharedWith($this->userId, IShare::TYPE_GROUP, null, -1, 0); @@ -195,7 +207,14 @@ class DeletedShareAPIController extends OCSController { /** * @NoAdminRequired * + * Undelete a deleted share + * + * @param string $id ID of the share + * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * @throws OCSNotFoundException Share not found + * + * 200: Share undeleted successfully */ public function undelete(string $id): DataResponse { try { |