aboutsummaryrefslogtreecommitdiffstats
path: root/apps/dashboard
diff options
context:
space:
mode:
authorjld3103 <jld3103yt@gmail.com>2023-09-19 14:12:17 +0200
committerjld3103 <jld3103yt@gmail.com>2023-09-27 08:05:21 +0200
commitc2d45cb1728e2191e51424734e74cb2a56b323b0 (patch)
tree0c46d10f4e5ef18bf0771069dd2a896da788b4ba /apps/dashboard
parent912b18b1fc9fd90bfc78f942cd2043a5a0145e69 (diff)
downloadnextcloud-server-c2d45cb1728e2191e51424734e74cb2a56b323b0.tar.gz
nextcloud-server-c2d45cb1728e2191e51424734e74cb2a56b323b0.zip
Add single status code descriptions for OpenAPI
Signed-off-by: jld3103 <jld3103yt@gmail.com>
Diffstat (limited to 'apps/dashboard')
-rw-r--r--apps/dashboard/lib/Controller/DashboardApiController.php6
-rw-r--r--apps/dashboard/openapi.json6
2 files changed, 9 insertions, 3 deletions
diff --git a/apps/dashboard/lib/Controller/DashboardApiController.php b/apps/dashboard/lib/Controller/DashboardApiController.php
index e50ab974dfc..e62c21bcc4a 100644
--- a/apps/dashboard/lib/Controller/DashboardApiController.php
+++ b/apps/dashboard/lib/Controller/DashboardApiController.php
@@ -104,6 +104,8 @@ class DashboardApiController extends OCSController {
* @param int $limit Limit number of result items per widget
* @param string[] $widgets Limit results to specific widgets
* @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItem[]>, array{}>
+ *
+ * 200: Widget items returned
*/
public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
$items = [];
@@ -129,6 +131,8 @@ class DashboardApiController extends OCSController {
* @param int $limit Limit number of result items per widget
* @param string[] $widgets Limit results to specific widgets
* @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}>
+ *
+ * 200: Widget items returned
*/
public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
$items = [];
@@ -151,6 +155,8 @@ class DashboardApiController extends OCSController {
* @NoCSRFRequired
*
* @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}>
+ *
+ * 200: Widgets returned
*/
public function getWidgets(): DataResponse {
$widgets = $this->dashboardManager->getWidgets();
diff --git a/apps/dashboard/openapi.json b/apps/dashboard/openapi.json
index b771b952b33..ba643d965e5 100644
--- a/apps/dashboard/openapi.json
+++ b/apps/dashboard/openapi.json
@@ -200,7 +200,7 @@
],
"responses": {
"200": {
- "description": "",
+ "description": "Widgets returned",
"content": {
"application/json": {
"schema": {
@@ -293,7 +293,7 @@
],
"responses": {
"200": {
- "description": "",
+ "description": "Widget items returned",
"content": {
"application/json": {
"schema": {
@@ -389,7 +389,7 @@
],
"responses": {
"200": {
- "description": "",
+ "description": "Widget items returned",
"content": {
"application/json": {
"schema": {