use GET for dashboard client API

Julien Veyssier · Julien Veyssier · commit f38c81b2a25a · 2021-04-06T13:46:03.000+02:00
Signed-off-by: Julien Veyssier &lt;eneiluj@posteo.net&gt;
diff --git a/apps/dashboard/appinfo/routes.php b/apps/dashboard/appinfo/routes.php
@@ -33,6 +33,6 @@
 		['name' => 'dashboard#setBackground', 'url' => '/background/{type}', 'verb' => 'POST'],
 	],
 	'ocs' => [
-		['name' => 'dashboard#getWidgetItems', 'url' => '/api/v1/widget-items', 'verb' => 'POST'],
+		['name' => 'dashboard#getWidgetItems', 'url' => '/api/v1/widget-items', 'verb' => 'GET'],
 	]
 ];
diff --git a/apps/dashboard/lib/Controller/DashboardController.php b/apps/dashboard/lib/Controller/DashboardController.php
@@ -215,7 +215,7 @@ public function getBackground(): Http\Response {
 
 	/**
 	 * Example request with Curl:
-	 * curl -u user:passwd http://my.nc/ocs/v2.php/apps/dashboard/api/v1/widget-items -H Content-Type:application/json -X POST -d '{"sinceIds":{"github_notifications":"2021-03-22T15:01:10Z"}}'
+	 * curl -u user:passwd http://my.nc/ocs/v2.php/apps/dashboard/api/v1/widget-items -H Content-Type:application/json -X GET -d '{"sinceIds":{"github_notifications":"2021-03-22T15:01:10Z"}}'
 	 *
 	 * @param array $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
 	 * @param int $limit Limit number of result items per widget

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,6 @@`
`33`	`33`	`['name' => 'dashboard#setBackground', 'url' => '/background/{type}', 'verb' => 'POST'],`
`34`	`34`	`],`
`35`	`35`	`'ocs' => [`
`36`		`- ['name' => 'dashboard#getWidgetItems', 'url' => '/api/v1/widget-items', 'verb' => 'POST'],`
	`36`	`+ ['name' => 'dashboard#getWidgetItems', 'url' => '/api/v1/widget-items', 'verb' => 'GET'],`
`37`	`37`	`]`
`38`	`38`	`];`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ public function getBackground(): Http\Response {`
`215`	`215`
`216`	`216`	`/**`
`217`	`217`	`* Example request with Curl:`
`218`		`- * curl -u user:passwd http://my.nc/ocs/v2.php/apps/dashboard/api/v1/widget-items -H Content-Type:application/json -X POST -d '{"sinceIds":{"github_notifications":"2021-03-22T15:01:10Z"}}'`
	`218`	`+ * curl -u user:passwd http://my.nc/ocs/v2.php/apps/dashboard/api/v1/widget-items -H Content-Type:application/json -X GET -d '{"sinceIds":{"github_notifications":"2021-03-22T15:01:10Z"}}'`
`219`	`219`	`*`
`220`	`220`	`* @param array $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items`
`221`	`221`	`* @param int $limit Limit number of result items per widget`