From 6f9cf8817c99ba3701ae075c80fd5ca740f57d19 Mon Sep 17 00:00:00 2001
From: jld3103 <jld3103yt@gmail.com>
Date: Wed, 15 Feb 2023 19:13:57 +0100
Subject: user_status: Add OpenAPI spec

Signed-off-by: jld3103 <jld3103yt@gmail.com>
---
 .../user_status/lib/Controller/PredefinedStatusController.php | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'apps/user_status/lib/Controller/PredefinedStatusController.php')

diff --git a/apps/user_status/lib/Controller/PredefinedStatusController.php b/apps/user_status/lib/Controller/PredefinedStatusController.php
index ea1ff5209b8..0a108a56bf6 100644
--- a/apps/user_status/lib/Controller/PredefinedStatusController.php
+++ b/apps/user_status/lib/Controller/PredefinedStatusController.php
@@ -6,6 +6,7 @@ declare(strict_types=1);
  * @copyright Copyright (c) 2020, Georg Ehrke
  *
  * @author Georg Ehrke <oc.list@georgehrke.com>
+ * @author Kate Döen <kate.doeen@nextcloud.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -25,15 +26,17 @@ declare(strict_types=1);
  */
 namespace OCA\UserStatus\Controller;
 
+use OCA\UserStatus\ResponseDefinitions;
 use OCA\UserStatus\Service\PredefinedStatusService;
+use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
 use OCP\IRequest;
 
 /**
- * Class DefaultStatusController
- *
  * @package OCA\UserStatus\Controller
+ *
+ * @psalm-import-type UserStatusPredefined from ResponseDefinitions
  */
 class PredefinedStatusController extends OCSController {
 
@@ -55,9 +58,11 @@ class PredefinedStatusController extends OCSController {
 	}
 
 	/**
+	 * Get all predefined messages
+	 *
 	 * @NoAdminRequired
 	 *
-	 * @return DataResponse
+	 * @return DataResponse<Http::STATUS_OK, UserStatusPredefined[], array{}>
 	 */
 	public function findAll():DataResponse {
 		// Filtering out the invisible one, that should only be set by API
-- 
cgit v1.2.3