Merge pull request #45354 from nextcloud/docs/taskprocessingapi/cleanup-endpoint-descriptions

provokateurin · web-flow · commit 7bc4ccba6ad8 · 2024-05-16T20:09:06.000+02:00
diff --git a/core/Controller/TaskProcessingApiController.php b/core/Controller/TaskProcessingApiController.php
@@ -35,14 +35,10 @@
 use OCP\AppFramework\Http\Attribute\UserRateLimit;
 use OCP\AppFramework\Http\DataDownloadResponse;
 use OCP\AppFramework\Http\DataResponse;
-use OCP\Common\Exception\NotFoundException;
 use OCP\Files\File;
-use OCP\Files\GenericFileException;
 use OCP\Files\IRootFolder;
-use OCP\Files\NotPermittedException;
 use OCP\IL10N;
 use OCP\IRequest;
-use OCP\Lock\LockedException;
 use OCP\TaskProcessing\EShapeType;
 use OCP\TaskProcessing\Exception\Exception;
 use OCP\TaskProcessing\Exception\UnauthorizedException;
@@ -67,7 +63,7 @@ public function __construct(
 	}
 
 	/**
-	 * This endpoint returns all available TaskProcessing task types
+	 * Returns all available TaskProcessing task types
 	 *
 	 * @return DataResponse<Http::STATUS_OK, array{types: array<string, CoreTaskProcessingTaskType>}, array{}>
 	 *
@@ -100,7 +96,7 @@ public function taskTypes(): DataResponse {
 	}
 
 	/**
-	 * This endpoint allows scheduling a task
+	 * Schedules a task
 	 *
 	 * @param array<string, mixed> $input Task's input parameters
 	 * @param string $type Type of the task
@@ -141,7 +137,8 @@ public function schedule(array $input, string $type, string $appId, string $cust
 	}
 
 	/**
-	 * This endpoint allows checking the status and results of a task.
+	 * Gets a task including status and result
+	 *
 	 * Tasks are removed 1 week after receiving their last update
 	 *
 	 * @param int $id The id of the task
@@ -163,21 +160,21 @@ public function getTask(int $id): DataResponse {
 			return new DataResponse([
 				'task' => $json,
 			]);
-		} catch (NotFoundException $e) {
+		} catch (\OCP\TaskProcessing\Exception\NotFoundException $e) {
 			return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
 		} catch (\RuntimeException $e) {
 			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 	}
 
 	/**
-	 * This endpoint allows to delete a scheduled task for a user
+	 * Deletes a task
 	 *
 	 * @param int $id The id of the task
 	 *
 	 * @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')]
@@ -197,14 +194,13 @@ public function deleteTask(int $id): DataResponse {
 
 
 	/**
-	 * This endpoint returns a list of tasks of a user that are related
-	 * with a specific appId and optionally with an identifier
+	 * Returns tasks for the current user filtered by the appId and optional customId
 	 *
 	 * @param string $appId ID of the app
 	 * @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')]
@@ -221,24 +217,21 @@ public function listTasksByApp(string $appId, ?string $customId = null): DataRes
 			]);
 		} catch (Exception $e) {
 			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		} catch (\JsonException $e) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 	}
 
 	/**
-	 * This endpoint returns a list of tasks of a user that are related
-	 * with a specific appId and optionally with an identifier
+	 * Returns tasks for the current user filtered by the optional taskType and optional customId
 	 *
 	 * @param string|null $taskType The task type to filter by
 	 * @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')]
-	public function listTasksByUser(?string $taskType, ?string $customId = null): DataResponse {
+	public function listTasks(?string $taskType, ?string $customId = null): DataResponse {
 		try {
 			$tasks = $this->taskProcessingManager->getUserTasks($this->userId, $taskType, $customId);
 			/** @var CoreTaskProcessingTask[] $json */
@@ -251,13 +244,11 @@ public function listTasksByUser(?string $taskType, ?string $customId = null): Da
 			]);
 		} catch (Exception $e) {
 			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		} catch (\JsonException $e) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 	}
 
 	/**
-	 * This endpoint returns the contents of a file referenced in a task
+	 * Returns the contents of a file referenced in a task
 	 *
 	 * @param int $taskId The id of the task
 	 * @param int $fileId The file id of the file to retrieve
@@ -288,7 +279,7 @@ public function getFileContents(int $taskId, int $fileId): Http\DataDownloadResp
 			return new Http\DataDownloadResponse($node->getContent(), $node->getName(), $node->getMimeType());
 		} catch (\OCP\TaskProcessing\Exception\NotFoundException $e) {
 			return new DataResponse(['message' => $this->l->t('Not found')], Http::STATUS_NOT_FOUND);
-		} catch (GenericFileException|NotPermittedException|LockedException|Exception $e) {
+		} catch (Exception $e) {
 			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 	}
@@ -333,13 +324,13 @@ private function extractFileIdsFromTask(Task $task): array {
 	}
 
 	/**
-	 * This endpoint sets the task progress
+	 * Sets the task progress
 	 *
 	 * @param int $taskId The id of the task
 	 * @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]
@@ -363,14 +354,14 @@ public function setProgress(int $taskId, float $progress): DataResponse {
 	}
 
 	/**
-	 * This endpoint sets the task progress
+	 * Sets the task result
 	 *
 	 * @param int $taskId The id of the task
 	 * @param array<string,mixed>|null $output The resulting task output
 	 * @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]
@@ -397,12 +388,12 @@ public function setResult(int $taskId, ?array $output = null, ?string $errorMess
 	}
 
 	/**
-	 * This endpoint cancels a task
+	 * Cancels a task
 	 *
 	 * @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]
diff --git a/core/openapi.json b/core/openapi.json
@@ -3345,7 +3345,7 @@
         "/ocs/v2.php/taskprocessing/tasktypes": {
             "get": {
                 "operationId": "task_processing_api-task-types",
-                "summary": "This endpoint returns all available TaskProcessing task types",
+                "summary": "Returns all available TaskProcessing task types",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -3418,7 +3418,7 @@
         "/ocs/v2.php/taskprocessing/schedule": {
             "post": {
                 "operationId": "task_processing_api-schedule",
-                "summary": "This endpoint allows scheduling a task",
+                "summary": "Schedules a task",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -3676,7 +3676,8 @@
         "/ocs/v2.php/taskprocessing/task/{id}": {
             "get": {
                 "operationId": "task_processing_api-get-task",
-                "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update",
+                "summary": "Gets a task including status and result",
+                "description": "Tasks are removed 1 week after receiving their last update",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -3830,7 +3831,7 @@
             },
             "delete": {
                 "operationId": "task_processing_api-delete-task",
-                "summary": "This endpoint allows to delete a scheduled task for a user",
+                "summary": "Deletes a task",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -3866,7 +3867,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Task returned",
+                        "description": "Task deleted",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3939,7 +3940,7 @@
         "/ocs/v2.php/taskprocessing/tasks/app/{appId}": {
             "get": {
                 "operationId": "task_processing_api-list-tasks-by-app",
-                "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
+                "summary": "Returns tasks for the current user filtered by the appId and optional customId",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -3983,7 +3984,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Task list returned",
+                        "description": "Tasks returned",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4066,8 +4067,8 @@
         },
         "/ocs/v2.php/taskprocessing/tasks": {
             "get": {
-                "operationId": "task_processing_api-list-tasks-by-user",
-                "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
+                "operationId": "task_processing_api-list-tasks",
+                "summary": "Returns tasks for the current user filtered by the optional taskType and optional customId",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -4111,7 +4112,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Task list returned",
+                        "description": "Tasks returned",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4195,7 +4196,7 @@
         "/ocs/v2.php/taskprocessing/tasks/{taskId}/file/{fileId}": {
             "get": {
                 "operationId": "task_processing_api-get-file-contents",
-                "summary": "This endpoint returns the contents of a file referenced in a task",
+                "summary": "Returns the contents of a file referenced in a task",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -4333,7 +4334,7 @@
         "/ocs/v2.php/taskprocessing/tasks/{taskId}/progress": {
             "post": {
                 "operationId": "task_processing_api-set-progress",
-                "summary": "This endpoint sets the task progress",
+                "summary": "Sets the task progress",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -4379,7 +4380,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "File content returned",
+                        "description": "Progress updated successfully",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4498,7 +4499,7 @@
         "/ocs/v2.php/taskprocessing/tasks/{taskId}/result": {
             "post": {
                 "operationId": "task_processing_api-set-result",
-                "summary": "This endpoint sets the task progress",
+                "summary": "Sets the task result",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -4552,7 +4553,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "File content returned",
+                        "description": "Result updated successfully",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4671,7 +4672,7 @@
         "/ocs/v2.php/taskprocessing/tasks/{taskId}/cancel": {
             "post": {
                 "operationId": "task_processing_api-cancel-task",
-                "summary": "This endpoint cancels a task",
+                "summary": "Cancels a task",
                 "tags": [
                     "task_processing_api"
                 ],
@@ -4707,7 +4708,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "File content returned",
+                        "description": "Task canceled successfully",
                         "content": {
                             "application/json": {
                                 "schema": {

Original file line number	Diff line number	Diff line change
`@@ -35,14 +35,10 @@`
`35`	`35`	`use OCP\AppFramework\Http\Attribute\UserRateLimit;`
`36`	`36`	`use OCP\AppFramework\Http\DataDownloadResponse;`
`37`	`37`	`use OCP\AppFramework\Http\DataResponse;`
`38`		`-use OCP\Common\Exception\NotFoundException;`
`39`	`38`	`use OCP\Files\File;`
`40`		`-use OCP\Files\GenericFileException;`
`41`	`39`	`use OCP\Files\IRootFolder;`
`42`		`-use OCP\Files\NotPermittedException;`
`43`	`40`	`use OCP\IL10N;`
`44`	`41`	`use OCP\IRequest;`
`45`		`-use OCP\Lock\LockedException;`
`46`	`42`	`use OCP\TaskProcessing\EShapeType;`
`47`	`43`	`use OCP\TaskProcessing\Exception\Exception;`
`48`	`44`	`use OCP\TaskProcessing\Exception\UnauthorizedException;`
`@@ -67,7 +63,7 @@ public function __construct(`
`67`	`63`	`}`
`68`	`64`
`69`	`65`	`/**`
`70`		`- * This endpoint returns all available TaskProcessing task types`
	`66`	`+ * Returns all available TaskProcessing task types`
`71`	`67`	`*`
`72`	`68`	`* @return DataResponse<Http::STATUS_OK, array{types: array<string, CoreTaskProcessingTaskType>}, array{}>`
`73`	`69`	`*`
`@@ -100,7 +96,7 @@ public function taskTypes(): DataResponse {`
`100`	`96`	`}`
`101`	`97`
`102`	`98`	`/**`
`103`		`- * This endpoint allows scheduling a task`
	`99`	`+ * Schedules a task`
`104`	`100`	`*`
`105`	`101`	`* @param array<string, mixed> $input Task's input parameters`
`106`	`102`	`* @param string $type Type of the task`
`@@ -141,7 +137,8 @@ public function schedule(array $input, string $type, string $appId, string $cust`
`141`	`137`	`}`
`142`	`138`
`143`	`139`	`/**`
`144`		`- * This endpoint allows checking the status and results of a task.`
	`140`	`+ * Gets a task including status and result`
	`141`	`+ *`
`145`	`142`	`* Tasks are removed 1 week after receiving their last update`
`146`	`143`	`*`
`147`	`144`	`* @param int $id The id of the task`
`@@ -163,21 +160,21 @@ public function getTask(int $id): DataResponse {`
`163`	`160`	`return new DataResponse([`
`164`	`161`	`'task' => $json,`
`165`	`162`	`]);`
`166`		`- } catch (NotFoundException $e) {`
	`163`	`+ } catch (\OCP\TaskProcessing\Exception\NotFoundException $e) {`
`167`	`164`	`return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);`
`168`	`165`	`} catch (\RuntimeException $e) {`
`169`	`166`	`return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);`
`170`	`167`	`}`
`171`	`168`	`}`
`172`	`169`
`173`	`170`	`/**`
`174`		`- * This endpoint allows to delete a scheduled task for a user`
	`171`	`+ * Deletes a task`
`175`	`172`	`*`
`176`	`173`	`* @param int $id The id of the task`
`177`	`174`	`*`
`178`	`175`	`* @return DataResponse<Http::STATUS_OK, null, array{}>\|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>`
`179`	`176`	`*`
`180`		`- * 200: Task returned`
	`177`	`+ * 200: Task deleted`
`181`	`178`	`*/`
`182`	`179`	`#[NoAdminRequired]`
`183`	`180`	`#[ApiRoute(verb: 'DELETE', url: '/task/{id}', root: '/taskprocessing')]`
`@@ -197,14 +194,13 @@ public function deleteTask(int $id): DataResponse {`
`197`	`194`
`198`	`195`
`199`	`196`	`/**`
`200`		`- * This endpoint returns a list of tasks of a user that are related`
`201`		`- * with a specific appId and optionally with an identifier`
	`197`	`+ * Returns tasks for the current user filtered by the appId and optional customId`
`202`	`198`	`*`
`203`	`199`	`* @param string $appId ID of the app`
`204`	`200`	`* @param string\|null $customId An arbitrary identifier for the task`
`205`	`201`	`* @return DataResponse<Http::STATUS_OK, array{tasks: CoreTaskProcessingTask[]}, array{}>\|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>`
`206`	`202`	`*`
`207`		`- * 200: Task list returned`
	`203`	`+ * 200: Tasks returned`
`208`	`204`	`*/`
`209`	`205`	`#[NoAdminRequired]`
`210`	`206`	`#[ApiRoute(verb: 'GET', url: '/tasks/app/{appId}', root: '/taskprocessing')]`
`@@ -221,24 +217,21 @@ public function listTasksByApp(string $appId, ?string $customId = null): DataRes`
`221`	`217`	`]);`
`222`	`218`	`} catch (Exception $e) {`
`223`	`219`	`return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);`
`224`		`- } catch (\JsonException $e) {`
`225`		`- return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);`
`226`	`220`	`}`
`227`	`221`	`}`
`228`	`222`
`229`	`223`	`/**`
`230`		`- * This endpoint returns a list of tasks of a user that are related`
`231`		`- * with a specific appId and optionally with an identifier`
	`224`	`+ * Returns tasks for the current user filtered by the optional taskType and optional customId`
`232`	`225`	`*`
`233`	`226`	`* @param string\|null $taskType The task type to filter by`
`234`	`227`	`* @param string\|null $customId An arbitrary identifier for the task`
`235`	`228`	`* @return DataResponse<Http::STATUS_OK, array{tasks: CoreTaskProcessingTask[]}, array{}>\|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>`
`236`	`229`	`*`
`237`		`- * 200: Task list returned`
	`230`	`+ * 200: Tasks returned`
`238`	`231`	`*/`
`239`	`232`	`#[NoAdminRequired]`
`240`	`233`	`#[ApiRoute(verb: 'GET', url: '/tasks', root: '/taskprocessing')]`
`241`		`- public function listTasksByUser(?string $taskType, ?string $customId = null): DataResponse {`
	`234`	`+ public function listTasks(?string $taskType, ?string $customId = null): DataResponse {`
`242`	`235`	`try {`
`243`	`236`	`$tasks = $this->taskProcessingManager->getUserTasks($this->userId, $taskType, $customId);`
`244`	`237`	`/** @var CoreTaskProcessingTask[] $json */`
`@@ -251,13 +244,11 @@ public function listTasksByUser(?string $taskType, ?string $customId = null): Da`
`251`	`244`	`]);`
`252`	`245`	`} catch (Exception $e) {`
`253`	`246`	`return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);`
`254`		`- } catch (\JsonException $e) {`
`255`		`- return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);`
`256`	`247`	`}`
`257`	`248`	`}`
`258`	`249`
`259`	`250`	`/**`
`260`		`- * This endpoint returns the contents of a file referenced in a task`
	`251`	`+ * Returns the contents of a file referenced in a task`
`261`	`252`	`*`
`262`	`253`	`* @param int $taskId The id of the task`
`263`	`254`	`* @param int $fileId The file id of the file to retrieve`
`@@ -288,7 +279,7 @@ public function getFileContents(int $taskId, int $fileId): Http\DataDownloadResp`
`288`	`279`	`return new Http\DataDownloadResponse($node->getContent(), $node->getName(), $node->getMimeType());`
`289`	`280`	`} catch (\OCP\TaskProcessing\Exception\NotFoundException $e) {`
`290`	`281`	`return new DataResponse(['message' => $this->l->t('Not found')], Http::STATUS_NOT_FOUND);`
`291`		`- } catch (GenericFileException\|NotPermittedException\|LockedException\|Exception $e) {`
	`282`	`+ } catch (Exception $e) {`
`292`	`283`	`return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);`
`293`	`284`	`}`
`294`	`285`	`}`
`@@ -333,13 +324,13 @@ private function extractFileIdsFromTask(Task $task): array {`
`333`	`324`	`}`
`334`	`325`
`335`	`326`	`/**`
`336`		`- * This endpoint sets the task progress`
	`327`	`+ * Sets the task progress`
`337`	`328`	`*`
`338`	`329`	`* @param int $taskId The id of the task`
`339`	`330`	`* @param float $progress The progress`
`340`	`331`	`* @return DataResponse<Http::STATUS_OK, array{task: CoreTaskProcessingTask}, array{}>\|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR\|Http::STATUS_NOT_FOUND, array{message: string}, array{}>`
`341`	`332`	`*`
`342`		`- * 200: File content returned`
	`333`	`+ * 200: Progress updated successfully`
`343`	`334`	`* 404: Task not found`
`344`	`335`	`*/`
`345`	`336`	`#[NoAdminRequired]`
`@@ -363,14 +354,14 @@ public function setProgress(int $taskId, float $progress): DataResponse {`
`363`	`354`	`}`
`364`	`355`
`365`	`356`	`/**`
`366`		`- * This endpoint sets the task progress`
	`357`	`+ * Sets the task result`
`367`	`358`	`*`
`368`	`359`	`* @param int $taskId The id of the task`
`369`	`360`	`* @param array<string,mixed>\|null $output The resulting task output`
`370`	`361`	`* @param string\|null $errorMessage An error message if the task failed`
`371`	`362`	`* @return DataResponse<Http::STATUS_OK, array{task: CoreTaskProcessingTask}, array{}>\|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR\|Http::STATUS_NOT_FOUND, array{message: string}, array{}>`
`372`	`363`	`*`
`373`		`- * 200: File content returned`
	`364`	`+ * 200: Result updated successfully`
`374`	`365`	`* 404: Task not found`
`375`	`366`	`*/`
`376`	`367`	`#[NoAdminRequired]`
`@@ -397,12 +388,12 @@ public function setResult(int $taskId, ?array $output = null, ?string $errorMess`
`397`	`388`	`}`
`398`	`389`
`399`	`390`	`/**`
`400`		`- * This endpoint cancels a task`
	`391`	`+ * Cancels a task`
`401`	`392`	`*`
`402`	`393`	`* @param int $taskId The id of the task`
`403`	`394`	`* @return DataResponse<Http::STATUS_OK, array{task: CoreTaskProcessingTask}, array{}>\|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR\|Http::STATUS_NOT_FOUND, array{message: string}, array{}>`
`404`	`395`	`*`
`405`		`- * 200: File content returned`
	`396`	`+ * 200: Task canceled successfully`
`406`	`397`	`* 404: Task not found`
`407`	`398`	`*/`
`408`	`399`	`#[NoAdminRequired]`