diff options
author | Christopher Ng <chrng8@gmail.com> | 2024-07-31 14:53:25 -0700 |
---|---|---|
committer | Christopher Ng <chrng8@gmail.com> | 2024-08-01 09:17:56 -0700 |
commit | 012e2687ab9f4307b299dc1018794d1f22e93574 (patch) | |
tree | 7573ec7f3bd2f9202c7325655aa4f8967cb9f43b /apps/files/lib/Controller | |
parent | 8f27cd6d5d4b09b4e976889d648ee7160785bf00 (diff) | |
download | nextcloud-server-012e2687ab9f4307b299dc1018794d1f22e93574.tar.gz nextcloud-server-012e2687ab9f4307b299dc1018794d1f22e93574.zip |
feat(files): Update openapi spec
Signed-off-by: Christopher Ng <chrng8@gmail.com>
Diffstat (limited to 'apps/files/lib/Controller')
-rw-r--r-- | apps/files/lib/Controller/ApiController.php | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/apps/files/lib/Controller/ApiController.php b/apps/files/lib/Controller/ApiController.php index e5b9086995e..0d4503682b0 100644 --- a/apps/files/lib/Controller/ApiController.php +++ b/apps/files/lib/Controller/ApiController.php @@ -11,6 +11,7 @@ use OC\AppFramework\Middleware\Security\Exceptions\NotLoggedInException; use OC\Files\Node\Node; use OC\Files\Search\SearchComparison; use OC\Files\Search\SearchQuery; +use OCA\Files\ResponseDefinitions; use OCA\Files\Service\TagService; use OCA\Files\Service\UserConfig; use OCA\Files\Service\ViewConfig; @@ -46,6 +47,8 @@ use Psr\Log\LoggerInterface; use Throwable; /** + * @psalm-import-type FilesFolderTree from ResponseDefinitions + * * @package OCA\Files\Controller */ class ApiController extends Controller { @@ -265,7 +268,12 @@ class ApiController extends Controller { } /** - * Returns a folder tree for the user. + * Returns the folder tree of the user + * + * @return JSONResponse<Http::STATUS_OK, FilesFolderTree, array{}>|JSONResponse<Http::STATUS_UNAUTHORIZED, array{message: string}, array{}> + * + * 200: Folder tree returned successfully + * 401: Unauthorized */ #[NoAdminRequired] #[ApiRoute(verb: 'GET', url: '/api/v1/folder-tree')] |