fix: Fix Psalm, OpenAPI and unit tests

Signed-off-by: Joas Schilling <coding@schilljs.com>
nextcloud · May 16, 2024 · 2a38ba1 · 2a38ba1
1 parent 377a2f9
commit 2a38ba1
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 14 deletions.
diff --git a/lib/Controller/CallController.php b/lib/Controller/CallController.php
@@ -162,7 +162,7 @@ public function joinCall(?int $flags = null, ?int $forcePermissions = null, bool
 	 * Ring an attendee
 	 *
 	 * @param int $attendeeId ID of the attendee to ring
-	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_NOT_FOUND, array<empty>, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: string}, array{}>
 	 *
 	 * 200: Attendee rang successfully
 	 * 400: Ringing attendee is not possible

diff --git a/openapi-full.json b/openapi-full.json
@@ -4045,8 +4045,8 @@
                             }
                         }
                     },
-                    "400": {
-                        "description": "Ringing attendee is not possible",
+                    "404": {
+                        "description": "Attendee could not be found",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4073,8 +4073,8 @@
                             }
                         }
                     },
-                    "404": {
-                        "description": "Attendee could not be found",
+                    "400": {
+                        "description": "Ringing attendee is not possible",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4093,7 +4093,17 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {}
+                                                "data": {
+                                                    "type": "object",
+                                                    "required": [
+                                                        "error"
+                                                    ],
+                                                    "properties": {
+                                                        "error": {
+                                                            "type": "string"
+                                                        }
+                                                    }
+                                                }
                                             }
                                         }
                                     }

diff --git a/openapi.json b/openapi.json
@@ -3932,8 +3932,8 @@
                             }
                         }
                     },
-                    "400": {
-                        "description": "Ringing attendee is not possible",
+                    "404": {
+                        "description": "Attendee could not be found",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3960,8 +3960,8 @@
                             }
                         }
                     },
-                    "404": {
-                        "description": "Attendee could not be found",
+                    "400": {
+                        "description": "Ringing attendee is not possible",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3980,7 +3980,17 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {}
+                                                "data": {
+                                                    "type": "object",
+                                                    "required": [
+                                                        "error"
+                                                    ],
+                                                    "properties": {
+                                                        "error": {
+                                                            "type": "string"
+                                                        }
+                                                    }
+                                                }
                                             }
                                         }
                                     }

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -1796,7 +1796,9 @@ export type operations = {
           "application/json": {
             ocs: {
               meta: components["schemas"]["OCSMeta"];
-              data: unknown;
+              data: {
+                error: string;
+              };
             };
           };
         };

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -1619,7 +1619,9 @@ export type operations = {
           "application/json": {
             ocs: {
               meta: components["schemas"]["OCSMeta"];
-              data: unknown;
+              data: {
+                error: string;
+              };
             };
           };
         };

diff --git a/tests/php/Service/ParticipantServiceTest.php b/tests/php/Service/ParticipantServiceTest.php
@@ -29,6 +29,7 @@
 use OCP\IGroupManager;
 use OCP\IUserManager;
 use OCP\Security\ISecureRandom;
+use OCP\UserStatus\IManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use Test\TestCase;
 
@@ -50,6 +51,7 @@ class ParticipantServiceTest extends TestCase {
 	protected BackendNotifier&MockObject $federationBackendNotifier;
 	protected ITimeFactory&MockObject $time;
 	protected ICacheFactory&MockObject $cacheFactory;
+	protected IManager&MockObject $userStatusManager;
 	private ?ParticipantService $service = null;
 
 
@@ -70,6 +72,7 @@ public function setUp(): void {
 		$this->federationBackendNotifier = $this->createMock(BackendNotifier::class);
 		$this->time = $this->createMock(ITimeFactory::class);
 		$this->cacheFactory = $this->createMock(ICacheFactory::class);
+		$this->userStatusManager = $this->createMock(IManager::class);
 		$this->service = new ParticipantService(
 			$this->serverConfig,
 			$this->talkConfig,
@@ -85,7 +88,8 @@ public function setUp(): void {
 			$this->membershipService,
 			$this->federationBackendNotifier,
 			$this->time,
-			$this->cacheFactory
+			$this->cacheFactory,
+			$this->userStatusManager,
 		);
 	}