Skip to content

Fix dashboard widgets api #40511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
provokateurin merged 2 commits into from
Sep 20, 2023
Merged

Fix dashboard widgets api #40511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80e3064
Fix Dashboard IManager getWidgets return annotation
provokateurin Sep 19, 2023
6c84098
dashboard: Fix get widgets OpenAPI
provokateurin Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/dashboard/lib/Controller/DashboardApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
4 changes: 2 additions & 2 deletions apps/dashboard/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Widget"
}
}
Expand Down
7 changes: 5 additions & 2 deletions lib/private/Dashboard/Manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -134,6 +134,9 @@ public function loadLazyPanels(): void {
$this->lazyWidgets = [];
}

/**
* @return array<string, IWidget>
*/
public function getWidgets(): array {
$this->loadLazyPanels();
return $this->widgets;
Expand Down
2 changes: 1 addition & 1 deletion lib/public/Dashboard/IManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}