diff options
| author | provokateurin <kate@provokateurin.de> | 2024-05-16 14:56:12 +0200 |
|---|---|---|
| committer | provokateurin <kate@provokateurin.de> | 2024-05-16 14:57:34 +0200 |
| commit | 4c375c98a464c382c5a019d4716c88fce33b9ffc (patch) | |
| tree | 5c4e226cc558bbb101b62f884fec3601b134e115 /core/Controller/TaskProcessingApiController.php | |
| parent | eabbb731730e228a9295f8fbfb613a1934f7f839 (diff) | |
| download | nextcloud-server-4c375c98a464c382c5a019d4716c88fce33b9ffc.tar.gz nextcloud-server-4c375c98a464c382c5a019d4716c88fce33b9ffc.zip | |
docs(TaskProcessingApi): Set correct status code messages
Signed-off-by: provokateurin <kate@provokateurin.de>
Diffstat (limited to 'core/Controller/TaskProcessingApiController.php')
| -rw-r--r-- | core/Controller/TaskProcessingApiController.php | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/core/Controller/TaskProcessingApiController.php b/core/Controller/TaskProcessingApiController.php index 5b2e1d24dfa..00551b5d3e2 100644 --- a/core/Controller/TaskProcessingApiController.php +++ b/core/Controller/TaskProcessingApiController.php @@ -178,7 +178,7 @@ class TaskProcessingApiController extends \OCP\AppFramework\OCSController { * * @return DataResponse<Http::STATUS_OK, null, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}> * - * 200: Task returned + * 200: Task deleted */ #[NoAdminRequired] #[ApiRoute(verb: 'DELETE', url: '/task/{id}', root: '/taskprocessing')] @@ -204,7 +204,7 @@ class TaskProcessingApiController extends \OCP\AppFramework\OCSController { * @param string|null $customId An arbitrary identifier for the task * @return DataResponse<Http::STATUS_OK, array{tasks: CoreTaskProcessingTask[]}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}> * - * 200: Task list returned + * 200: Tasks returned */ #[NoAdminRequired] #[ApiRoute(verb: 'GET', url: '/tasks/app/{appId}', root: '/taskprocessing')] @@ -233,7 +233,7 @@ class TaskProcessingApiController extends \OCP\AppFramework\OCSController { * @param string|null $customId An arbitrary identifier for the task * @return DataResponse<Http::STATUS_OK, array{tasks: CoreTaskProcessingTask[]}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}> * - * 200: Task list returned + * 200: Tasks returned */ #[NoAdminRequired] #[ApiRoute(verb: 'GET', url: '/tasks', root: '/taskprocessing')] @@ -338,7 +338,7 @@ class TaskProcessingApiController extends \OCP\AppFramework\OCSController { * @param float $progress The progress * @return DataResponse<Http::STATUS_OK, array{task: CoreTaskProcessingTask}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}> * - * 200: File content returned + * 200: Progress updated successfully * 404: Task not found */ #[NoAdminRequired] @@ -369,7 +369,7 @@ class TaskProcessingApiController extends \OCP\AppFramework\OCSController { * @param string|null $errorMessage An error message if the task failed * @return DataResponse<Http::STATUS_OK, array{task: CoreTaskProcessingTask}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}> * - * 200: File content returned + * 200: Result updated successfully * 404: Task not found */ #[NoAdminRequired] @@ -401,7 +401,7 @@ class TaskProcessingApiController extends \OCP\AppFramework\OCSController { * @param int $taskId The id of the task * @return DataResponse<Http::STATUS_OK, array{task: CoreTaskProcessingTask}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}> * - * 200: File content returned + * 200: Task canceled successfully * 404: Task not found */ #[NoAdminRequired] |