updatenotification: Add OpenAPI spec

Signed-off-by: jld3103 <jld3103yt@gmail.com>

1 files changed, 16 insertions, 4 deletions

diff --git a/apps/updatenotification/lib/Controller/APIController.php b/apps/updatenotification/lib/Controller/APIController.php
index 26657eb66f0..8833f6e772e 100644
--- a/apps/updatenotification/lib/Controller/APIController.php
+++ b/apps/updatenotification/lib/Controller/APIController.php
@@ -27,6 +27,7 @@ declare(strict_types=1);
 namespace OCA\UpdateNotification\Controller;
 
 use OC\App\AppStore\Fetcher\AppFetcher;
+use OCA\UpdateNotification\ResponseDefinitions;
 use OCP\App\AppPathNotFoundException;
 use OCP\App\IAppManager;
 use OCP\AppFramework\Http;
@@ -37,6 +38,9 @@ use OCP\IRequest;
 use OCP\IUserSession;
 use OCP\L10N\IFactory;
 
+/**
+ * @psalm-import-type UpdatenotificationApp from ResponseDefinitions
+ */
 class APIController extends OCSController {
 
 	/** @var IConfig */
@@ -86,8 +90,14 @@ class APIController extends OCSController {
 	}
 
 	/**
-	 * @param string $newVersion
-	 * @return DataResponse
+	 * List available updates for apps
+	 *
+	 * @param string $newVersion Server version to check updates for
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array{missing: UpdatenotificationApp[], available: UpdatenotificationApp[]}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array{appstore_disabled: bool, already_on_latest?: bool}, array{}>
+	 *
+	 * 200: Apps returned
+	 * 404: New versions not found
 	 */
 	public function getAppList(string $newVersion): DataResponse {
 		if (!$this->config->getSystemValue('appstoreenabled', true)) {
@@ -157,13 +167,15 @@ class APIController extends OCSController {
 	 * Get translated app name
 	 *
 	 * @param string $appId
-	 * @return string[]
+	 * @return UpdatenotificationApp
 	 */
 	protected function getAppDetails(string $appId): array {
 		$app = $this->appManager->getAppInfo($appId, false, $this->language);
+		/** @var ?string $name */
+		$name = $app['name'];
 		return [
 			'appId' => $appId,
-			'appName' => $app['name'] ?? $appId,
+			'appName' => $name ?? $appId,
 		];
 	}
 }