docs(TaskProcessingApi): Set correct status code messages

Signed-off-by: provokateurin <kate@provokateurin.de>
nextcloud · May 16, 2024 · 4c375c9 · 4c375c9
1 parent eabbb73
commit 4c375c9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/core/Controller/TaskProcessingApiController.php b/core/Controller/TaskProcessingApiController.php
@@ -178,7 +178,7 @@ public function getTask(int $id): DataResponse {
 	 *
 	 * @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 @@ public function deleteTask(int $id): DataResponse {
 	 * @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 @@ public function listTasksByApp(string $appId, ?string $customId = null): DataRes
 	 * @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 @@ private function extractFileIdsFromTask(Task $task): array {
 	 * @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 @@ public function setProgress(int $taskId, float $progress): DataResponse {
 	 * @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 @@ public function setResult(int $taskId, ?array $output = null, ?string $errorMess
 	 * @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
@@ -3867,7 +3867,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Task returned",
+                        "description": "Task deleted",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3984,7 +3984,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Task list returned",
+                        "description": "Tasks returned",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4112,7 +4112,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Task list returned",
+                        "description": "Tasks returned",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4380,7 +4380,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "File content returned",
+                        "description": "Progress updated successfully",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4553,7 +4553,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "File content returned",
+                        "description": "Result updated successfully",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4708,7 +4708,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "File content returned",
+                        "description": "Task canceled successfully",
                         "content": {
                             "application/json": {
                                 "schema": {