Merge pull request #40511 from nextcloud/fix/dashboard-widgets-api

Fix dashboard widgets api
nextcloud · Sep 20, 2023 · 716c5e0 · 716c5e0
2 parents 9a70c1e + 6c84098
commit 716c5e0
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/apps/dashboard/lib/Controller/DashboardApiController.php b/apps/dashboard/lib/Controller/DashboardApiController.php
@@ -150,7 +150,7 @@ public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $wi
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
 	 *
-	 * @return DataResponse<Http::STATUS_OK, DashboardWidget[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}>
 	 */
 	public function getWidgets(): DataResponse {
 		$widgets = $this->dashboardManager->getWidgets();

diff --git a/apps/dashboard/openapi.json b/apps/dashboard/openapi.json
@@ -220,8 +220,8 @@
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
                                                 "data": {
-                                                    "type": "array",
-                                                    "items": {
+                                                    "type": "object",
+                                                    "additionalProperties": {
                                                         "$ref": "#/components/schemas/Widget"
                                                     }
                                                 }

diff --git a/lib/private/Dashboard/Manager.php b/lib/private/Dashboard/Manager.php
@@ -40,8 +40,8 @@ class Manager implements IManager {
 	/** @var array */
 	private $lazyWidgets = [];
 
-	/** @var IWidget[] */
-	private $widgets = [];
+	/** @var array<string, IWidget> */
+	private array $widgets = [];
 
 	private ContainerInterface $serverContainer;
 	private ?IAppManager $appManager = null;
@@ -134,6 +134,9 @@ public function loadLazyPanels(): void {
 		$this->lazyWidgets = [];
 	}
 
+	/**
+	 * @return array<string, IWidget>
+	 */
 	public function getWidgets(): array {
 		$this->loadLazyPanels();
 		return $this->widgets;

diff --git a/lib/public/Dashboard/IManager.php b/lib/public/Dashboard/IManager.php
@@ -40,7 +40,7 @@ public function lazyRegisterWidget(string $widgetClass, string $appId): void;
 	/**
 	 * @since 20.0.0
 	 *
-	 * @return IWidget[]
+	 * @return array<string, IWidget>
 	 */
 	public function getWidgets(): array;
 }