1 files changed, 35 insertions, 38 deletions

diff --git a/apps/user_status/lib/Controller/StatusesController.php b/apps/user_status/lib/Controller/StatusesController.php
index d30389e1716..44688c39023 100644
--- a/apps/user_status/lib/Controller/StatusesController.php
+++ b/apps/user_status/lib/Controller/StatusesController.php
@@ -3,43 +3,30 @@
 declare(strict_types=1);
 
 /**
- * @copyright Copyright (c) 2020, Georg Ehrke
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Georg Ehrke <oc.list@georgehrke.com>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 namespace OCA\UserStatus\Controller;
 
 use OCA\UserStatus\Db\UserStatus;
+use OCA\UserStatus\ResponseDefinitions;
 use OCA\UserStatus\Service\StatusService;
 use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCS\OCSNotFoundException;
 use OCP\AppFramework\OCSController;
 use OCP\IRequest;
 use OCP\UserStatus\IUserStatus;
 
+/**
+ * @psalm-import-type UserStatusType from ResponseDefinitions
+ * @psalm-import-type UserStatusPublic from ResponseDefinitions
+ */
 class StatusesController extends OCSController {
 
-	/** @var StatusService */
-	private $service;
-
 	/**
 	 * StatusesController constructor.
 	 *
@@ -47,35 +34,44 @@ class StatusesController extends OCSController {
 	 * @param IRequest $request
 	 * @param StatusService $service
 	 */
-	public function __construct(string $appName,
-								IRequest $request,
-								StatusService $service) {
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private StatusService $service,
+	) {
 		parent::__construct($appName, $request);
-		$this->service = $service;
 	}
 
 	/**
-	 * @NoAdminRequired
+	 * Find statuses of users
 	 *
-	 * @param int|null $limit
-	 * @param int|null $offset
-	 * @return DataResponse
+	 * @param int|null $limit Maximum number of statuses to find
+	 * @param non-negative-int|null $offset Offset for finding statuses
+	 * @return DataResponse<Http::STATUS_OK, list<UserStatusPublic>, array{}>
+	 *
+	 * 200: Statuses returned
 	 */
+	#[NoAdminRequired]
+	#[ApiRoute(verb: 'GET', url: '/api/v1/statuses')]
 	public function findAll(?int $limit = null, ?int $offset = null): DataResponse {
 		$allStatuses = $this->service->findAll($limit, $offset);
 
-		return new DataResponse(array_map(function ($userStatus) {
+		return new DataResponse(array_values(array_map(function ($userStatus) {
 			return $this->formatStatus($userStatus);
-		}, $allStatuses));
+		}, $allStatuses)));
 	}
 
 	/**
-	 * @NoAdminRequired
+	 * Find the status of a user
+	 *
+	 * @param string $userId ID of the user
+	 * @return DataResponse<Http::STATUS_OK, UserStatusPublic, array{}>
+	 * @throws OCSNotFoundException The user was not found
 	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSNotFoundException
+	 * 200: Status returned
 	 */
+	#[NoAdminRequired]
+	#[ApiRoute(verb: 'GET', url: '/api/v1/statuses/{userId}')]
 	public function find(string $userId): DataResponse {
 		try {
 			$userStatus = $this->service->findByUserId($userId);
@@ -88,9 +84,10 @@ class StatusesController extends OCSController {
 
 	/**
 	 * @param UserStatus $status
-	 * @return array{userId: string, message: string, icon: string, clearAt: int, status: string}
+	 * @return UserStatusPublic
 	 */
 	private function formatStatus(UserStatus $status): array {
+		/** @var UserStatusType $visibleStatus */
 		$visibleStatus = $status->getStatus();
 		if ($visibleStatus === IUserStatus::INVISIBLE) {
 			$visibleStatus = IUserStatus::OFFLINE;