fixup! refactor: enhance form update method with validation and permission checks

Signed-off-by: Christian Hartmann <chris-hartmann@gmx.de>

Author: Chartman123

lib/Controller/ApiController.php

@@ -245,8 +245,8 @@ public function getForm(int $formId): DataResponse {
 	}
 
 	/**
-	 * Updates a form with the given key-value pairs.
-	 * Handles validation, permission checks, and special cases (lock, unlock, owner transfer).
+	 * Updates a form with the given key-value pairs and handles validation,
+	 * permission checks, and special cases (lock, unlock, owner transfer)
 	 *
 	 * @param int $formId The ID of the form to update.
 	 * @param array<string, mixed> $keyValuePairs Key-value pairs to update on the form.
@@ -255,7 +255,7 @@ public function getForm(int $formId): DataResponse {
 	 * @throws OCSForbiddenException If the input is empty, forbidden keys are present, or the user is not allowed to modify the form.
 	 * @throws OCSNotFoundException If the form is not found.
 	 *
-	 * 200: Returns the ID of the updated form.
+	 * 200: Returns the ID of the updated form
 	 */
 	#[CORS()]
 	#[NoAdminRequired()]
@@ -1651,7 +1651,7 @@ public function uploadFiles(int $formId, int $questionId, string $shareHash = ''
 	// private functions
 
 	/**
-	 * Asserts that the given array of key-value pairs is not empty.
+	 * Asserts that the given array of key-value pairs is not empty
 	 *
 	 * @param array $keyValuePairs The array of key-value pairs to check.
 	 * @throws OCSForbiddenException If the array is empty.

openapi.json

@@ -984,7 +984,7 @@
             },
             "patch": {
                 "operationId": "api-update-form",
-                "summary": "Writes the given key-value pairs into Database",
+                "summary": "Updates a form with the given key-value pairs and handles validation, permission checks, and special cases (lock, unlock, owner transfer)",
                 "description": "This endpoint allows CORS requests",
                 "tags": [
                     "api"
@@ -1006,7 +1006,7 @@
                                 "properties": {
                                     "keyValuePairs": {
                                         "type": "object",
-                                        "description": "Array of key=>value pairs to update.",
+                                        "description": "Key-value pairs to update on the form.",
                                         "additionalProperties": {
                                             "type": "object"
                                         }
@@ -1020,7 +1020,7 @@
                     {
                         "name": "formId",
                         "in": "path",
-                        "description": "FormId of form to update",
+                        "description": "The ID of the form to update.",
                         "required": true,
                         "schema": {
                             "type": "integer",
@@ -1039,46 +1039,8 @@
                     }
                 ],
                 "responses": {
-                    "200": {
-                        "description": "the id of the updated form",
-                        "content": {
-                            "application/json": {
-                                "schema": {
-                                    "type": "object",
-                                    "required": [
-                                        "ocs"
-                                    ],
-                                    "properties": {
-                                        "ocs": {
-                                            "type": "object",
-                                            "required": [
-                                                "meta",
-                                                "data"
-                                            ],
-                                            "properties": {
-                                                "meta": {
-                                                    "$ref": "#/components/schemas/OCSMeta"
-                                                },
-                                                "data": {
-                                                    "oneOf": [
-                                                        {
-                                                            "type": "integer",
-                                                            "format": "int64"
-                                                        },
-                                                        {
-                                                            "type": "string"
-                                                        }
-                                                    ]
-                                                }
-                                            }
-                                        }
-                                    }
-                                }
-                            }
-                        }
-                    },
                     "400": {
-                        "description": "Could not find new form owner",
+                        "description": "If the new form owner cannot be found.",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -1106,7 +1068,7 @@
                         }
                     },
                     "403": {
-                        "description": "User is not allowed to modify the form",
+                        "description": "If the input is empty, forbidden keys are present, or the user is not allowed to modify the form.",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -1134,7 +1096,7 @@
                         }
                     },
                     "404": {
-                        "description": "Form not found",
+                        "description": "If the form is not found.",
                         "content": {
                             "application/json": {
                                 "schema": {