From c4545d272a77b927392199a291f67f8fa1deb815 Mon Sep 17 00:00:00 2001
From: Andrii Shvaika <ashvayka@thingsboard.io>
Date: Fri, 31 Mar 2023 17:55:57 +0300
Subject: [PATCH] REST API doc improvements

---
 .../thingsboard/server/controller/UserController.java  | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/application/src/main/java/org/thingsboard/server/controller/UserController.java b/application/src/main/java/org/thingsboard/server/controller/UserController.java
index 311622db5d..fadb920938 100644
--- a/application/src/main/java/org/thingsboard/server/controller/UserController.java
+++ b/application/src/main/java/org/thingsboard/server/controller/UserController.java
@@ -499,7 +499,7 @@ public class UserController extends BaseController {
                     "{A:5, B:{C:10, D:30}}. The same could be achieved by putting {B.D:30}")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PutMapping(value = "/user/settings/{type}")
-    public void putUserSettings(@ApiParam(value = "Settings type, one of: \"visit\", \"star\" or \"unstar\".")
+    public void putUserSettings(@ApiParam(value = "Settings type, case insensitive, one of: \"general\", \"quick_links\", \"doc_links\" or \"dashboards\".")
                                 @PathVariable("type") String strType, @RequestBody JsonNode settings) throws ThingsboardException {
         SecurityUser currentUser = getCurrentUser();
         UserSettingsType type = checkEnumParameter("Settings type", strType, UserSettingsType::valueOf);
@@ -511,7 +511,7 @@ public class UserController extends BaseController {
             notes = "Fetch the User settings based on authorized user. ")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @GetMapping(value = "/user/settings/{type}")
-    public JsonNode getUserSettings(@ApiParam(value = "Settings type, one of: \"visit\", \"star\" or \"unstar\".")
+    public JsonNode getUserSettings(@ApiParam(value = "Settings type, case insensitive, one of: \"general\", \"quick_links\", \"doc_links\" or \"dashboards\".")
                                     @PathVariable("type") String strType) throws ThingsboardException {
         SecurityUser currentUser = getCurrentUser();
         UserSettingsType type = checkEnumParameter("Settings type", strType, UserSettingsType::valueOf);
@@ -527,7 +527,7 @@ public class UserController extends BaseController {
     @RequestMapping(value = "/user/settings/{type}/{paths}", method = RequestMethod.DELETE)
     public void deleteUserSettings(@ApiParam(value = PATHS)
                                    @PathVariable(PATHS) String paths,
-                                   @ApiParam(value = "Settings type, one of: \"visit\", \"star\" or \"unstar\".")
+                                   @ApiParam(value = "Settings type, case insensitive, one of: \"general\", \"quick_links\", \"doc_links\" or \"dashboards\".")
                                    @PathVariable("type") String strType) throws ThingsboardException {
         checkParameter(USER_ID, paths);
         UserSettingsType type = checkEnumParameter("Settings type", strType, UserSettingsType::valueOf);
@@ -537,7 +537,7 @@ public class UserController extends BaseController {
     }
 
     @ApiOperation(value = "Get information about last visited and starred dashboards (getLastVisitedDashboards)",
-            notes = "Fetch the list of last visited and starred dashboards. Both lists are limited to 10 items.")
+            notes = "Fetch the list of last visited and starred dashboards. Both lists are limited to 10 items." + TENANT_OR_CUSTOMER_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @GetMapping(value = "/user/dashboards")
     public UserDashboardsInfo getUserDashboardsInfo() throws ThingsboardException {
@@ -546,7 +546,7 @@ public class UserController extends BaseController {
     }
 
     @ApiOperation(value = "Report action of User over the dashboard (reportUserDashboardAction)",
-            notes = "Enables or Disables user credentials. Useful when you would like to block user account without deleting it. " + PAGE_DATA_PARAMETERS + TENANT_AUTHORITY_PARAGRAPH)
+            notes = "Report action of User over the dashboard. " + TENANT_OR_CUSTOMER_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/user/dashboards/{dashboardId}/{action}", method = RequestMethod.GET)
     @ResponseBody