mirror of
https://github.com/nextcloud/server.git
synced 2026-02-18 18:28:50 -05:00
refactor(dashboard): Use attributes for routing
Signed-off-by: provokateurin <kate@provokateurin.de>
This commit is contained in:
provokateurin
parent
fdd905ba42
commit
395bf7c70d
4 changed files with 74 additions and 105 deletions
|
|
@ -1,41 +0,0 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
|
||||
*
|
||||
* @author Julien Veyssier <eneiluj@posteo.net>
|
||||
* @author Julius Härtl <jus@bitgrid.net>
|
||||
* @author Richard Steinmetz <richard@steinmetz.cloud>
|
||||
*
|
||||
* @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/>.
|
||||
*
|
||||
*/
|
||||
return [
|
||||
'routes' => [
|
||||
['name' => 'dashboard#index', 'url' => '/', 'verb' => 'GET'],
|
||||
],
|
||||
'ocs' => [
|
||||
['name' => 'dashboardApi#getWidgets', 'url' => '/api/v1/widgets', 'verb' => 'GET'],
|
||||
['name' => 'dashboardApi#getWidgetItems', 'url' => '/api/v1/widget-items', 'verb' => 'GET'],
|
||||
['name' => 'dashboardApi#getWidgetItemsV2', 'url' => '/api/v2/widget-items', 'verb' => 'GET'],
|
||||
['name' => 'dashboardApi#getLayout', 'url' => '/api/v3/layout', 'verb' => 'GET'],
|
||||
['name' => 'dashboardApi#updateLayout', 'url' => '/api/v3/layout', 'verb' => 'POST'],
|
||||
['name' => 'dashboardApi#getStatuses', 'url' => '/api/v3/statuses', 'verb' => 'GET'],
|
||||
['name' => 'dashboardApi#updateStatuses', 'url' => '/api/v3/statuses', 'verb' => 'POST'],
|
||||
]
|
||||
];
|
||||
|
|
@ -31,6 +31,7 @@ namespace OCA\Dashboard\Controller;
|
|||
use OCA\Dashboard\ResponseDefinitions;
|
||||
use OCA\Dashboard\Service\DashboardService;
|
||||
use OCP\AppFramework\Http;
|
||||
use OCP\AppFramework\Http\Attribute\ApiRoute;
|
||||
use OCP\AppFramework\Http\DataResponse;
|
||||
use OCP\AppFramework\OCSController;
|
||||
use OCP\Dashboard\IAPIWidget;
|
||||
|
|
@ -98,6 +99,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Widget items returned
|
||||
*/
|
||||
#[ApiRoute(verb: 'GET', url: '/api/v1/widget-items')]
|
||||
public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
|
||||
$items = [];
|
||||
$widgets = $this->getShownWidgets($widgets);
|
||||
|
|
@ -126,6 +128,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Widget items returned
|
||||
*/
|
||||
#[ApiRoute(verb: 'GET', url: '/api/v2/widget-items')]
|
||||
public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
|
||||
$items = [];
|
||||
$widgets = $this->getShownWidgets($widgets);
|
||||
|
|
@ -150,6 +153,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Widgets returned
|
||||
*/
|
||||
#[ApiRoute(verb: 'GET', url: '/api/v1/widgets')]
|
||||
public function getWidgets(): DataResponse {
|
||||
$widgets = $this->dashboardManager->getWidgets();
|
||||
|
||||
|
|
@ -200,6 +204,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Layout returned
|
||||
*/
|
||||
#[ApiRoute(verb: 'GET', url: '/api/v3/layout')]
|
||||
public function getLayout(): DataResponse {
|
||||
return new DataResponse(['layout' => $this->service->getLayout()]);
|
||||
}
|
||||
|
|
@ -213,6 +218,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Statuses updated successfully
|
||||
*/
|
||||
#[ApiRoute(verb: 'POST', url: '/api/v3/layout')]
|
||||
public function updateLayout(array $layout): DataResponse {
|
||||
$this->config->setUserValue($this->userId, 'dashboard', 'layout', implode(',', $layout));
|
||||
return new DataResponse(['layout' => $layout]);
|
||||
|
|
@ -226,6 +232,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Statuses returned
|
||||
*/
|
||||
#[ApiRoute(verb: 'GET', url: '/api/v3/statuses')]
|
||||
public function getStatuses(): DataResponse {
|
||||
return new DataResponse(['statuses' => $this->service->getStatuses()]);
|
||||
}
|
||||
|
|
@ -239,6 +246,7 @@ class DashboardApiController extends OCSController {
|
|||
*
|
||||
* 200: Statuses updated successfully
|
||||
*/
|
||||
#[ApiRoute(verb: 'POST', url: '/api/v3/statuses')]
|
||||
public function updateStatuses(array $statuses): DataResponse {
|
||||
$this->config->setUserValue($this->userId, 'dashboard', 'statuses', implode(',', $statuses));
|
||||
return new DataResponse(['statuses' => $statuses]);
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ namespace OCA\Dashboard\Controller;
|
|||
use OCA\Dashboard\Service\DashboardService;
|
||||
use OCP\AppFramework\Controller;
|
||||
use OCP\AppFramework\Http;
|
||||
use OCP\AppFramework\Http\Attribute\FrontpageRoute;
|
||||
use OCP\AppFramework\Http\Attribute\OpenAPI;
|
||||
use OCP\AppFramework\Http\TemplateResponse;
|
||||
use OCP\AppFramework\Services\IInitialState;
|
||||
|
|
@ -65,6 +66,7 @@ class DashboardController extends Controller {
|
|||
* @NoAdminRequired
|
||||
* @return TemplateResponse
|
||||
*/
|
||||
#[FrontpageRoute(verb: 'GET', url: '/')]
|
||||
public function index(): TemplateResponse {
|
||||
\OCP\Util::addStyle('dashboard', 'dashboard');
|
||||
\OCP\Util::addScript('dashboard', 'main', 'theming');
|
||||
|
|
|
|||
|
|
@ -172,70 +172,6 @@
|
|||
}
|
||||
},
|
||||
"paths": {
|
||||
"/ocs/v2.php/apps/dashboard/api/v1/widgets": {
|
||||
"get": {
|
||||
"operationId": "dashboard_api-get-widgets",
|
||||
"summary": "Get the widgets",
|
||||
"tags": [
|
||||
"dashboard_api"
|
||||
],
|
||||
"security": [
|
||||
{
|
||||
"bearer_auth": []
|
||||
},
|
||||
{
|
||||
"basic_auth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "OCS-APIRequest",
|
||||
"in": "header",
|
||||
"description": "Required to be true for the API request to pass",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Widgets returned",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ocs"
|
||||
],
|
||||
"properties": {
|
||||
"ocs": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"meta",
|
||||
"data"
|
||||
],
|
||||
"properties": {
|
||||
"meta": {
|
||||
"$ref": "#/components/schemas/OCSMeta"
|
||||
},
|
||||
"data": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/components/schemas/Widget"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/dashboard/api/v1/widget-items": {
|
||||
"get": {
|
||||
"operationId": "dashboard_api-get-widget-items",
|
||||
|
|
@ -431,6 +367,70 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/dashboard/api/v1/widgets": {
|
||||
"get": {
|
||||
"operationId": "dashboard_api-get-widgets",
|
||||
"summary": "Get the widgets",
|
||||
"tags": [
|
||||
"dashboard_api"
|
||||
],
|
||||
"security": [
|
||||
{
|
||||
"bearer_auth": []
|
||||
},
|
||||
{
|
||||
"basic_auth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "OCS-APIRequest",
|
||||
"in": "header",
|
||||
"description": "Required to be true for the API request to pass",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Widgets returned",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ocs"
|
||||
],
|
||||
"properties": {
|
||||
"ocs": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"meta",
|
||||
"data"
|
||||
],
|
||||
"properties": {
|
||||
"meta": {
|
||||
"$ref": "#/components/schemas/OCSMeta"
|
||||
},
|
||||
"data": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/components/schemas/Widget"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/dashboard/api/v3/layout": {
|
||||
"get": {
|
||||
"operationId": "dashboard_api-get-layout",
|
||||
|
|
|
|||
Loading…
Reference in a new issue