Merge branch 'master' of github.com:thingsboard/thingsboard

@@ -15,8 +15,11 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -55,11 +58,25 @@ import java.util.List;
 public class AlarmController extends BaseController {
 public class AlarmController extends BaseController {
 
 
     public static final String ALARM_ID = "alarmId";
     public static final String ALARM_ID = "alarmId";
+    private static final String ALARM_SECURITY_CHECK = "If the user has the authority of 'Tenant Administrator', the server checks that the originator of alarm is owned by the same tenant. " +
+            "If the user has the authority of 'Customer User', the server checks that the originator of alarm belongs to the customer. ";
+    private static final String ALARM_QUERY_SEARCH_STATUS_DESCRIPTION = "A string value representing one of the AlarmSearchStatus enumeration value";
+    private static final String ALARM_QUERY_SEARCH_STATUS_ALLOWABLE_VALUES = "ANY, ACTIVE, CLEARED, ACK, UNACK";
+    private static final String ALARM_QUERY_STATUS_DESCRIPTION = "A string value representing one of the AlarmStatus enumeration value";
+    private static final String ALARM_QUERY_STATUS_ALLOWABLE_VALUES = "ACTIVE_UNACK, ACTIVE_ACK, CLEARED_UNACK, CLEARED_ACK";
+    private static final String ALARM_QUERY_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on of next alarm fields: type, severity or status";
+    private static final String ALARM_QUERY_START_TIME_DESCRIPTION = "The start timestamp in milliseconds of the search time range over the Alarm class field: 'createdTime'.";
+    private static final String ALARM_QUERY_END_TIME_DESCRIPTION = "The end timestamp in milliseconds of the search time range over the Alarm class field: 'createdTime'.";
+    private static final String ALARM_QUERY_FETCH_ORIGINATOR_DESCRIPTION = "A boolean value to specify if the alarm originator name will be " +
+            "filled in the AlarmInfo object  field: 'originatorName' or will returns as null.";
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Get Alarm (getAlarmById)",
+            notes = "Fetch the Alarm object based on the provided Alarm Id. " + ALARM_SECURITY_CHECK, produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/{alarmId}", method = RequestMethod.GET)
     @RequestMapping(value = "/alarm/{alarmId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public Alarm getAlarmById(@PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
+    public Alarm getAlarmById(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION)
+                              @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
         checkParameter(ALARM_ID, strAlarmId);
         checkParameter(ALARM_ID, strAlarmId);
         try {
         try {
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
@@ -69,10 +86,14 @@ public class AlarmController extends BaseController {
         }
         }
     }
     }
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Get Alarm Info (getAlarmInfoById)",
+            notes = "Fetch the Alarm Info object based on the provided Alarm Id. " +
+                    ALARM_SECURITY_CHECK + ALARM_INFO_DESCRIPTION, produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/info/{alarmId}", method = RequestMethod.GET)
     @RequestMapping(value = "/alarm/info/{alarmId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public AlarmInfo getAlarmInfoById(@PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
+    public AlarmInfo getAlarmInfoById(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION)
+                                      @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
         checkParameter(ALARM_ID, strAlarmId);
         checkParameter(ALARM_ID, strAlarmId);
         try {
         try {
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
@@ -82,10 +103,20 @@ public class AlarmController extends BaseController {
         }
         }
     }
     }
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Create or update Alarm (saveAlarm)",
+            notes = "Creates or Updates the Alarm. " +
+                    "When creating alarm, platform generates Alarm Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. " +
+                    "Referencing non-existing Alarm Id will cause 'Not Found' error. " +
+                    "\n\nPlatform also deduplicate the alarms based on the entity id of originator and alarm 'type'. " +
+                    "For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. " +
+                    "If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). " +
+                    "If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created. "
+            , produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm", method = RequestMethod.POST)
     @RequestMapping(value = "/alarm", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public Alarm saveAlarm(@RequestBody Alarm alarm) throws ThingsboardException {
+    public Alarm saveAlarm(@ApiParam(value = "A JSON value representing the alarm.") @RequestBody Alarm alarm) throws ThingsboardException {
         try {
         try {
             alarm.setTenantId(getCurrentUser().getTenantId());
             alarm.setTenantId(getCurrentUser().getTenantId());
 
 
@@ -106,10 +137,12 @@ public class AlarmController extends BaseController {
         }
         }
     }
     }
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Delete Alarm (deleteAlarm)",
+            notes = "Deletes the Alarm. Referencing non-existing Alarm Id will cause an error.", produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/{alarmId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/alarm/{alarmId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody
-    public Boolean deleteAlarm(@PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
+    public Boolean deleteAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
         checkParameter(ALARM_ID, strAlarmId);
         checkParameter(ALARM_ID, strAlarmId);
         try {
         try {
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
@@ -124,15 +157,19 @@ public class AlarmController extends BaseController {
             sendAlarmDeleteNotificationMsg(getTenantId(), alarmId, relatedEdgeIds, alarm);
             sendAlarmDeleteNotificationMsg(getTenantId(), alarmId, relatedEdgeIds, alarm);
 
 
             return alarmService.deleteAlarm(getTenantId(), alarmId);
             return alarmService.deleteAlarm(getTenantId(), alarmId);
-         } catch (Exception e) {
+        } catch (Exception e) {
             throw handleException(e);
             throw handleException(e);
         }
         }
     }
     }
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Acknowledge Alarm (ackAlarm)",
+            notes = "Acknowledge the Alarm. " +
+                    "Once acknowledged, the 'ack_ts' field will be set to current timestamp and special rule chain event 'ALARM_ACK' will be generated. " +
+                    "Referencing non-existing Alarm Id will cause an error.", produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/{alarmId}/ack", method = RequestMethod.POST)
     @RequestMapping(value = "/alarm/{alarmId}/ack", method = RequestMethod.POST)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void ackAlarm(@PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
+    public void ackAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
         checkParameter(ALARM_ID, strAlarmId);
         checkParameter(ALARM_ID, strAlarmId);
         try {
         try {
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
@@ -149,10 +186,14 @@ public class AlarmController extends BaseController {
         }
         }
     }
     }
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Clear Alarm (clearAlarm)",
+            notes = "Clear the Alarm. " +
+                    "Once cleared, the 'clear_ts' field will be set to current timestamp and special rule chain event 'ALARM_CLEAR' will be generated. " +
+                    "Referencing non-existing Alarm Id will cause an error.", produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/{alarmId}/clear", method = RequestMethod.POST)
     @RequestMapping(value = "/alarm/{alarmId}/clear", method = RequestMethod.POST)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void clearAlarm(@PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
+    public void clearAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
         checkParameter(ALARM_ID, strAlarmId);
         checkParameter(ALARM_ID, strAlarmId);
         try {
         try {
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
             AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
@@ -169,21 +210,36 @@ public class AlarmController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Alarms (getAlarms)",
+            notes = "Returns a page of alarms for the selected entity. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/{entityType}/{entityId}", method = RequestMethod.GET)
     @RequestMapping(value = "/alarm/{entityType}/{entityId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<AlarmInfo> getAlarms(
     public PageData<AlarmInfo> getAlarms(
-            @PathVariable("entityType") String strEntityType,
-            @PathVariable("entityId") String strEntityId,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION)
+            @PathVariable(ENTITY_TYPE) String strEntityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION)
+            @PathVariable(ENTITY_ID) String strEntityId,
+            @ApiParam(value = ALARM_QUERY_SEARCH_STATUS_DESCRIPTION, allowableValues = ALARM_QUERY_SEARCH_STATUS_ALLOWABLE_VALUES)
             @RequestParam(required = false) String searchStatus,
             @RequestParam(required = false) String searchStatus,
+            @ApiParam(value = ALARM_QUERY_STATUS_DESCRIPTION, allowableValues = ALARM_QUERY_STATUS_ALLOWABLE_VALUES)
             @RequestParam(required = false) String status,
             @RequestParam(required = false) String status,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = ALARM_QUERY_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = ALARM_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = ALARM_QUERY_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = ALARM_QUERY_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime,
             @RequestParam(required = false) Long endTime,
+            @ApiParam(value = ALARM_QUERY_FETCH_ORIGINATOR_DESCRIPTION)
             @RequestParam(required = false) Boolean fetchOriginator
             @RequestParam(required = false) Boolean fetchOriginator
     ) throws ThingsboardException {
     ) throws ThingsboardException {
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityId", strEntityId);
@@ -204,20 +260,35 @@ public class AlarmController extends BaseController {
             throw handleException(e);
             throw handleException(e);
         }
         }
     }
     }
-
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Get All Alarms (getAllAlarms)",
+            notes = "Returns a page of alarms that belongs to the current user owner. " +
+                    "If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. " +
+                    "If the user has the authority of 'Customer User', the server returns alarms that belongs to the customer of current user. " +
+                    "Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarms", method = RequestMethod.GET)
     @RequestMapping(value = "/alarms", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<AlarmInfo> getAllAlarms(
     public PageData<AlarmInfo> getAllAlarms(
+            @ApiParam(value = ALARM_QUERY_SEARCH_STATUS_DESCRIPTION, allowableValues = ALARM_QUERY_SEARCH_STATUS_ALLOWABLE_VALUES)
             @RequestParam(required = false) String searchStatus,
             @RequestParam(required = false) String searchStatus,
+            @ApiParam(value = ALARM_QUERY_STATUS_DESCRIPTION, allowableValues = ALARM_QUERY_STATUS_ALLOWABLE_VALUES)
             @RequestParam(required = false) String status,
             @RequestParam(required = false) String status,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = ALARM_QUERY_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = ALARM_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = ALARM_QUERY_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = ALARM_QUERY_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime,
             @RequestParam(required = false) Long endTime,
+            @ApiParam(value = ALARM_QUERY_FETCH_ORIGINATOR_DESCRIPTION)
             @RequestParam(required = false) Boolean fetchOriginator
             @RequestParam(required = false) Boolean fetchOriginator
     ) throws ThingsboardException {
     ) throws ThingsboardException {
         AlarmSearchStatus alarmSearchStatus = StringUtils.isEmpty(searchStatus) ? null : AlarmSearchStatus.valueOf(searchStatus);
         AlarmSearchStatus alarmSearchStatus = StringUtils.isEmpty(searchStatus) ? null : AlarmSearchStatus.valueOf(searchStatus);
@@ -239,13 +310,21 @@ public class AlarmController extends BaseController {
         }
         }
     }
     }
 
 
-    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
+    @ApiOperation(value = "Get Highest Alarm Severity (getHighestAlarmSeverity)",
+            notes = "Search the alarms by originator ('entityType' and entityId') and optional 'status' or 'searchStatus' filters and returns the highest AlarmSeverity(CRITICAL, MAJOR, MINOR, WARNING or INDETERMINATE). " +
+                    "Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error."
+            , produces = MediaType.APPLICATION_JSON_VALUE)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarm/highestSeverity/{entityType}/{entityId}", method = RequestMethod.GET)
     @RequestMapping(value = "/alarm/highestSeverity/{entityType}/{entityId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public AlarmSeverity getHighestAlarmSeverity(
     public AlarmSeverity getHighestAlarmSeverity(
-            @PathVariable("entityType") String strEntityType,
-            @PathVariable("entityId") String strEntityId,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_TYPE) String strEntityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_ID) String strEntityId,
+            @ApiParam(value = ALARM_QUERY_SEARCH_STATUS_DESCRIPTION, allowableValues = ALARM_QUERY_SEARCH_STATUS_ALLOWABLE_VALUES)
             @RequestParam(required = false) String searchStatus,
             @RequestParam(required = false) String searchStatus,
+            @ApiParam(value = ALARM_QUERY_STATUS_DESCRIPTION, allowableValues = ALARM_QUERY_STATUS_ALLOWABLE_VALUES)
             @RequestParam(required = false) String status
             @RequestParam(required = false) String status
     ) throws ThingsboardException {
     ) throws ThingsboardException {
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityId", strEntityId);

@@ -518,8 +518,11 @@ public class AssetController extends BaseController {
 
 
     @ApiOperation(value = "Assign asset to edge (assignAssetToEdge)",
     @ApiOperation(value = "Assign asset to edge (assignAssetToEdge)",
             notes = "Creates assignment of an existing asset to an instance of The Edge. " +
             notes = "Creates assignment of an existing asset to an instance of The Edge. " +
-                    "The Edge is a software product for edge computing. " +
-                    "It allows bringing data analysis and management to the edge, while seamlessly synchronizing with the platform server (cloud). ", produces = MediaType.APPLICATION_JSON_VALUE)
+                    EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive a copy of assignment asset " +
+                    EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once asset will be delivered to edge service, it's going to be available for usage on remote edge instance.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/asset/{assetId}", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/{edgeId}/asset/{assetId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -554,7 +557,12 @@ public class AssetController extends BaseController {
     }
     }
 
 
     @ApiOperation(value = "Unassign asset from edge (unassignAssetFromEdge)",
     @ApiOperation(value = "Unassign asset from edge (unassignAssetFromEdge)",
-            notes = "Clears assignment of the asset to the edge", produces = MediaType.APPLICATION_JSON_VALUE)
+            notes = "Clears assignment of the asset to the edge. " +
+                    EDGE_UNASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive an 'unassign' command to remove asset " +
+                    EDGE_UNASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once 'unassign' command will be delivered to edge service, it's going to remove asset locally.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/asset/{assetId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/edge/{edgeId}/asset/{assetId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody

@@ -15,7 +15,10 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.StringUtils;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -44,18 +47,42 @@ import java.util.stream.Collectors;
 @RequestMapping("/api")
 @RequestMapping("/api")
 public class AuditLogController extends BaseController {
 public class AuditLogController extends BaseController {
 
 
+    private static final String AUDIT_LOG_QUERY_START_TIME_DESCRIPTION = "The start timestamp in milliseconds of the search time range over the AuditLog class field: 'createdTime'.";
+    private static final String AUDIT_LOG_QUERY_END_TIME_DESCRIPTION = "The end timestamp in milliseconds of the search time range over the AuditLog class field: 'createdTime'.";
+    private static final String AUDIT_LOG_QUERY_ACTION_TYPES_DESCRIPTION = "A String value representing comma-separated list of action types. " +
+            "This parameter is optional, but it can be used to filter results to fetch only audit logs of specific action types. " +
+            "For example, 'LOGIN', 'LOGOUT'. See the 'Model' tab of the Response Class for more details.";
+    private static final String AUDIT_LOG_SORT_PROPERTY_DESCRIPTION = "Property of audit log to sort by. " +
+            "See the 'Model' tab of the Response Class for more details. " +
+            "Note: entityType sort property is not defined in the AuditLog class, however, it can be used to sort audit logs by types of entities that were logged.";
+
+
+    @ApiOperation(value = "Get audit logs by customer id (getAuditLogsByCustomerId)",
+            notes = "Returns a page of audit logs related to the targeted customer entities (devices, assets, etc.), " +
+                    "and users actions (login, logout, etc.) that belong to this customer. " +
+                    PAGE_DATA_PARAMETERS + ADMINISTRATOR_AUTHORITY_ONLY,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/audit/logs/customer/{customerId}", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/audit/logs/customer/{customerId}", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<AuditLog> getAuditLogsByCustomerId(
     public PageData<AuditLog> getAuditLogsByCustomerId(
+            @ApiParam(value = CUSTOMER_ID_PARAM_DESCRIPTION)
             @PathVariable("customerId") String strCustomerId,
             @PathVariable("customerId") String strCustomerId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = AUDIT_LOG_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = AUDIT_LOG_SORT_PROPERTY_DESCRIPTION, allowableValues = AUDIT_LOG_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = AUDIT_LOG_QUERY_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime,
             @RequestParam(required = false) Long endTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_ACTION_TYPES_DESCRIPTION)
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
         try {
         try {
             checkParameter("CustomerId", strCustomerId);
             checkParameter("CustomerId", strCustomerId);
@@ -68,18 +95,32 @@ public class AuditLogController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get audit logs by user id (getAuditLogsByUserId)",
+            notes = "Returns a page of audit logs related to the actions of targeted user. " +
+                    "For example, RPC call to a particular device, or alarm acknowledgment for a specific device, etc. " +
+                    PAGE_DATA_PARAMETERS + ADMINISTRATOR_AUTHORITY_ONLY,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/audit/logs/user/{userId}", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/audit/logs/user/{userId}", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<AuditLog> getAuditLogsByUserId(
     public PageData<AuditLog> getAuditLogsByUserId(
+            @ApiParam(value = USER_ID_PARAM_DESCRIPTION)
             @PathVariable("userId") String strUserId,
             @PathVariable("userId") String strUserId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = AUDIT_LOG_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = AUDIT_LOG_SORT_PROPERTY_DESCRIPTION, allowableValues = AUDIT_LOG_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = AUDIT_LOG_QUERY_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime,
             @RequestParam(required = false) Long endTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_ACTION_TYPES_DESCRIPTION)
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
         try {
         try {
             checkParameter("UserId", strUserId);
             checkParameter("UserId", strUserId);
@@ -92,19 +133,35 @@ public class AuditLogController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get audit logs by entity id (getAuditLogsByEntityId)",
+            notes = "Returns a page of audit logs related to the actions on the targeted entity. " +
+                    "Basically, this API call is used to get the full lifecycle of some specific entity. " +
+                    "For example to see when a device was created, updated, assigned to some customer, or even deleted from the system. " +
+                    PAGE_DATA_PARAMETERS + ADMINISTRATOR_AUTHORITY_ONLY,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/audit/logs/entity/{entityType}/{entityId}", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/audit/logs/entity/{entityType}/{entityId}", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<AuditLog> getAuditLogsByEntityId(
     public PageData<AuditLog> getAuditLogsByEntityId(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION)
             @PathVariable("entityType") String strEntityType,
             @PathVariable("entityType") String strEntityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION)
             @PathVariable("entityId") String strEntityId,
             @PathVariable("entityId") String strEntityId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = AUDIT_LOG_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = AUDIT_LOG_SORT_PROPERTY_DESCRIPTION, allowableValues = AUDIT_LOG_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = AUDIT_LOG_QUERY_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime,
             @RequestParam(required = false) Long endTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_ACTION_TYPES_DESCRIPTION)
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
         try {
         try {
             checkParameter("EntityId", strEntityId);
             checkParameter("EntityId", strEntityId);
@@ -118,17 +175,29 @@ public class AuditLogController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get all audit logs (getAuditLogs)",
+            notes = "Returns a page of audit logs related to all entities in the scope of the current user's Tenant. " +
+                    PAGE_DATA_PARAMETERS + ADMINISTRATOR_AUTHORITY_ONLY,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/audit/logs", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/audit/logs", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<AuditLog> getAuditLogs(
     public PageData<AuditLog> getAuditLogs(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = AUDIT_LOG_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = AUDIT_LOG_SORT_PROPERTY_DESCRIPTION, allowableValues = AUDIT_LOG_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = AUDIT_LOG_QUERY_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime,
             @RequestParam(required = false) Long endTime,
+            @ApiParam(value = AUDIT_LOG_QUERY_ACTION_TYPES_DESCRIPTION)
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
             @RequestParam(name = "actionTypes", required = false) String actionTypesStr) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();

@@ -157,41 +157,112 @@ public abstract class BaseController {
 
 
     public static final String CUSTOMER_ID = "customerId";
     public static final String CUSTOMER_ID = "customerId";
     public static final String TENANT_ID = "tenantId";
     public static final String TENANT_ID = "tenantId";
+    public static final String DEVICE_ID = "deviceId";
+    public static final String RPC_ID = "rpcId";
+    public static final String ENTITY_ID = "entityId";
+    public static final String ENTITY_TYPE = "entityType";
 
 
     public static final String PAGE_DATA_PARAMETERS = "You can specify parameters to filter the results. " +
     public static final String PAGE_DATA_PARAMETERS = "You can specify parameters to filter the results. " +
             "The result is wrapped with PageData object that allows you to iterate over result set using pagination. " +
             "The result is wrapped with PageData object that allows you to iterate over result set using pagination. " +
             "See the 'Model' tab of the Response Class for more details. ";
             "See the 'Model' tab of the Response Class for more details. ";
     public static final String DASHBOARD_ID_PARAM_DESCRIPTION = "A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String DASHBOARD_ID_PARAM_DESCRIPTION = "A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+    public static final String RPC_ID_PARAM_DESCRIPTION = "A string value representing the rpc id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String DEVICE_ID_PARAM_DESCRIPTION = "A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String DEVICE_ID_PARAM_DESCRIPTION = "A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
-    public static final String DEVICE_PROFILE_ID_DESCRIPTION = "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+    public static final String DEVICE_PROFILE_ID_PARAM_DESCRIPTION = "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+    public static final String TENANT_PROFILE_ID_PARAM_DESCRIPTION = "A string value representing the tenant profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String TENANT_ID_PARAM_DESCRIPTION = "A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String TENANT_ID_PARAM_DESCRIPTION = "A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String EDGE_ID_PARAM_DESCRIPTION = "A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String EDGE_ID_PARAM_DESCRIPTION = "A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String CUSTOMER_ID_PARAM_DESCRIPTION = "A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String CUSTOMER_ID_PARAM_DESCRIPTION = "A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+    public static final String USER_ID_PARAM_DESCRIPTION = "A string value representing the user id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String ASSET_ID_PARAM_DESCRIPTION = "A string value representing the asset id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
     public static final String ASSET_ID_PARAM_DESCRIPTION = "A string value representing the asset id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
-
-
-    protected final String PAGE_SIZE_DESCRIPTION = "Maximum amount of entities in a one page";
-    protected final String PAGE_NUMBER_DESCRIPTION = "Sequence number of page starting from 0";
-    protected final String DEVICE_TYPE_DESCRIPTION = "Device type as the name of the device profile";
-    protected final String ASSET_TYPE_DESCRIPTION = "Asset type";
-
-    protected final String ASSET_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the asset name.";
-    protected final String DASHBOARD_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the dashboard title.";
-    protected final String DEVICE_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the device name.";
-    protected final String CUSTOMER_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the customer title.";
-    protected final String SORT_PROPERTY_DESCRIPTION = "Property of entity to sort by";
-    protected final String DASHBOARD_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, title";
-    protected final String CUSTOMER_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, title, email, country, city";
-    protected final String DEVICE_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, deviceProfileName, label, customerTitle";
-    protected final String ASSET_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, type, label, customerTitle";
-    protected final String SORT_ORDER_DESCRIPTION = "Sort order. ASC (ASCENDING) or DESC (DESCENDING)";
-    protected final String SORT_ORDER_ALLOWABLE_VALUES = "ASC, DESC";
-    protected final String DEVICE_INFO_DESCRIPTION = "Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. ";
-    protected final String ASSET_INFO_DESCRIPTION = "Asset Info is an extension of the default Asset object that contains information about the assigned customer name. ";
-
-
-    protected final String DEVICE_NAME_DESCRIPTION = "A string value representing the Device name.";
-    protected final String ASSET_NAME_DESCRIPTION = "A string value representing the Asset name.";
+    public static final String ALARM_ID_PARAM_DESCRIPTION = "A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+    public static final String ENTITY_ID_PARAM_DESCRIPTION = "A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+    public static final String ENTITY_TYPE_PARAM_DESCRIPTION = "A string value representing the entity type. For example, 'DEVICE'";
+    public static final String RULE_CHAIN_ID_PARAM_DESCRIPTION = "A string value representing the rule chain id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
+
+    protected static final String SYSTEM_AUTHORITY_PARAGRAPH = "\n\nAvailable for users with 'SYS_ADMIN' authority.";
+    protected static final String SYSTEM_OR_TENANT_AUTHORITY_PARAGRAPH = "\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.";
+    protected static final String TENANT_AUTHORITY_PARAGRAPH = "\n\nAvailable for users with 'TENANT_ADMIN' authority.";
+    protected static final String TENANT_OR_USER_AUTHORITY_PARAGRAPH = "\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.";
+
+    protected static final String PAGE_SIZE_DESCRIPTION = "Maximum amount of entities in a one page";
+    protected static final String PAGE_NUMBER_DESCRIPTION = "Sequence number of page starting from 0";
+    protected static final String DEVICE_TYPE_DESCRIPTION = "Device type as the name of the device profile";
+    protected static final String ASSET_TYPE_DESCRIPTION = "Asset type";
+    protected static final String EDGE_TYPE_DESCRIPTION = "A string value representing the edge type. For example, 'default'";
+    protected static final String RULE_CHAIN_TYPE_DESCRIPTION = "Rule chain type (CORE or EDGE)";
+
+    protected static final String ASSET_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the asset name.";
+    protected static final String DASHBOARD_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the dashboard title.";
+    protected static final String RPC_TEXT_SEARCH_DESCRIPTION = "Not implemented. Leave empty.";
+    protected static final String DEVICE_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the device name.";
+    protected static final String USER_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the user email.";
+    protected static final String TENANT_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the tenant name.";
+    protected static final String TENANT_PROFILE_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the tenant profile name.";
+    protected static final String RULE_CHAIN_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the rule chain name.";
+    protected static final String DEVICE_PROFILE_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the device profile name.";
+    protected static final String CUSTOMER_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the customer title.";
+    protected static final String EDGE_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the edge name.";
+    protected static final String EVENT_TEXT_SEARCH_DESCRIPTION = "The value is not used in searching.";
+    protected static final String AUDIT_LOG_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on one of the next properties: entityType, entityName, userName, actionType, actionStatus.";
+    protected static final String SORT_PROPERTY_DESCRIPTION = "Property of entity to sort by";
+    protected static final String DASHBOARD_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, title";
+    protected static final String CUSTOMER_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, title, email, country, city";
+    protected static final String RPC_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, expirationTime, request, response";
+    protected static final String DEVICE_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, deviceProfileName, label, customerTitle";
+    protected static final String USER_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, firstName, lastName, email";
+    protected static final String TENANT_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, title, email, country, state, city, address, address2, zip, phone, email";
+    protected static final String TENANT_PROFILE_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, description, isDefault";
+    protected static final String TENANT_PROFILE_INFO_SORT_PROPERTY_ALLOWABLE_VALUES = "id, name";
+    protected static final String TENANT_INFO_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, tenantProfileName, title, email, country, state, city, address, address2, zip, phone, email";
+    protected static final String DEVICE_PROFILE_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, type, transportType, description, isDefault";
+    protected static final String ASSET_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, type, label, customerTitle";
+    protected static final String ALARM_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, startTs, endTs, type, ackTs, clearTs, severity, status";
+    protected static final String EVENT_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, id";
+    protected static final String EDGE_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, type, label, customerTitle";
+    protected static final String RULE_CHAIN_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, name, root";
+    protected static final String AUDIT_LOG_SORT_PROPERTY_ALLOWABLE_VALUES = "createdTime, entityType, entityName, userName, actionType, actionStatus";
+    protected static final String SORT_ORDER_DESCRIPTION = "Sort order. ASC (ASCENDING) or DESC (DESCENDING)";
+    protected static final String SORT_ORDER_ALLOWABLE_VALUES = "ASC, DESC";
+    protected static final String RPC_STATUS_ALLOWABLE_VALUES = "QUEUED, SENT, DELIVERED, SUCCESSFUL, TIMEOUT, EXPIRED, FAILED";
+    protected static final String RULE_CHAIN_TYPES_ALLOWABLE_VALUES = "CORE, EDGE";
+    protected static final String TRANSPORT_TYPE_ALLOWABLE_VALUES = "DEFAULT, MQTT, COAP, LWM2M, SNMP";
+    protected static final String DEVICE_INFO_DESCRIPTION = "Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. ";
+    protected static final String ASSET_INFO_DESCRIPTION = "Asset Info is an extension of the default Asset object that contains information about the assigned customer name. ";
+    protected static final String ALARM_INFO_DESCRIPTION = "Alarm Info is an extension of the default Alarm object that also contains name of the alarm originator.";
+    protected static final String RELATION_INFO_DESCRIPTION = "Relation Info is an extension of the default Relation object that contains information about the 'from' and 'to' entity names. ";
+    protected static final String EDGE_INFO_DESCRIPTION = "Edge Info is an extension of the default Edge object that contains information about the assigned customer name. ";
+    protected static final String DEVICE_PROFILE_INFO_DESCRIPTION = "Device Profile Info is a lightweight object that includes main information about Device Profile excluding the heavyweight configuration object. ";
+
+    protected static final String DEVICE_NAME_DESCRIPTION = "A string value representing the Device name.";
+    protected static final String ASSET_NAME_DESCRIPTION = "A string value representing the Asset name.";
+
+    protected static final String EVENT_START_TIME_DESCRIPTION = "Timestamp. Events with creation time before it won't be queried.";
+    protected static final String EVENT_END_TIME_DESCRIPTION = "Timestamp. Events with creation time after it won't be queried.";
+
+    protected static final String EDGE_UNASSIGN_ASYNC_FIRST_STEP_DESCRIPTION = "Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. ";
+    protected static final String EDGE_UNASSIGN_RECEIVE_STEP_DESCRIPTION = "(Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform)" ;
+    protected static final String EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION = "Assignment works in async way - first, notification event pushed to edge service queue on platform. ";
+    protected static final String EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION = "(Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform)";
+
+    protected static final String MARKDOWN_CODE_BLOCK_START = "```json\n";
+    protected static final String MARKDOWN_CODE_BLOCK_END = "\n```";
+    protected static final String EVENT_ERROR_FILTER_OBJ = MARKDOWN_CODE_BLOCK_START + "{ \"eventType\": \"ERROR\", \"server\": \"ip-172-31-24-152\", " +
+            "\"method\": \"onClusterEventMsg\", \"error\": \"Error Message\" }" + MARKDOWN_CODE_BLOCK_END;
+    protected static final String EVENT_LC_EVENT_FILTER_OBJ = MARKDOWN_CODE_BLOCK_START + "{ \"eventType\": \"LC_EVENT\", \"server\": \"ip-172-31-24-152\", \"event\":" +
+            " \"STARTED\", \"status\": \"Success\", \"error\": \"Error Message\" }" + MARKDOWN_CODE_BLOCK_END;
+    protected static final String EVENT_STATS_FILTER_OBJ = MARKDOWN_CODE_BLOCK_START + "{ \"eventType\": \"STATS\", \"server\": \"ip-172-31-24-152\", \"messagesProcessed\": 10, \"errorsOccurred\": 5 }" + MARKDOWN_CODE_BLOCK_END;
+    protected static final String DEBUG_FILTER_OBJ = "\"msgDirectionType\": \"IN\", \"server\": \"ip-172-31-24-152\", \"dataSearch\": \"humidity\", " +
+            "\"metadataSearch\": \"deviceName\", \"entityName\": \"DEVICE\", \"relationType\": \"Success\"," +
+            " \"entityId\": \"de9d54a0-2b7a-11ec-a3cc-23386423d98f\", \"msgType\": \"POST_TELEMETRY_REQUEST\"," +
+            " \"isError\": \"false\", \"error\": \"Error Message\" }";
+    protected static final String EVENT_DEBUG_RULE_NODE_FILTER_OBJ = MARKDOWN_CODE_BLOCK_START + "{ \"eventType\": \"DEBUG_RULE_NODE\"," + DEBUG_FILTER_OBJ + MARKDOWN_CODE_BLOCK_END;
+    protected static final String EVENT_DEBUG_RULE_CHAIN_FILTER_OBJ = MARKDOWN_CODE_BLOCK_START + "{ \"eventType\": \"DEBUG_RULE_CHAIN\"," + DEBUG_FILTER_OBJ + MARKDOWN_CODE_BLOCK_END;
+
+    protected static final String RELATION_TYPE_PARAM_DESCRIPTION = "A string value representing relation type between entities. For example, 'Contains', 'Manages'. It can be any string value.";
+    protected static final String RELATION_TYPE_GROUP_PARAM_DESCRIPTION = "A string value representing relation type group. For example, 'COMMON'";
+
+    protected static final String ADMINISTRATOR_AUTHORITY_ONLY = "Available for users with 'Tenant Administrator' authority only.";
 
 
     public static final String INCORRECT_TENANT_ID = "Incorrect tenantId ";
     public static final String INCORRECT_TENANT_ID = "Incorrect tenantId ";
     protected static final String DEFAULT_DASHBOARD = "defaultDashboardId";
     protected static final String DEFAULT_DASHBOARD = "defaultDashboardId";

@@ -212,7 +212,7 @@ public class CustomerController extends BaseController {
     }
     }
 
 
     @ApiOperation(value = "Get Tenant Customer by Customer title (getTenantCustomer)",
     @ApiOperation(value = "Get Tenant Customer by Customer title (getTenantCustomer)",
-            notes = "Get the Customer using Customer Title. Available for users with 'Tenant Administrator' authority only.")
+            notes = "Get the Customer using Customer Title. " + ADMINISTRATOR_AUTHORITY_ONLY)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/customers", params = {"customerTitle"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/customers", params = {"customerTitle"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody

@@ -805,6 +805,13 @@ public class DashboardController extends BaseController {
         return null;
         return null;
     }
     }
 
 
+    @ApiOperation(value = "Assign dashboard to edge (assignDashboardToEdge)",
+            notes = "Creates assignment of an existing dashboard to an instance of The Edge. " +
+                    EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive a copy of assignment dashboard " +
+                    EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once dashboard will be delivered to edge service, it's going to be available for usage on remote edge instance.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/dashboard/{dashboardId}", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/{edgeId}/dashboard/{dashboardId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -838,6 +845,13 @@ public class DashboardController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Unassign dashboard from edge (unassignDashboardFromEdge)",
+            notes = "Clears assignment of the dashboard to the edge. " +
+                    EDGE_UNASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive an 'unassign' command to remove dashboard " +
+                    EDGE_UNASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once 'unassign' command will be delivered to edge service, it's going to remove dashboard locally.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/dashboard/{dashboardId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/edge/{edgeId}/dashboard/{dashboardId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody

@@ -24,6 +24,7 @@ import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -102,8 +103,8 @@ public class DeviceController extends BaseController {
 
 
     @ApiOperation(value = "Get Device (getDeviceById)",
     @ApiOperation(value = "Get Device (getDeviceById)",
             notes = "Fetch the Device object based on the provided Device Id. " +
             notes = "Fetch the Device object based on the provided Device Id. " +
-                    "If the user has the authority of 'Tenant Administrator', the server checks that the device is owned by the same tenant. " +
-                    "If the user has the authority of 'Customer User', the server checks that the device is assigned to the same customer.")
+                    "If the user has the authority of 'TENANT_ADMIN', the server checks that the device is owned by the same tenant. " +
+                    "If the user has the authority of 'CUSTOMER_USER', the server checks that the device is assigned to the same customer.")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/device/{deviceId}", method = RequestMethod.GET)
     @RequestMapping(value = "/device/{deviceId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -141,7 +142,8 @@ public class DeviceController extends BaseController {
             "Device credentials are also generated if not provided in the 'accessToken' request parameter. " +
             "Device credentials are also generated if not provided in the 'accessToken' request parameter. " +
             "The newly created device id will be present in the response. " +
             "The newly created device id will be present in the response. " +
             "Specify existing Device id to update the device. " +
             "Specify existing Device id to update the device. " +
-            "Referencing non-existing device Id will cause 'Not Found' error.")
+            "Referencing non-existing device Id will cause 'Not Found' error." +
+            "\n\nDevice name is unique in the scope of tenant. Use unique identifiers like MAC or IMEI for the device names and non-unique 'label' field for user-friendly visualization purposes.")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/device", method = RequestMethod.POST)
     @RequestMapping(value = "/device", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -371,7 +373,7 @@ public class DeviceController extends BaseController {
 
 
     @ApiOperation(value = "Get Tenant Devices (getTenantDevices)",
     @ApiOperation(value = "Get Tenant Devices (getTenantDevices)",
             notes = "Returns a page of devices owned by tenant. " +
             notes = "Returns a page of devices owned by tenant. " +
-                    PAGE_DATA_PARAMETERS)
+                    PAGE_DATA_PARAMETERS + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/devices", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/devices", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -414,7 +416,7 @@ public class DeviceController extends BaseController {
             @RequestParam int page,
             @RequestParam int page,
             @ApiParam(value = DEVICE_TYPE_DESCRIPTION)
             @ApiParam(value = DEVICE_TYPE_DESCRIPTION)
             @RequestParam(required = false) String type,
             @RequestParam(required = false) String type,
-            @ApiParam(value = DEVICE_PROFILE_ID_DESCRIPTION)
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
             @RequestParam(required = false) String deviceProfileId,
             @RequestParam(required = false) String deviceProfileId,
             @ApiParam(value = DEVICE_TEXT_SEARCH_DESCRIPTION)
             @ApiParam(value = DEVICE_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
@@ -508,7 +510,7 @@ public class DeviceController extends BaseController {
             @RequestParam int page,
             @RequestParam int page,
             @ApiParam(value = DEVICE_TYPE_DESCRIPTION)
             @ApiParam(value = DEVICE_TYPE_DESCRIPTION)
             @RequestParam(required = false) String type,
             @RequestParam(required = false) String type,
-            @ApiParam(value = DEVICE_PROFILE_ID_DESCRIPTION)
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
             @RequestParam(required = false) String deviceProfileId,
             @RequestParam(required = false) String deviceProfileId,
             @ApiParam(value = DEVICE_TEXT_SEARCH_DESCRIPTION)
             @ApiParam(value = DEVICE_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
@@ -571,7 +573,9 @@ public class DeviceController extends BaseController {
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/devices", method = RequestMethod.POST)
     @RequestMapping(value = "/devices", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public List<Device> findByQuery(@RequestBody DeviceSearchQuery query) throws ThingsboardException {
+    public List<Device> findByQuery(
+            @ApiParam(value = "The device search query JSON")
+            @RequestBody DeviceSearchQuery query) throws ThingsboardException {
         checkNotNull(query);
         checkNotNull(query);
         checkNotNull(query.getParameters());
         checkNotNull(query.getParameters());
         checkNotNull(query.getDeviceTypes());
         checkNotNull(query.getDeviceTypes());
@@ -781,8 +785,11 @@ public class DeviceController extends BaseController {
 
 
     @ApiOperation(value = "Assign device to edge (assignDeviceToEdge)",
     @ApiOperation(value = "Assign device to edge (assignDeviceToEdge)",
             notes = "Creates assignment of an existing device to an instance of The Edge. " +
             notes = "Creates assignment of an existing device to an instance of The Edge. " +
-                    "The Edge is a software product for edge computing. " +
-                    "It allows bringing data analysis and management to the edge, while seamlessly synchronizing with the platform server (cloud). ")
+                    EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive a copy of assignment device " +
+                    EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once device will be delivered to edge service, it's going to be available for usage on remote edge instance.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/device/{deviceId}", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/{edgeId}/device/{deviceId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -820,7 +827,12 @@ public class DeviceController extends BaseController {
     }
     }
 
 
     @ApiOperation(value = "Unassign device from edge (unassignDeviceFromEdge)",
     @ApiOperation(value = "Unassign device from edge (unassignDeviceFromEdge)",
-            notes = "Clears assignment of the device to the edge")
+            notes = "Clears assignment of the device to the edge. " +
+                    EDGE_UNASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive an 'unassign' command to remove device " +
+                    EDGE_UNASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once 'unassign' command will be delivered to edge service, it's going to remove device locally.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/device/{deviceId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/edge/{edgeId}/device/{deviceId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -58,10 +60,16 @@ public class DeviceProfileController extends BaseController {
     @Autowired
     @Autowired
     private TimeseriesService timeseriesService;
     private TimeseriesService timeseriesService;
 
 
+    @ApiOperation(value = "Get Device Profile (getDeviceProfileById)",
+            notes = "Fetch the Device Profile object based on the provided Device Profile Id. " +
+                    "The server checks that the device profile is owned by the same tenant. " + TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfile/{deviceProfileId}", method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfile/{deviceProfileId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public DeviceProfile getDeviceProfileById(@PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
+    public DeviceProfile getDeviceProfileById(
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         try {
         try {
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
@@ -71,10 +79,16 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Device Profile Info (getDeviceProfileInfoById)",
+            notes = "Fetch the Device Profile Info object based on the provided Device Profile Id. "
+                    + DEVICE_PROFILE_INFO_DESCRIPTION + TENANT_OR_USER_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/deviceProfileInfo/{deviceProfileId}", method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfileInfo/{deviceProfileId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public DeviceProfileInfo getDeviceProfileInfoById(@PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
+    public DeviceProfileInfo getDeviceProfileInfoById(
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         try {
         try {
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
@@ -84,6 +98,10 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Default Device Profile (getDefaultDeviceProfileInfo)",
+            notes = "Fetch the Default Device Profile Info object. " +
+                    DEVICE_PROFILE_INFO_DESCRIPTION + TENANT_OR_USER_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/deviceProfileInfo/default", method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfileInfo/default", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -95,10 +113,18 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get time-series keys (getTimeseriesKeys)",
+            notes = "Get a set of unique time-series keys used by devices that belong to specified profile. " +
+                    "If profile is not set returns a list of unique keys among all profiles. " +
+                    "The call is used for auto-complete in the UI forms. " +
+                    "The implementation limits the number of devices that participate in search to 100 as a trade of between accurate results and time-consuming queries. " +
+                    TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfile/devices/keys/timeseries", method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfile/devices/keys/timeseries", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public List<String> getTimeseriesKeys(
     public List<String> getTimeseriesKeys(
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
             @RequestParam(name = DEVICE_PROFILE_ID, required = false) String deviceProfileIdStr) throws ThingsboardException {
             @RequestParam(name = DEVICE_PROFILE_ID, required = false) String deviceProfileIdStr) throws ThingsboardException {
         DeviceProfileId deviceProfileId;
         DeviceProfileId deviceProfileId;
         if (StringUtils.isNotEmpty(deviceProfileIdStr)) {
         if (StringUtils.isNotEmpty(deviceProfileIdStr)) {
@@ -115,10 +141,18 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get attribute keys (getAttributesKeys)",
+            notes = "Get a set of unique attribute keys used by devices that belong to specified profile. " +
+                    "If profile is not set returns a list of unique keys among all profiles. " +
+                    "The call is used for auto-complete in the UI forms. " +
+                    "The implementation limits the number of devices that participate in search to 100 as a trade of between accurate results and time-consuming queries. " +
+                    TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfile/devices/keys/attributes", method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfile/devices/keys/attributes", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public List<String> getAttributesKeys(
     public List<String> getAttributesKeys(
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
             @RequestParam(name = DEVICE_PROFILE_ID, required = false) String deviceProfileIdStr) throws ThingsboardException {
             @RequestParam(name = DEVICE_PROFILE_ID, required = false) String deviceProfileIdStr) throws ThingsboardException {
         DeviceProfileId deviceProfileId;
         DeviceProfileId deviceProfileId;
         if (StringUtils.isNotEmpty(deviceProfileIdStr)) {
         if (StringUtils.isNotEmpty(deviceProfileIdStr)) {
@@ -135,10 +169,20 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Create Or Update Device Profile (saveDevice)",
+            notes = "Create or update the Device Profile. When creating device profile, platform generates device profile id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "The newly created device profile id will be present in the response. " +
+                    "Specify existing device profile id to update the device profile. " +
+                    "Referencing non-existing device profile Id will cause 'Not Found' error. " +
+                    "\n\nDevice profile name is unique in the scope of tenant. Only one 'default' device profile may exist in scope of tenant." + TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json",
+            consumes = "application/json")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfile", method = RequestMethod.POST)
     @RequestMapping(value = "/deviceProfile", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeviceProfile saveDeviceProfile(@RequestBody DeviceProfile deviceProfile) throws ThingsboardException {
+    public DeviceProfile saveDeviceProfile(
+            @ApiParam(value = "A JSON value representing the device profile.")
+            @RequestBody DeviceProfile deviceProfile) throws ThingsboardException {
         try {
         try {
             boolean created = deviceProfile.getId() == null;
             boolean created = deviceProfile.getId() == null;
             deviceProfile.setTenantId(getTenantId());
             deviceProfile.setTenantId(getTenantId());
@@ -180,10 +224,16 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete device profile (deleteDeviceProfile)",
+            notes = "Deletes the device profile. Referencing non-existing device profile Id will cause an error. " +
+                    "Can't delete the device profile if it is referenced by existing devices." + TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfile/{deviceProfileId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/deviceProfile/{deviceProfileId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteDeviceProfile(@PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
+    public void deleteDeviceProfile(
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         try {
         try {
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
@@ -207,10 +257,15 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Make Device Profile Default (setDefaultDeviceProfile)",
+            notes = "Marks device profile as default within a tenant scope." + TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfile/{deviceProfileId}/default", method = RequestMethod.POST)
     @RequestMapping(value = "/deviceProfile/{deviceProfileId}/default", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeviceProfile setDefaultDeviceProfile(@PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
+    public DeviceProfile setDefaultDeviceProfile(
+            @ApiParam(value = DEVICE_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable(DEVICE_PROFILE_ID) String strDeviceProfileId) throws ThingsboardException {
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         checkParameter(DEVICE_PROFILE_ID, strDeviceProfileId);
         try {
         try {
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
             DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(strDeviceProfileId));
@@ -238,14 +293,24 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Device Profiles (getDeviceProfiles)",
+            notes = "Returns a page of devices profile objects owned by tenant. " +
+                    PAGE_DATA_PARAMETERS + TENANT_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/deviceProfiles", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfiles", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<DeviceProfile> getDeviceProfiles(@RequestParam int pageSize,
-                                                     @RequestParam int page,
-                                                     @RequestParam(required = false) String textSearch,
-                                                     @RequestParam(required = false) String sortProperty,
-                                                     @RequestParam(required = false) String sortOrder) throws ThingsboardException {
+    public PageData<DeviceProfile> getDeviceProfiles(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = DEVICE_PROFILE_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = DEVICE_PROFILE_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             return checkNotNull(deviceProfileService.findDeviceProfiles(getTenantId(), pageLink));
             return checkNotNull(deviceProfileService.findDeviceProfiles(getTenantId(), pageLink));
@@ -254,15 +319,26 @@ public class DeviceProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Device Profiles for transport type (getDeviceProfileInfos)",
+            notes = "Returns a page of devices profile info objects owned by tenant. " +
+                    PAGE_DATA_PARAMETERS + DEVICE_PROFILE_INFO_DESCRIPTION + TENANT_OR_USER_AUTHORITY_PARAGRAPH,
+            produces = "application/json")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/deviceProfileInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/deviceProfileInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<DeviceProfileInfo> getDeviceProfileInfos(@RequestParam int pageSize,
-                                                             @RequestParam int page,
-                                                             @RequestParam(required = false) String textSearch,
-                                                             @RequestParam(required = false) String sortProperty,
-                                                             @RequestParam(required = false) String sortOrder,
-                                                             @RequestParam(required = false) String transportType) throws ThingsboardException {
+    public PageData<DeviceProfileInfo> getDeviceProfileInfos(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = DEVICE_PROFILE_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = DEVICE_PROFILE_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = "Type of the transport", allowableValues = TRANSPORT_TYPE_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String transportType) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             return checkNotNull(deviceProfileService.findDeviceProfileInfos(getTenantId(), pageLink, transportType));
             return checkNotNull(deviceProfileService.findDeviceProfileInfos(getTenantId(), pageLink, transportType));

@@ -17,9 +17,12 @@ package org.thingsboard.server.controller;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.ListenableFuture;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -75,7 +78,11 @@ public class EdgeController extends BaseController {
     private final EdgeBulkImportService edgeBulkImportService;
     private final EdgeBulkImportService edgeBulkImportService;
 
 
     public static final String EDGE_ID = "edgeId";
     public static final String EDGE_ID = "edgeId";
+    public static final String EDGE_SECURITY_CHECK = "If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. " +
+            "If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer.";
 
 
+    @ApiOperation(value = "Is edges support enabled (isEdgesSupportEnabled)",
+            notes = "Returns 'true' if edges support enabled on server, 'false' - otherwise.")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/edges/enabled", method = RequestMethod.GET)
     @RequestMapping(value = "/edges/enabled", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -83,10 +90,14 @@ public class EdgeController extends BaseController {
         return edgesEnabled;
         return edgesEnabled;
     }
     }
 
 
+    @ApiOperation(value = "Get Edge (getEdgeById)",
+            notes = "Get the Edge object based on the provided Edge Id. " + EDGE_SECURITY_CHECK,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/edge/{edgeId}", method = RequestMethod.GET)
     @RequestMapping(value = "/edge/{edgeId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public Edge getEdgeById(@PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
+    public Edge getEdgeById(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                            @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         try {
         try {
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
@@ -100,10 +111,14 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Edge Info (getEdgeInfoById)",
+            notes = "Get the Edge Info object based on the provided Edge Id. " + EDGE_SECURITY_CHECK,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/edge/info/{edgeId}", method = RequestMethod.GET)
     @RequestMapping(value = "/edge/info/{edgeId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public EdgeInfo getEdgeInfoById(@PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
+    public EdgeInfo getEdgeInfoById(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                                    @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         try {
         try {
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
@@ -117,10 +132,18 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Create Or Update Edge (saveEdge)",
+            notes = "Create or update the Edge. When creating edge, platform generates Edge Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "The newly created edge id will be present in the response. " +
+                    "Specify existing Edge id to update the edge. " +
+                    "Referencing non-existing Edge Id will cause 'Not Found' error." +
+                    "\n\nEdge name is unique in the scope of tenant. Use unique identifiers like MAC or IMEI for the edge names and non-unique 'label' field for user-friendly visualization purposes.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge", method = RequestMethod.POST)
     @RequestMapping(value = "/edge", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public Edge saveEdge(@RequestBody Edge edge) throws ThingsboardException {
+    public Edge saveEdge(@ApiParam(value = "A JSON value representing the edge.", required = true)
+                         @RequestBody Edge edge) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
             edge.setTenantId(tenantId);
             edge.setTenantId(tenantId);
@@ -163,10 +186,13 @@ public class EdgeController extends BaseController {
         logEntityAction(user, edge.getId(), edge, null, updated ? ActionType.UPDATED : ActionType.ADDED, null);
         logEntityAction(user, edge.getId(), edge, null, updated ? ActionType.UPDATED : ActionType.ADDED, null);
     }
     }
 
 
+    @ApiOperation(value = "Delete edge (deleteEdge)",
+            notes = "Deletes the edge. Referencing non-existing edge Id will cause an error.")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/edge/{edgeId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteEdge(@PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
+    public void deleteEdge(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                           @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         try {
         try {
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
@@ -191,13 +217,21 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Edges (getEdges)",
+            notes = "Returns a page of edges owned by tenant. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edges", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/edges", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<Edge> getEdges(@RequestParam int pageSize,
+    public PageData<Edge> getEdges(@ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+                                   @RequestParam int pageSize,
+                                   @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
                                    @RequestParam int page,
                                    @RequestParam int page,
+                                   @ApiParam(value = EDGE_TEXT_SEARCH_DESCRIPTION)
                                    @RequestParam(required = false) String textSearch,
                                    @RequestParam(required = false) String textSearch,
+                                   @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EDGE_SORT_PROPERTY_ALLOWABLE_VALUES)
                                    @RequestParam(required = false) String sortProperty,
                                    @RequestParam(required = false) String sortProperty,
+                                   @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
                                    @RequestParam(required = false) String sortOrder) throws ThingsboardException {
                                    @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
@@ -208,10 +242,15 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Assign edge to customer (assignEdgeToCustomer)",
+            notes = "Creates assignment of the edge to customer. Customer will be able to query edge afterwards.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/customer/{customerId}/edge/{edgeId}", method = RequestMethod.POST)
     @RequestMapping(value = "/customer/{customerId}/edge/{edgeId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public Edge assignEdgeToCustomer(@PathVariable("customerId") String strCustomerId,
+    public Edge assignEdgeToCustomer(@ApiParam(value = CUSTOMER_ID_PARAM_DESCRIPTION, required = true)
+                                     @PathVariable("customerId") String strCustomerId,
+                                     @ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
                                      @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
                                      @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
         checkParameter("customerId", strCustomerId);
         checkParameter("customerId", strCustomerId);
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
@@ -243,10 +282,14 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Unassign edge from customer (unassignEdgeFromCustomer)",
+            notes = "Clears assignment of the edge to customer. Customer will not be able to query edge afterwards.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/customer/edge/{edgeId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/customer/edge/{edgeId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody
-    public Edge unassignEdgeFromCustomer(@PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
+    public Edge unassignEdgeFromCustomer(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                                         @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         try {
         try {
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
@@ -277,10 +320,16 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Make edge publicly available (assignEdgeToPublicCustomer)",
+            notes = "Edge will be available for non-authorized (not logged-in) users. " +
+                    "This is useful to create dashboards that you plan to share/embed on a publicly available website. " +
+                    "However, users that are logged-in and belong to different tenant will not be able to access the edge.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/customer/public/edge/{edgeId}", method = RequestMethod.POST)
     @RequestMapping(value = "/customer/public/edge/{edgeId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public Edge assignEdgeToPublicCustomer(@PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
+    public Edge assignEdgeToPublicCustomer(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                                           @PathVariable(EDGE_ID) String strEdgeId) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         try {
         try {
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
@@ -304,15 +353,24 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Edges (getTenantEdges)",
+            notes = "Returns a page of edges owned by tenant. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/edges", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/edges", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<Edge> getTenantEdges(
     public PageData<Edge> getTenantEdges(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = EDGE_TYPE_DESCRIPTION)
             @RequestParam(required = false) String type,
             @RequestParam(required = false) String type,
+            @ApiParam(value = EDGE_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EDGE_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
@@ -327,15 +385,25 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Edge Infos (getTenantEdgeInfos)",
+            notes = "Returns a page of edges info objects owned by tenant. " +
+                    PAGE_DATA_PARAMETERS + EDGE_INFO_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/edgeInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/edgeInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<EdgeInfo> getTenantEdgeInfos(
     public PageData<EdgeInfo> getTenantEdgeInfos(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = EDGE_TYPE_DESCRIPTION)
             @RequestParam(required = false) String type,
             @RequestParam(required = false) String type,
+            @ApiParam(value = EDGE_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EDGE_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
@@ -350,10 +418,15 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Edge (getTenantEdge)",
+            notes = "Requested edge must be owned by tenant or customer that the user belongs to. " +
+                    "Edge name is an unique property of edge. So it can be used to identify the edge.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/edges", params = {"edgeName"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/edges", params = {"edgeName"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public Edge getTenantEdge(@RequestParam String edgeName) throws ThingsboardException {
+    public Edge getTenantEdge(@ApiParam(value = "Unique name of the edge", required = true)
+                              @RequestParam String edgeName) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
             return checkNotNull(edgeService.findEdgeByTenantIdAndName(tenantId, edgeName));
             return checkNotNull(edgeService.findEdgeByTenantIdAndName(tenantId, edgeName));
@@ -362,10 +435,16 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Set root rule chain for provided edge (setRootRuleChain)",
+            notes = "Change root rule chain of the edge to the new provided rule chain. \n" +
+                    "This operation will send a notification to update root rule chain on remote edge service.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/{ruleChainId}/root", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/{edgeId}/{ruleChainId}/root", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public Edge setRootRuleChain(@PathVariable(EDGE_ID) String strEdgeId,
+    public Edge setRootRuleChain(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                                 @PathVariable(EDGE_ID) String strEdgeId,
+                                 @ApiParam(value = RULE_CHAIN_ID_PARAM_DESCRIPTION, required = true)
                                  @PathVariable("ruleChainId") String strRuleChainId) throws ThingsboardException {
                                  @PathVariable("ruleChainId") String strRuleChainId) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter("ruleChainId", strRuleChainId);
         checkParameter("ruleChainId", strRuleChainId);
@@ -394,16 +473,26 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Customer Edges (getCustomerEdges)",
+            notes = "Returns a page of edges objects assigned to customer. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/customer/{customerId}/edges", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/customer/{customerId}/edges", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<Edge> getCustomerEdges(
     public PageData<Edge> getCustomerEdges(
+            @ApiParam(value = CUSTOMER_ID_PARAM_DESCRIPTION)
             @PathVariable("customerId") String strCustomerId,
             @PathVariable("customerId") String strCustomerId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = EDGE_TYPE_DESCRIPTION)
             @RequestParam(required = false) String type,
             @RequestParam(required = false) String type,
+            @ApiParam(value = EDGE_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EDGE_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         checkParameter("customerId", strCustomerId);
         checkParameter("customerId", strCustomerId);
         try {
         try {
@@ -429,16 +518,26 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Customer Edge Infos (getCustomerEdgeInfos)",
+            notes = "Returns a page of edges info objects assigned to customer. " +
+                    PAGE_DATA_PARAMETERS + EDGE_INFO_DESCRIPTION, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/customer/{customerId}/edgeInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/customer/{customerId}/edgeInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<EdgeInfo> getCustomerEdgeInfos(
     public PageData<EdgeInfo> getCustomerEdgeInfos(
+            @ApiParam(value = CUSTOMER_ID_PARAM_DESCRIPTION)
             @PathVariable("customerId") String strCustomerId,
             @PathVariable("customerId") String strCustomerId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = EDGE_TYPE_DESCRIPTION)
             @RequestParam(required = false) String type,
             @RequestParam(required = false) String type,
+            @ApiParam(value = EDGE_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EDGE_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         checkParameter("customerId", strCustomerId);
         checkParameter("customerId", strCustomerId);
         try {
         try {
@@ -464,10 +563,14 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Edges By Ids (getEdgesByIds)",
+            notes = "Requested edges must be owned by tenant or assigned to customer which user is performing the request.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/edges", params = {"edgeIds"}, method = RequestMethod.GET)
     @RequestMapping(value = "/edges", params = {"edgeIds"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public List<Edge> getEdgesByIds(
     public List<Edge> getEdgesByIds(
+            @ApiParam(value = "A list of edges ids, separated by comma ','", required = true)
             @RequestParam("edgeIds") String[] strEdgeIds) throws ThingsboardException {
             @RequestParam("edgeIds") String[] strEdgeIds) throws ThingsboardException {
         checkArrayParameter("edgeIds", strEdgeIds);
         checkArrayParameter("edgeIds", strEdgeIds);
         try {
         try {
@@ -496,6 +599,11 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find related edges (findByQuery)",
+            notes = "Returns all edges that are related to the specific entity. " +
+                    "The entity id, relation type, edge types, depth of the search, and other query parameters defined using complex 'EdgeSearchQuery' object. " +
+                    "See 'Model' tab of the Parameters for more info.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/edges", method = RequestMethod.POST)
     @RequestMapping(value = "/edges", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -527,6 +635,9 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Edge Types (getEdgeTypes)",
+            notes = "Returns a set of unique edge types based on edges that are either owned by the tenant or assigned to the customer which user is performing the request.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/edge/types", method = RequestMethod.GET)
     @RequestMapping(value = "/edge/types", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -541,9 +652,13 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Sync edge (syncEdge)",
+            notes = "Starts synchronization process between edge and cloud. \n" +
+                    "All entities that are assigned to particular edge are going to be send to remote edge service.")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/sync/{edgeId}", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/sync/{edgeId}", method = RequestMethod.POST)
-    public void syncEdge(@PathVariable("edgeId") String strEdgeId) throws ThingsboardException {
+    public void syncEdge(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                         @PathVariable("edgeId") String strEdgeId) throws ThingsboardException {
         checkParameter("edgeId", strEdgeId);
         checkParameter("edgeId", strEdgeId);
         try {
         try {
             if (isEdgesEnabled()) {
             if (isEdgesEnabled()) {
@@ -560,10 +675,13 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find missing rule chains (findMissingToRelatedRuleChains)",
+            notes = "Returns list of rule chains ids that are not assigned to particular edge, but these rule chains are present in the already assigned rule chains to edge.")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/missingToRelatedRuleChains/{edgeId}", method = RequestMethod.GET)
     @RequestMapping(value = "/edge/missingToRelatedRuleChains/{edgeId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public String findMissingToRelatedRuleChains(@PathVariable("edgeId") String strEdgeId) throws ThingsboardException {
+    public String findMissingToRelatedRuleChains(@ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
+                                                 @PathVariable("edgeId") String strEdgeId) throws ThingsboardException {
         try {
         try {
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             EdgeId edgeId = new EdgeId(toUUID(strEdgeId));
             edgeId = checkNotNull(edgeId);
             edgeId = checkNotNull(edgeId);
@@ -575,9 +693,12 @@ public class EdgeController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Import the bulk of edges (processEdgesBulkImport)",
+            notes = "There's an ability to import the bulk of edges using the only .csv file.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PostMapping("/edge/bulk_import")
     @PostMapping("/edge/bulk_import")
-    public BulkImportResult<Edge> processEdgeBulkImport(@RequestBody BulkImportRequest request) throws Exception {
+    public BulkImportResult<Edge> processEdgesBulkImport(@RequestBody BulkImportRequest request) throws Exception {
         SecurityUser user = getCurrentUser();
         SecurityUser user = getCurrentUser();
         RuleChain edgeTemplateRootRuleChain = ruleChainService.getEdgeTemplateRootRuleChain(user.getTenantId());
         RuleChain edgeTemplateRootRuleChain = ruleChainService.getEdgeTemplateRootRuleChain(user.getTenantId());
         if (edgeTemplateRootRuleChain == null) {
         if (edgeTemplateRootRuleChain == null) {

@@ -15,8 +15,11 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -45,17 +48,28 @@ public class EdgeEventController extends BaseController {
 
 
     public static final String EDGE_ID = "edgeId";
     public static final String EDGE_ID = "edgeId";
 
 
+    @ApiOperation(value = "Get Edge Events (getEdgeEvents)",
+            notes = "Returns a page of edge events for the requested edge. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/events", method = RequestMethod.GET)
     @RequestMapping(value = "/edge/{edgeId}/events", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<EdgeEvent> getEdgeEvents(
     public PageData<EdgeEvent> getEdgeEvents(
+            @ApiParam(value = EDGE_ID_PARAM_DESCRIPTION, required = true)
             @PathVariable(EDGE_ID) String strEdgeId,
             @PathVariable(EDGE_ID) String strEdgeId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = "The case insensitive 'startsWith' filter based on the edge event type name.")
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EDGE_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = "Timestamp. Edge events with creation time before it won't be queried")
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = "Timestamp. Edge events with creation time after it won't be queried")
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
         checkParameter(EDGE_ID, strEdgeId);
         checkParameter(EDGE_ID, strEdgeId);
         try {
         try {

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -42,15 +44,650 @@ import org.thingsboard.server.service.query.EntityQueryService;
 @RequestMapping("/api")
 @RequestMapping("/api")
 public class EntityQueryController extends BaseController {
 public class EntityQueryController extends BaseController {
 
 
+    private static final String SINGLE_ENTITY = "\n\n## Single Entity\n\n" +
+            "Allows to filter only one entity based on the id. For example, this entity filter selects certain device:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"singleEntity\",\n" +
+            "  \"singleEntity\": {\n" +
+            "    \"id\": \"d521edb0-2a7a-11ec-94eb-213c95f54092\",\n" +
+            "    \"entityType\": \"DEVICE\"\n" +
+            "  }\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String ENTITY_LIST = "\n\n## Entity List Filter\n\n" +
+            "Allows to filter entities of the same type using their ids. For example, this entity filter selects two devices:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"entityList\",\n" +
+            "  \"entityType\": \"DEVICE\",\n" +
+            "  \"entityList\": [\n" +
+            "    \"e6501f30-2a7a-11ec-94eb-213c95f54092\",\n" +
+            "    \"e6657bf0-2a7a-11ec-94eb-213c95f54092\"\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String ENTITY_NAME = "\n\n## Entity Name Filter\n\n" +
+            "Allows to filter entities of the same type using the **'starts with'** expression over entity name. " +
+            "For example, this entity filter selects all devices which name starts with 'Air Quality':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"entityName\",\n" +
+            "  \"entityType\": \"DEVICE\",\n" +
+            "  \"entityNameFilter\": \"Air Quality\"\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String ENTITY_TYPE = "\n\n## Entity Type Filter\n\n" +
+            "Allows to filter entities based on their type (CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, etc)" +
+            "For example, this entity filter selects all tenant customers:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"entityType\",\n" +
+            "  \"entityType\": \"CUSTOMER\"\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String ASSET_TYPE = "\n\n## Asset Type Filter\n\n" +
+            "Allows to filter assets based on their type and the **'starts with'** expression over their name. " +
+            "For example, this entity filter selects all 'charging station' assets which name starts with 'Tesla':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"assetType\",\n" +
+            "  \"assetType\": \"charging station\",\n" +
+            "  \"assetNameFilter\": \"Tesla\"\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String DEVICE_TYPE = "\n\n## Device Type Filter\n\n" +
+            "Allows to filter devices based on their type and the **'starts with'** expression over their name. " +
+            "For example, this entity filter selects all 'Temperature Sensor' devices which name starts with 'ABC':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"deviceType\",\n" +
+            "  \"deviceType\": \"Temperature Sensor\",\n" +
+            "  \"deviceNameFilter\": \"ABC\"\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String EDGE_TYPE = "\n\n## Edge Type Filter\n\n" +
+            "Allows to filter edge instances based on their type and the **'starts with'** expression over their name. " +
+            "For example, this entity filter selects all 'Factory' edge instances which name starts with 'Nevada':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"edgeType\",\n" +
+            "  \"edgeType\": \"Factory\",\n" +
+            "  \"edgeNameFilter\": \"Nevada\"\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String ENTITY_VIEW_TYPE = "\n\n## Entity View Filter\n\n" +
+            "Allows to filter entity views based on their type and the **'starts with'** expression over their name. " +
+            "For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"entityViewType\",\n" +
+            "  \"entityViewType\": \"Concrete Mixer\",\n" +
+            "  \"entityViewNameFilter\": \"CAT\"\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String API_USAGE = "\n\n## Api Usage Filter\n\n" +
+            "Allows to query for Api Usage based on optional customer id. If the customer id is not set, returns current tenant API usage." +
+            "For example, this entity filter selects the 'Api Usage' entity for customer with id 'e6501f30-2a7a-11ec-94eb-213c95f54092':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"apiUsageState\",\n" +
+            "  \"customerId\": {\n" +
+            "    \"id\": \"d521edb0-2a7a-11ec-94eb-213c95f54092\",\n" +
+            "    \"entityType\": \"CUSTOMER\"\n" +
+            "  }\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String MAX_LEVEL_DESCRIPTION = "Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. ";
+    private static final String FETCH_LAST_LEVEL_ONLY_DESCRIPTION = "Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. ";
+
+    private static final String RELATIONS_QUERY_FILTER = "\n\n## Relations Query Filter\n\n" +
+            "Allows to filter entities that are related to the provided root entity. " +
+            MAX_LEVEL_DESCRIPTION +
+            FETCH_LAST_LEVEL_ONLY_DESCRIPTION +
+            "The 'filter' object allows you to define the relation type and set of acceptable entity types to search for. " +
+            "The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only those who match the 'filters'.\n\n" +
+            "For example, this entity filter selects all devices and assets which are related to the asset with id 'e51de0c0-2a7a-11ec-94eb-213c95f54092':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"relationsQuery\",\n" +
+            "  \"rootEntity\": {\n" +
+            "    \"entityType\": \"ASSET\",\n" +
+            "    \"id\": \"e51de0c0-2a7a-11ec-94eb-213c95f54092\"\n" +
+            "  },\n" +
+            "  \"direction\": \"FROM\",\n" +
+            "  \"maxLevel\": 1,\n" +
+            "  \"fetchLastLevelOnly\": false,\n" +
+            "  \"filters\": [\n" +
+            "    {\n" +
+            "      \"relationType\": \"Contains\",\n" +
+            "      \"entityTypes\": [\n" +
+            "        \"DEVICE\",\n" +
+            "        \"ASSET\"\n" +
+            "      ]\n" +
+            "    }\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+
+    private static final String ASSET_QUERY_FILTER = "\n\n## Asset Search Query\n\n" +
+            "Allows to filter assets that are related to the provided root entity. Filters related assets based on the relation type and set of asset types. " +
+            MAX_LEVEL_DESCRIPTION +
+            FETCH_LAST_LEVEL_ONLY_DESCRIPTION +
+            "The 'relationType' defines the type of the relation to search for. " +
+            "The 'assetTypes' defines the type of the asset to search for. " +
+            "The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only assets that match 'relationType' and 'assetTypes' conditions.\n\n" +
+            "For example, this entity filter selects 'charging station' assets which are related to the asset with id 'e51de0c0-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"assetSearchQuery\",\n" +
+            "  \"rootEntity\": {\n" +
+            "    \"entityType\": \"ASSET\",\n" +
+            "    \"id\": \"e51de0c0-2a7a-11ec-94eb-213c95f54092\"\n" +
+            "  },\n" +
+            "  \"direction\": \"FROM\",\n" +
+            "  \"maxLevel\": 1,\n" +
+            "  \"fetchLastLevelOnly\": false,\n" +
+            "  \"relationType\": \"Contains\",\n" +
+            "  \"assetTypes\": [\n" +
+            "    \"charging station\"\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String DEVICE_QUERY_FILTER = "\n\n## Device Search Query\n\n" +
+            "Allows to filter devices that are related to the provided root entity. Filters related devices based on the relation type and set of device types. " +
+            MAX_LEVEL_DESCRIPTION +
+            FETCH_LAST_LEVEL_ONLY_DESCRIPTION +
+            "The 'relationType' defines the type of the relation to search for. " +
+            "The 'deviceTypes' defines the type of the device to search for. " +
+            "The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions.\n\n" +
+            "For example, this entity filter selects 'Charging port' and 'Air Quality Sensor' devices which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"deviceSearchQuery\",\n" +
+            "  \"rootEntity\": {\n" +
+            "    \"entityType\": \"ASSET\",\n" +
+            "    \"id\": \"e52b0020-2a7a-11ec-94eb-213c95f54092\"\n" +
+            "  },\n" +
+            "  \"direction\": \"FROM\",\n" +
+            "  \"maxLevel\": 2,\n" +
+            "  \"fetchLastLevelOnly\": true,\n" +
+            "  \"relationType\": \"Contains\",\n" +
+            "  \"deviceTypes\": [\n" +
+            "    \"Air Quality Sensor\",\n" +
+            "    \"Charging port\"\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String EV_QUERY_FILTER = "\n\n## Entity View Query\n\n" +
+            "Allows to filter entity views that are related to the provided root entity. Filters related entity views based on the relation type and set of entity view types. " +
+            MAX_LEVEL_DESCRIPTION +
+            FETCH_LAST_LEVEL_ONLY_DESCRIPTION +
+            "The 'relationType' defines the type of the relation to search for. " +
+            "The 'entityViewTypes' defines the type of the entity view to search for. " +
+            "The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions.\n\n" +
+            "For example, this entity filter selects 'Concrete mixer' entity views which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"entityViewSearchQuery\",\n" +
+            "  \"rootEntity\": {\n" +
+            "    \"entityType\": \"ASSET\",\n" +
+            "    \"id\": \"e52b0020-2a7a-11ec-94eb-213c95f54092\"\n" +
+            "  },\n" +
+            "  \"direction\": \"FROM\",\n" +
+            "  \"maxLevel\": 1,\n" +
+            "  \"fetchLastLevelOnly\": false,\n" +
+            "  \"relationType\": \"Contains\",\n" +
+            "  \"entityViewTypes\": [\n" +
+            "    \"Concrete mixer\"\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String EDGE_QUERY_FILTER = "\n\n## Edge Search Query\n\n" +
+            "Allows to filter edge instances that are related to the provided root entity. Filters related edge instances based on the relation type and set of edge types. " +
+            MAX_LEVEL_DESCRIPTION +
+            FETCH_LAST_LEVEL_ONLY_DESCRIPTION +
+            "The 'relationType' defines the type of the relation to search for. " +
+            "The 'deviceTypes' defines the type of the device to search for. " +
+            "The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions.\n\n" +
+            "For example, this entity filter selects 'Factory' edge instances which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation:\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"deviceSearchQuery\",\n" +
+            "  \"rootEntity\": {\n" +
+            "    \"entityType\": \"ASSET\",\n" +
+            "    \"id\": \"e52b0020-2a7a-11ec-94eb-213c95f54092\"\n" +
+            "  },\n" +
+            "  \"direction\": \"FROM\",\n" +
+            "  \"maxLevel\": 2,\n" +
+            "  \"fetchLastLevelOnly\": true,\n" +
+            "  \"relationType\": \"Contains\",\n" +
+            "  \"edgeTypes\": [\n" +
+            "    \"Factory\"\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String EMPTY = "\n\n## Entity Type Filter\n\n" +
+            "Allows to filter multiple entities of the same type using the **'starts with'** expression over entity name. " +
+            "For example, this entity filter selects all devices which name starts with 'Air Quality':\n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            ""+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String ENTITY_FILTERS =
+            "\n\n # Entity Filters" +
+            "\nEntity Filter body depends on the 'type' parameter. Let's review available entity filter types. In fact, they do correspond to available dashboard aliases." +
+            SINGLE_ENTITY + ENTITY_LIST + ENTITY_NAME + ENTITY_TYPE + ASSET_TYPE + DEVICE_TYPE + EDGE_TYPE + ENTITY_VIEW_TYPE + API_USAGE + RELATIONS_QUERY_FILTER
+            + ASSET_QUERY_FILTER + DEVICE_QUERY_FILTER + EV_QUERY_FILTER + EDGE_QUERY_FILTER;
+
+    private static final String FILTER_KEY = "\n\n## Filter Key\n\n" +
+            "Filter Key defines either entity field, attribute or telemetry. It is a JSON object that consists the key name and type. " +
+            "The following filter key types are supported: \n\n"+
+            " * 'CLIENT_ATTRIBUTE' - used for client attributes; \n" +
+            " * 'SHARED_ATTRIBUTE' - used for shared attributes; \n" +
+            " * 'SERVER_ATTRIBUTE' - used for server attributes; \n" +
+            " * 'ATTRIBUTE' - used for any of the above; \n" +
+            " * 'TIME_SERIES' - used for time-series values; \n" +
+            " * 'ENTITY_FIELD' - used for accessing entity fields like 'name', 'label', etc. The list of available fields depends on the entity type; \n" +
+            " * 'ALARM_FIELD' - similar to entity field, but is used in alarm queries only; \n" +
+            "\n\n Let's review the example:\n\n" +
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"TIME_SERIES\",\n" +
+            "  \"key\": \"temperature\"\n" +
+            "}" +
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
+    private static final String FILTER_VALUE_TYPE = "\n\n## Value Type and Operations\n\n" +
+            "Provides a hint about the data type of the entity field that is defined in the filter key. " +
+            "The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values." +
+            "The following filter value types and corresponding predicate operations are supported: \n\n"+
+            " * 'STRING' - used to filter any 'String' or 'JSON' values. Operations: EQUAL, NOT_EQUAL, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS; \n" +
+            " * 'NUMERIC' - used for 'Long' and 'Double' values. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; \n" +
+            " * 'BOOLEAN' - used for boolean values; Operations: EQUAL, NOT_EQUAL \n" +
+            " * 'DATE_TIME' - similar to numeric, transforms value to milliseconds since epoch. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; \n";
+
+    private static final String FILTER_PREDICATE = "\n\n## Filter Predicate\n\n" +
+            "Filter Predicate defines the logical expression to evaluate. The list of available operations depends on the filter value type, see above. " +
+            "Platform supports 4 predicate types: 'STRING', 'NUMERIC', 'BOOLEAN' and 'COMPLEX'. The last one allows to combine multiple operations over one filter key." +
+            "\n\nSimple predicate example to check 'value < 100': \n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"operation\": \"LESS\",\n" +
+            "  \"value\": {\n" +
+            "    \"defaultValue\": 100,\n" +
+            "    \"dynamicValue\": null\n" +
+            "  },\n" +
+            "  \"type\": \"NUMERIC\"\n" +
+            "}" +
+            MARKDOWN_CODE_BLOCK_END +
+            "\n\nComplex predicate example, to check 'value < 10 or value > 20': \n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"COMPLEX\",\n" +
+            "  \"operation\": \"OR\",\n" +
+            "  \"predicates\": [\n" +
+            "    {\n" +
+            "      \"operation\": \"LESS\",\n" +
+            "      \"value\": {\n" +
+            "        \"defaultValue\": 10,\n" +
+            "        \"dynamicValue\": null\n" +
+            "      },\n" +
+            "      \"type\": \"NUMERIC\"\n" +
+            "    },\n" +
+            "    {\n" +
+            "      \"operation\": \"GREATER\",\n" +
+            "      \"value\": {\n" +
+            "        \"defaultValue\": 20,\n" +
+            "        \"dynamicValue\": null\n" +
+            "      },\n" +
+            "      \"type\": \"NUMERIC\"\n" +
+            "    }\n" +
+            "  ]\n" +
+            "}" +
+            MARKDOWN_CODE_BLOCK_END +
+            "\n\nMore complex predicate example, to check 'value < 10 or (value > 50 && value < 60)': \n\n"+
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"type\": \"COMPLEX\",\n" +
+            "  \"operation\": \"OR\",\n" +
+            "  \"predicates\": [\n" +
+            "    {\n" +
+            "      \"operation\": \"LESS\",\n" +
+            "      \"value\": {\n" +
+            "        \"defaultValue\": 10,\n" +
+            "        \"dynamicValue\": null\n" +
+            "      },\n" +
+            "      \"type\": \"NUMERIC\"\n" +
+            "    },\n" +
+            "    {\n" +
+            "      \"type\": \"COMPLEX\",\n" +
+            "      \"operation\": \"AND\",\n" +
+            "      \"predicates\": [\n" +
+            "        {\n" +
+            "          \"operation\": \"GREATER\",\n" +
+            "          \"value\": {\n" +
+            "            \"defaultValue\": 50,\n" +
+            "            \"dynamicValue\": null\n" +
+            "          },\n" +
+            "          \"type\": \"NUMERIC\"\n" +
+            "        },\n" +
+            "        {\n" +
+            "          \"operation\": \"LESS\",\n" +
+            "          \"value\": {\n" +
+            "            \"defaultValue\": 60,\n" +
+            "            \"dynamicValue\": null\n" +
+            "          },\n" +
+            "          \"type\": \"NUMERIC\"\n" +
+            "        }\n" +
+            "      ]\n" +
+            "    }\n" +
+            "  ]\n" +
+            "}" +
+            MARKDOWN_CODE_BLOCK_END +
+            "\n\n You may also want to replace hardcoded values (for example, temperature > 20) with the more dynamic " +
+            "expression (for example, temperature > 'value of the tenant attribute with key 'temperatureThreshold'). " +
+            "It is possible to use 'dynamicValue' to define attribute of the tenant, customer or user that is performing the API call. " +
+            "See example below: \n\n" +
+            MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"operation\": \"GREATER\",\n" +
+            "  \"value\": {\n" +
+            "    \"defaultValue\": 0,\n" +
+            "    \"dynamicValue\": {\n" +
+            "      \"sourceType\": \"CURRENT_USER\",\n" +
+            "      \"sourceAttribute\": \"temperatureThreshold\"\n" +
+            "    }\n" +
+            "  },\n" +
+            "  \"type\": \"NUMERIC\"\n" +
+            "}" +
+            MARKDOWN_CODE_BLOCK_END +
+            "\n\n Note that you may use 'CURRENT_USER', 'CURRENT_CUSTOMER' and 'CURRENT_TENANT' as a 'sourceType'. The 'defaultValue' is used when the attribute with such a name is not defined for the chosen source.";
+
+    private static final String KEY_FILTERS =
+            "\n\n # Key Filters" +
+                    "\nKey Filter allows you to define complex logical expressions over entity field, attribute or latest time-series value. The filter is defined using 'key', 'valueType' and 'predicate' objects. " +
+                    "Single Entity Query may have zero, one or multiple predicates. If multiple filters are defined, they are evaluated using logical 'AND'. " +
+                    "The example below checks that temperature of the entity is above 20 degrees:" +
+                    "\n\n" + MARKDOWN_CODE_BLOCK_START +
+                    "{\n" +
+                    "  \"key\": {\n" +
+                    "    \"type\": \"TIME_SERIES\",\n" +
+                    "    \"key\": \"temperature\"\n" +
+                    "  },\n" +
+                    "  \"valueType\": \"NUMERIC\",\n" +
+                    "  \"predicate\": {\n" +
+                    "    \"operation\": \"GREATER\",\n" +
+                    "    \"value\": {\n" +
+                    "      \"defaultValue\": 20,\n" +
+                    "      \"dynamicValue\": null\n" +
+                    "    },\n" +
+                    "    \"type\": \"NUMERIC\"\n" +
+                    "  }\n" +
+                    "}" +
+                    MARKDOWN_CODE_BLOCK_END +
+                    "\n\n Now let's review 'key', 'valueType' and 'predicate' objects in detail."
+                    + FILTER_KEY + FILTER_VALUE_TYPE + FILTER_PREDICATE;
+
+    private static final String ENTITY_COUNT_QUERY_DESCRIPTION =
+            "Allows to run complex queries to search the count of platform entities (devices, assets, customers, etc) " +
+                "based on the combination of main entity filter and multiple key filters. Returns the number of entities that match the query definition.\n\n" +
+            "# Query Definition\n\n" +
+                "\n\nMain **entity filter** is mandatory and defines generic search criteria. " +
+                    "For example, \"find all devices with profile 'Moisture Sensor'\" or \"Find all devices related to asset 'Building A'\"" +
+                "\n\nOptional **key filters** allow to filter results of the entity filter by complex criteria against " +
+                        "main entity fields (name, label, type, etc), attributes and telemetry. " +
+                        "For example, \"temperature > 20 or temperature< 10\" or \"name starts with 'T', and attribute 'model' is 'T1000', and timeseries field 'batteryLevel' > 40\"."+
+                "\n\nLet's review the example:" +
+                "\n\n" + MARKDOWN_CODE_BLOCK_START +
+                "{\n" +
+                    "  \"entityFilter\": {\n" +
+                    "    \"type\": \"entityType\",\n" +
+                    "    \"entityType\": \"DEVICE\"\n" +
+                    "  },\n" +
+                    "  \"keyFilters\": [\n" +
+                    "    {\n" +
+                    "      \"key\": {\n" +
+                    "        \"type\": \"ATTRIBUTE\",\n" +
+                    "        \"key\": \"active\"\n" +
+                    "      },\n" +
+                    "      \"valueType\": \"BOOLEAN\",\n" +
+                    "      \"predicate\": {\n" +
+                    "        \"operation\": \"EQUAL\",\n" +
+                    "        \"value\": {\n" +
+                    "          \"defaultValue\": true,\n" +
+                    "          \"dynamicValue\": null\n" +
+                    "        },\n" +
+                    "        \"type\": \"BOOLEAN\"\n" +
+                    "      }\n" +
+                    "    }\n" +
+                    "  ]\n" +
+                    "}"+
+                MARKDOWN_CODE_BLOCK_END +
+                "\n\n Example mentioned above search all devices which have attribute 'active' set to 'true'. Now let's review available entity filters and key filters syntax:" +
+                ENTITY_FILTERS +
+                KEY_FILTERS +
+                    TENANT_OR_USER_AUTHORITY_PARAGRAPH;;
+
+    private static final String ENTITY_DATA_QUERY_DESCRIPTION =
+            "Allows to run complex queries over platform entities (devices, assets, customers, etc) " +
+                    "based on the combination of main entity filter and multiple key filters. " +
+                    "Returns the paginated result of the query that contains requested entity fields and latest values of requested attributes and time-series data.\n\n" +
+                    "# Query Definition\n\n" +
+                    "\n\nMain **entity filter** is mandatory and defines generic search criteria. " +
+                    "For example, \"find all devices with profile 'Moisture Sensor'\" or \"Find all devices related to asset 'Building A'\"" +
+                    "\n\nOptional **key filters** allow to filter results of the **entity filter** by complex criteria against " +
+                    "main entity fields (name, label, type, etc), attributes and telemetry. " +
+                    "For example, \"temperature > 20 or temperature< 10\" or \"name starts with 'T', and attribute 'model' is 'T1000', and timeseries field 'batteryLevel' > 40\"."+
+                    "\n\nThe **entity fields** and **latest values** contains list of entity fields and latest attribute/telemetry fields to fetch for each entity." +
+                    "\n\nThe **page link** contains information about the page to fetch and the sort ordering." +
+                    "\n\nLet's review the example:" +
+                    "\n\n" + MARKDOWN_CODE_BLOCK_START +
+                    "{\n" +
+                    "  \"entityFilter\": {\n" +
+                    "    \"type\": \"entityType\",\n" +
+                    "    \"resolveMultiple\": true,\n" +
+                    "    \"entityType\": \"DEVICE\"\n" +
+                    "  },\n" +
+                    "  \"keyFilters\": [\n" +
+                    "    {\n" +
+                    "      \"key\": {\n" +
+                    "        \"type\": \"TIME_SERIES\",\n" +
+                    "        \"key\": \"temperature\"\n" +
+                    "      },\n" +
+                    "      \"valueType\": \"NUMERIC\",\n" +
+                    "      \"predicate\": {\n" +
+                    "        \"operation\": \"GREATER\",\n" +
+                    "        \"value\": {\n" +
+                    "          \"defaultValue\": 0,\n" +
+                    "          \"dynamicValue\": {\n" +
+                    "            \"sourceType\": \"CURRENT_USER\",\n" +
+                    "            \"sourceAttribute\": \"temperatureThreshold\",\n" +
+                    "            \"inherit\": false\n" +
+                    "          }\n" +
+                    "        },\n" +
+                    "        \"type\": \"NUMERIC\"\n" +
+                    "      }\n" +
+                    "    }\n" +
+                    "  ],\n" +
+                    "  \"entityFields\": [\n" +
+                    "    {\n" +
+                    "      \"type\": \"ENTITY_FIELD\",\n" +
+                    "      \"key\": \"name\"\n" +
+                    "    },\n" +
+                    "    {\n" +
+                    "      \"type\": \"ENTITY_FIELD\",\n" +
+                    "      \"key\": \"label\"\n" +
+                    "    },\n" +
+                    "    {\n" +
+                    "      \"type\": \"ENTITY_FIELD\",\n" +
+                    "      \"key\": \"additionalInfo\"\n" +
+                    "    }\n" +
+                    "  ],\n" +
+                    "  \"latestValues\": [\n" +
+                    "    {\n" +
+                    "      \"type\": \"ATTRIBUTE\",\n" +
+                    "      \"key\": \"model\"\n" +
+                    "    },\n" +
+                    "    {\n" +
+                    "      \"type\": \"TIME_SERIES\",\n" +
+                    "      \"key\": \"temperature\"\n" +
+                    "    }\n" +
+                    "  ],\n" +
+                    "  \"pageLink\": {\n" +
+                    "    \"page\": 0,\n" +
+                    "    \"pageSize\": 10,\n" +
+                    "    \"sortOrder\": {\n" +
+                    "      \"key\": {\n" +
+                    "        \"key\": \"name\",\n" +
+                    "        \"type\": \"ENTITY_FIELD\"\n" +
+                    "      },\n" +
+                    "      \"direction\": \"ASC\"\n" +
+                    "    }\n" +
+                    "  }\n" +
+                    "}"+
+                    MARKDOWN_CODE_BLOCK_END +
+                    "\n\n Example mentioned above search all devices which have attribute 'active' set to 'true'. Now let's review available entity filters and key filters syntax:" +
+                    ENTITY_FILTERS +
+                    KEY_FILTERS +
+                    TENANT_OR_USER_AUTHORITY_PARAGRAPH;
+
+
+    private static final String ALARM_DATA_QUERY_DESCRIPTION = "This method description defines how Alarm Data Query extends the Entity Data Query. " +
+            "See method 'Find Entity Data by Query' first to get the info about 'Entity Data Query'." +
+            "\n\n The platform will first search the entities that match the entity and key filters. Then, the platform will use 'Alarm Page Link' to filter the alarms related to those entities. " +
+            "Finally, platform fetch the properties of alarm that are defined in the **'alarmFields'** and combine them with the other entity, attribute and latest time-series fields to return the result. " +
+            "\n\n See example of the alarm query below. The query will search first 100 active alarms with type 'Temperature Alarm' or 'Fire Alarm' for any device with current temperature > 0. " +
+            "The query will return combination of the entity fields: name of the device, device model and latest temperature reading and alarms fields: createdTime, type, severity and status: " +
+            "\n\n" + MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"entityFilter\": {\n" +
+            "    \"type\": \"entityType\",\n" +
+            "    \"resolveMultiple\": true,\n" +
+            "    \"entityType\": \"DEVICE\"\n" +
+            "  },\n" +
+            "  \"pageLink\": {\n" +
+            "    \"page\": 0,\n" +
+            "    \"pageSize\": 100,\n" +
+            "    \"textSearch\": null,\n" +
+            "    \"searchPropagatedAlarms\": false,\n" +
+            "    \"statusList\": [\n" +
+            "      \"ACTIVE\"\n" +
+            "    ],\n" +
+            "    \"severityList\": [\n" +
+            "      \"CRITICAL\",\n" +
+            "      \"MAJOR\"\n" +
+            "    ],\n" +
+            "    \"typeList\": [\n" +
+            "      \"Temperature Alarm\",\n" +
+            "      \"Fire Alarm\"\n" +
+            "    ],\n" +
+            "    \"sortOrder\": {\n" +
+            "      \"key\": {\n" +
+            "        \"key\": \"createdTime\",\n" +
+            "        \"type\": \"ALARM_FIELD\"\n" +
+            "      },\n" +
+            "      \"direction\": \"DESC\"\n" +
+            "    },\n" +
+            "    \"timeWindow\": 86400000\n" +
+            "  },\n" +
+            "  \"keyFilters\": [\n" +
+            "    {\n" +
+            "      \"key\": {\n" +
+            "        \"type\": \"TIME_SERIES\",\n" +
+            "        \"key\": \"temperature\"\n" +
+            "      },\n" +
+            "      \"valueType\": \"NUMERIC\",\n" +
+            "      \"predicate\": {\n" +
+            "        \"operation\": \"GREATER\",\n" +
+            "        \"value\": {\n" +
+            "          \"defaultValue\": 0,\n" +
+            "          \"dynamicValue\": null\n" +
+            "        },\n" +
+            "        \"type\": \"NUMERIC\"\n" +
+            "      }\n" +
+            "    }\n" +
+            "  ],\n" +
+            "  \"alarmFields\": [\n" +
+            "    {\n" +
+            "      \"type\": \"ALARM_FIELD\",\n" +
+            "      \"key\": \"createdTime\"\n" +
+            "    },\n" +
+            "    {\n" +
+            "      \"type\": \"ALARM_FIELD\",\n" +
+            "      \"key\": \"type\"\n" +
+            "    },\n" +
+            "    {\n" +
+            "      \"type\": \"ALARM_FIELD\",\n" +
+            "      \"key\": \"severity\"\n" +
+            "    },\n" +
+            "    {\n" +
+            "      \"type\": \"ALARM_FIELD\",\n" +
+            "      \"key\": \"status\"\n" +
+            "    }\n" +
+            "  ],\n" +
+            "  \"entityFields\": [\n" +
+            "    {\n" +
+            "      \"type\": \"ENTITY_FIELD\",\n" +
+            "      \"key\": \"name\"\n" +
+            "    }\n" +
+            "  ],\n" +
+            "  \"latestValues\": [\n" +
+            "    {\n" +
+            "      \"type\": \"ATTRIBUTE\",\n" +
+            "      \"key\": \"model\"\n" +
+            "    },\n" +
+            "    {\n" +
+            "      \"type\": \"TIME_SERIES\",\n" +
+            "      \"key\": \"temperature\"\n" +
+            "    }\n" +
+            "  ]\n" +
+            "}"+
+            MARKDOWN_CODE_BLOCK_END +
+            "";
+
     @Autowired
     @Autowired
     private EntityQueryService entityQueryService;
     private EntityQueryService entityQueryService;
 
 
     private static final int MAX_PAGE_SIZE = 100;
     private static final int MAX_PAGE_SIZE = 100;
 
 
+    @ApiOperation(value = "Count Entities by Query", notes = ENTITY_COUNT_QUERY_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/entitiesQuery/count", method = RequestMethod.POST)
     @RequestMapping(value = "/entitiesQuery/count", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public long countEntitiesByQuery(@RequestBody EntityCountQuery query) throws ThingsboardException {
+    public long countEntitiesByQuery(
+            @ApiParam(value = "A JSON value representing the entity count query. See API call notes above for more details.")
+            @RequestBody EntityCountQuery query) throws ThingsboardException {
         checkNotNull(query);
         checkNotNull(query);
         try {
         try {
             return this.entityQueryService.countEntitiesByQuery(getCurrentUser(), query);
             return this.entityQueryService.countEntitiesByQuery(getCurrentUser(), query);
@@ -59,10 +696,13 @@ public class EntityQueryController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find Entity Data by Query", notes = ENTITY_DATA_QUERY_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/entitiesQuery/find", method = RequestMethod.POST)
     @RequestMapping(value = "/entitiesQuery/find", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public PageData<EntityData> findEntityDataByQuery(@RequestBody EntityDataQuery query) throws ThingsboardException {
+    public PageData<EntityData> findEntityDataByQuery(
+            @ApiParam(value = "A JSON value representing the entity data query. See API call notes above for more details.")
+            @RequestBody EntityDataQuery query) throws ThingsboardException {
         checkNotNull(query);
         checkNotNull(query);
         try {
         try {
             return this.entityQueryService.findEntityDataByQuery(getCurrentUser(), query);
             return this.entityQueryService.findEntityDataByQuery(getCurrentUser(), query);
@@ -71,10 +711,13 @@ public class EntityQueryController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find Alarms by Query", notes = ALARM_DATA_QUERY_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/alarmsQuery/find", method = RequestMethod.POST)
     @RequestMapping(value = "/alarmsQuery/find", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public PageData<AlarmData> findAlarmDataByQuery(@RequestBody AlarmDataQuery query) throws ThingsboardException {
+    public PageData<AlarmData> findAlarmDataByQuery(
+            @ApiParam(value = "A JSON value representing the alarm data query. See API call notes above for more details.")
+            @RequestBody AlarmDataQuery query) throws ThingsboardException {
         checkNotNull(query);
         checkNotNull(query);
         try {
         try {
             return this.entityQueryService.findAlarmDataByQuery(getCurrentUser(), query);
             return this.entityQueryService.findAlarmDataByQuery(getCurrentUser(), query);
@@ -83,12 +726,18 @@ public class EntityQueryController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find Entity Keys by Query",
+            notes = "Uses entity data query (see 'Find Entity Data by Query') to find first 100 entities. Then fetch and return all unique time-series and/or attribute keys. Used mostly for UI hints.")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/entitiesQuery/find/keys", method = RequestMethod.POST)
     @RequestMapping(value = "/entitiesQuery/find/keys", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> findEntityTimeseriesAndAttributesKeysByQuery(@RequestBody EntityDataQuery query,
-                                                                                       @RequestParam("timeseries") boolean isTimeseries,
-                                                                                       @RequestParam("attributes") boolean isAttributes) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> findEntityTimeseriesAndAttributesKeysByQuery(
+            @ApiParam(value = "A JSON value representing the entity data query. See API call notes above for more details.")
+            @RequestBody EntityDataQuery query,
+            @ApiParam(value = "Include all unique time-series keys to the result.")
+            @RequestParam("timeseries") boolean isTimeseries,
+            @ApiParam(value = "Include all unique attribute keys to the result.")
+            @RequestParam("attributes") boolean isAttributes) throws ThingsboardException {
         TenantId tenantId = getTenantId();
         TenantId tenantId = getTenantId();
         checkNotNull(query);
         checkNotNull(query);
         try {
         try {

@@ -15,7 +15,10 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -52,10 +55,23 @@ public class EntityRelationController extends BaseController {
     public static final String RELATION_TYPE = "relationType";
     public static final String RELATION_TYPE = "relationType";
     public static final String TO_ID = "toId";
     public static final String TO_ID = "toId";
 
 
+    private static final String SECURITY_CHECKS_ENTITIES_DESCRIPTION = "\n\nIf the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. " +
+            "If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. " +
+            "If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer.";
+
+    private static final String SECURITY_CHECKS_ENTITY_DESCRIPTION = "\n\nIf the user has the authority of 'System Administrator', the server checks that the entity is owned by the sysadmin. " +
+            "If the user has the authority of 'Tenant Administrator', the server checks that the entity is owned by the same tenant. " +
+            "If the user has the authority of 'Customer User', the server checks that the entity is assigned to the same customer.";
+
+    @ApiOperation(value = "Create Relation (saveRelation)",
+            notes = "Creates or updates a relation between two entities in the platform. " +
+                    "Relations unique key is a combination of from/to entity id and relation type group and relation type. " +
+                    SECURITY_CHECKS_ENTITIES_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relation", method = RequestMethod.POST)
     @RequestMapping(value = "/relation", method = RequestMethod.POST)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void saveRelation(@RequestBody EntityRelation relation) throws ThingsboardException {
+    public void saveRelation(@ApiParam(value = "A JSON value representing the relation.", required = true)
+                             @RequestBody EntityRelation relation) throws ThingsboardException {
         try {
         try {
             checkNotNull(relation);
             checkNotNull(relation);
             checkEntityId(relation.getFrom(), Operation.WRITE);
             checkEntityId(relation.getFrom(), Operation.WRITE);
@@ -80,14 +96,17 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete Relation (deleteRelation)",
+            notes = "Deletes a relation between two entities in the platform. " + SECURITY_CHECKS_ENTITIES_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relation", method = RequestMethod.DELETE, params = {FROM_ID, FROM_TYPE, RELATION_TYPE, TO_ID, TO_TYPE})
     @RequestMapping(value = "/relation", method = RequestMethod.DELETE, params = {FROM_ID, FROM_TYPE, RELATION_TYPE, TO_ID, TO_TYPE})
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteRelation(@RequestParam(FROM_ID) String strFromId,
-                               @RequestParam(FROM_TYPE) String strFromType,
-                               @RequestParam(RELATION_TYPE) String strRelationType,
-                               @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup,
-                               @RequestParam(TO_ID) String strToId, @RequestParam(TO_TYPE) String strToType) throws ThingsboardException {
+    public void deleteRelation(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_ID) String strFromId,
+                               @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_TYPE) String strFromType,
+                               @ApiParam(value = RELATION_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(RELATION_TYPE) String strRelationType,
+                               @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION) @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup,
+                               @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(TO_ID) String strToId,
+                               @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(TO_TYPE) String strToType) throws ThingsboardException {
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_TYPE, strFromType);
         checkParameter(FROM_TYPE, strFromType);
         checkParameter(RELATION_TYPE, strRelationType);
         checkParameter(RELATION_TYPE, strRelationType);
@@ -119,11 +138,14 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete Relations (deleteRelations)",
+            notes = "Deletes all the relation (both 'from' and 'to' direction) for the specified entity. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN','TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN','TENANT_ADMIN', 'CUSTOMER_USER')")
-    @RequestMapping(value = "/relations", method = RequestMethod.DELETE, params = {"id", "type"})
+    @RequestMapping(value = "/relations", method = RequestMethod.DELETE, params = {"entityId", "entityType"})
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteRelations(@RequestParam("entityId") String strId,
-                                @RequestParam("entityType") String strType) throws ThingsboardException {
+    public void deleteRelations(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam("entityId") String strId,
+                                @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam("entityType") String strType) throws ThingsboardException {
         checkParameter("entityId", strId);
         checkParameter("entityId", strId);
         checkParameter("entityType", strType);
         checkParameter("entityType", strType);
         EntityId entityId = EntityIdFactory.getByTypeAndId(strType, strId);
         EntityId entityId = EntityIdFactory.getByTypeAndId(strType, strId);
@@ -137,14 +159,18 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Relation (getRelation)",
+            notes = "Returns relation object between two specified entities if present. Otherwise throws exception. " + SECURITY_CHECKS_ENTITIES_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relation", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE, RELATION_TYPE, TO_ID, TO_TYPE})
     @RequestMapping(value = "/relation", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE, RELATION_TYPE, TO_ID, TO_TYPE})
     @ResponseBody
     @ResponseBody
-    public EntityRelation getRelation(@RequestParam(FROM_ID) String strFromId,
-                                      @RequestParam(FROM_TYPE) String strFromType,
-                                      @RequestParam(RELATION_TYPE) String strRelationType,
-                                      @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup,
-                                      @RequestParam(TO_ID) String strToId, @RequestParam(TO_TYPE) String strToType) throws ThingsboardException {
+    public EntityRelation getRelation(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_ID) String strFromId,
+                                      @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_TYPE) String strFromType,
+                                      @ApiParam(value = RELATION_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(RELATION_TYPE) String strRelationType,
+                                      @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION) @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup,
+                                      @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(TO_ID) String strToId,
+                                      @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(TO_TYPE) String strToType) throws ThingsboardException {
         try {
         try {
             checkParameter(FROM_ID, strFromId);
             checkParameter(FROM_ID, strFromId);
             checkParameter(FROM_TYPE, strFromType);
             checkParameter(FROM_TYPE, strFromType);
@@ -162,11 +188,16 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get List of Relations (findByFrom)",
+            notes = "Returns list of relation objects for the specified entity by the 'from' direction. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE})
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE})
     @ResponseBody
     @ResponseBody
-    public List<EntityRelation> findByFrom(@RequestParam(FROM_ID) String strFromId,
-                                           @RequestParam(FROM_TYPE) String strFromType,
+    public List<EntityRelation> findByFrom(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_ID) String strFromId,
+                                           @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_TYPE) String strFromType,
+                                           @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION)
                                            @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
                                            @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_TYPE, strFromType);
         checkParameter(FROM_TYPE, strFromType);
@@ -180,11 +211,16 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get List of Relation Infos (findInfoByFrom)",
+            notes = "Returns list of relation info objects for the specified entity by the 'from' direction. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION + " " + RELATION_INFO_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations/info", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE})
     @RequestMapping(value = "/relations/info", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE})
     @ResponseBody
     @ResponseBody
-    public List<EntityRelationInfo> findInfoByFrom(@RequestParam(FROM_ID) String strFromId,
-                                                   @RequestParam(FROM_TYPE) String strFromType,
+    public List<EntityRelationInfo> findInfoByFrom(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_ID) String strFromId,
+                                                   @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_TYPE) String strFromType,
+                                                   @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION)
                                                    @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
                                                    @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_TYPE, strFromType);
         checkParameter(FROM_TYPE, strFromType);
@@ -198,12 +234,17 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get List of Relations (findByFrom)",
+            notes = "Returns list of relation objects for the specified entity by the 'from' direction and relation type. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE, RELATION_TYPE})
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {FROM_ID, FROM_TYPE, RELATION_TYPE})
     @ResponseBody
     @ResponseBody
-    public List<EntityRelation> findByFrom(@RequestParam(FROM_ID) String strFromId,
-                                           @RequestParam(FROM_TYPE) String strFromType,
-                                           @RequestParam(RELATION_TYPE) String strRelationType,
+    public List<EntityRelation> findByFrom(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_ID) String strFromId,
+                                           @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(FROM_TYPE) String strFromType,
+                                           @ApiParam(value = RELATION_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(RELATION_TYPE) String strRelationType,
+                                           @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION)
                                            @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
                                            @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_ID, strFromId);
         checkParameter(FROM_TYPE, strFromType);
         checkParameter(FROM_TYPE, strFromType);
@@ -218,11 +259,16 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get List of Relations (findByTo)",
+            notes = "Returns list of relation objects for the specified entity by the 'to' direction. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {TO_ID, TO_TYPE})
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {TO_ID, TO_TYPE})
     @ResponseBody
     @ResponseBody
-    public List<EntityRelation> findByTo(@RequestParam(TO_ID) String strToId,
-                                         @RequestParam(TO_TYPE) String strToType,
+    public List<EntityRelation> findByTo(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(TO_ID) String strToId,
+                                         @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(TO_TYPE) String strToType,
+                                         @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION)
                                          @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
                                          @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
         checkParameter(TO_ID, strToId);
         checkParameter(TO_ID, strToId);
         checkParameter(TO_TYPE, strToType);
         checkParameter(TO_TYPE, strToType);
@@ -236,11 +282,16 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get List of Relation Infos (findInfoByTo)",
+            notes = "Returns list of relation info objects for the specified entity by the 'to' direction. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION + " " + RELATION_INFO_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations/info", method = RequestMethod.GET, params = {TO_ID, TO_TYPE})
     @RequestMapping(value = "/relations/info", method = RequestMethod.GET, params = {TO_ID, TO_TYPE})
     @ResponseBody
     @ResponseBody
-    public List<EntityRelationInfo> findInfoByTo(@RequestParam(TO_ID) String strToId,
-                                                 @RequestParam(TO_TYPE) String strToType,
+    public List<EntityRelationInfo> findInfoByTo(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(TO_ID) String strToId,
+                                                 @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(TO_TYPE) String strToType,
+                                                 @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION)
                                                  @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
                                                  @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
         checkParameter(TO_ID, strToId);
         checkParameter(TO_ID, strToId);
         checkParameter(TO_TYPE, strToType);
         checkParameter(TO_TYPE, strToType);
@@ -254,12 +305,17 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get List of Relations (findByTo)",
+            notes = "Returns list of relation objects for the specified entity by the 'to' direction and relation type. " +
+                    SECURITY_CHECKS_ENTITY_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {TO_ID, TO_TYPE, RELATION_TYPE})
     @RequestMapping(value = "/relations", method = RequestMethod.GET, params = {TO_ID, TO_TYPE, RELATION_TYPE})
     @ResponseBody
     @ResponseBody
-    public List<EntityRelation> findByTo(@RequestParam(TO_ID) String strToId,
-                                         @RequestParam(TO_TYPE) String strToType,
-                                         @RequestParam(RELATION_TYPE) String strRelationType,
+    public List<EntityRelation> findByTo(@ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true) @RequestParam(TO_ID) String strToId,
+                                         @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(TO_TYPE) String strToType,
+                                         @ApiParam(value = RELATION_TYPE_PARAM_DESCRIPTION, required = true) @RequestParam(RELATION_TYPE) String strRelationType,
+                                         @ApiParam(value = RELATION_TYPE_GROUP_PARAM_DESCRIPTION)
                                          @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
                                          @RequestParam(value = "relationTypeGroup", required = false) String strRelationTypeGroup) throws ThingsboardException {
         checkParameter(TO_ID, strToId);
         checkParameter(TO_ID, strToId);
         checkParameter(TO_TYPE, strToType);
         checkParameter(TO_TYPE, strToType);
@@ -274,10 +330,15 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find related entities (findByQuery)",
+            notes = "Returns all entities that are related to the specific entity. " +
+                    "The entity id, relation type, entity types, depth of the search, and other query parameters defined using complex 'EntityRelationsQuery' object. " +
+                    "See 'Model' tab of the Parameters for more info.", produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations", method = RequestMethod.POST)
     @RequestMapping(value = "/relations", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public List<EntityRelation> findByQuery(@RequestBody EntityRelationsQuery query) throws ThingsboardException {
+    public List<EntityRelation> findByQuery(@ApiParam(value = "A JSON value representing the entity relations query object.", required = true)
+                                            @RequestBody EntityRelationsQuery query) throws ThingsboardException {
         checkNotNull(query);
         checkNotNull(query);
         checkNotNull(query.getParameters());
         checkNotNull(query.getParameters());
         checkNotNull(query.getFilters());
         checkNotNull(query.getFilters());
@@ -289,10 +350,15 @@ public class EntityRelationController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Find related entity infos (findInfoByQuery)",
+            notes = "Returns all entity infos that are related to the specific entity. " +
+                    "The entity id, relation type, entity types, depth of the search, and other query parameters defined using complex 'EntityRelationsQuery' object. " +
+                    "See 'Model' tab of the Parameters for more info. " + RELATION_INFO_DESCRIPTION, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/relations/info", method = RequestMethod.POST)
     @RequestMapping(value = "/relations/info", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public List<EntityRelationInfo> findInfoByQuery(@RequestBody EntityRelationsQuery query) throws ThingsboardException {
+    public List<EntityRelationInfo> findInfoByQuery(@ApiParam(value = "A JSON value representing the entity relations query object.", required = true)
+                                                    @RequestBody EntityRelationsQuery query) throws ThingsboardException {
         checkNotNull(query);
         checkNotNull(query);
         checkNotNull(query.getParameters());
         checkNotNull(query.getParameters());
         checkNotNull(query.getFilters());
         checkNotNull(query.getFilters());

@@ -20,9 +20,11 @@ import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
 import com.google.common.util.concurrent.MoreExecutors;
 import com.google.common.util.concurrent.SettableFuture;
 import com.google.common.util.concurrent.SettableFuture;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -611,6 +613,13 @@ public class EntityViewController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Assign entity view to edge (assignEntityViewToEdge)",
+            notes = "Creates assignment of an existing entity view to an instance of The Edge. " +
+                    EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive a copy of assignment entity view " +
+                    EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once entity view will be delivered to edge service, it's going to be available for usage on remote edge instance.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/entityView/{entityViewId}", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/{edgeId}/entityView/{entityViewId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -641,6 +650,13 @@ public class EntityViewController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Unassign entity view from edge (unassignEntityViewFromEdge)",
+            notes = "Clears assignment of the entity view to the edge. " +
+                    EDGE_UNASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive an 'unassign' command to remove entity view " +
+                    EDGE_UNASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once 'unassign' command will be delivered to edge service, it's going to remove entity view locally.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/entityView/{entityViewId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/edge/{edgeId}/entityView/{entityViewId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody

@@ -15,7 +15,10 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -25,7 +28,7 @@ import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.bind.annotation.RestController;
 import org.thingsboard.server.common.data.Event;
 import org.thingsboard.server.common.data.Event;
-import org.thingsboard.server.common.data.event.EventFilter;
+import org.thingsboard.server.common.data.event.BaseEventFilter;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityIdFactory;
 import org.thingsboard.server.common.data.id.EntityIdFactory;
@@ -42,23 +45,39 @@ import org.thingsboard.server.service.security.permission.Operation;
 @RequestMapping("/api")
 @RequestMapping("/api")
 public class EventController extends BaseController {
 public class EventController extends BaseController {
 
 
+    private static final String NEW_LINE = "\n\n";
+
     @Autowired
     @Autowired
     private EventService eventService;
     private EventService eventService;
 
 
+    @ApiOperation(value = "Get Events by type (getEvents)",
+            notes = "Returns a page of events for specified entity by specifying event type. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/events/{entityType}/{entityId}/{eventType}", method = RequestMethod.GET)
     @RequestMapping(value = "/events/{entityType}/{entityId}/{eventType}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<Event> getEvents(
     public PageData<Event> getEvents(
-            @PathVariable("entityType") String strEntityType,
-            @PathVariable("entityId") String strEntityId,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_TYPE) String strEntityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_ID) String strEntityId,
+            @ApiParam(value = "A string value representing event type", example = "STATS", required = true)
             @PathVariable("eventType") String eventType,
             @PathVariable("eventType") String eventType,
-            @RequestParam("tenantId") String strTenantId,
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION, required = true)
+            @RequestParam(TENANT_ID) String strTenantId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = EVENT_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EVENT_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = EVENT_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = EVENT_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityType", strEntityType);
         checkParameter("EntityType", strEntityType);
@@ -74,19 +93,32 @@ public class EventController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Events (getEvents)",
+            notes = "Returns a page of events for specified entity. " +
+                    PAGE_DATA_PARAMETERS, produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/events/{entityType}/{entityId}", method = RequestMethod.GET)
     @RequestMapping(value = "/events/{entityType}/{entityId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<Event> getEvents(
     public PageData<Event> getEvents(
-            @PathVariable("entityType") String strEntityType,
-            @PathVariable("entityId") String strEntityId,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_TYPE) String strEntityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_ID) String strEntityId,
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION, required = true)
             @RequestParam("tenantId") String strTenantId,
             @RequestParam("tenantId") String strTenantId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = EVENT_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EVENT_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = EVENT_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = EVENT_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityType", strEntityType);
         checkParameter("EntityType", strEntityType);
@@ -104,20 +136,42 @@ public class EventController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Events by event filter (getEvents)",
+            notes = "Returns a page of events for the chosen entity by specifying the event filter. " +
+                    PAGE_DATA_PARAMETERS + NEW_LINE + "5 different eventFilter objects could be set for different event types. " +
+                    "The eventType field is required. Others are optional. If some of them are set, the filtering will be applied according to them. " +
+                    "See the examples below for all the fields used for each event type filtering. " + NEW_LINE +
+                    EVENT_ERROR_FILTER_OBJ + NEW_LINE +
+                    EVENT_LC_EVENT_FILTER_OBJ + NEW_LINE +
+                    EVENT_STATS_FILTER_OBJ + NEW_LINE +
+                    EVENT_DEBUG_RULE_NODE_FILTER_OBJ + NEW_LINE +
+                    EVENT_DEBUG_RULE_CHAIN_FILTER_OBJ + NEW_LINE,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/events/{entityType}/{entityId}", method = RequestMethod.POST)
     @RequestMapping(value = "/events/{entityType}/{entityId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
     public PageData<Event> getEvents(
     public PageData<Event> getEvents(
-            @PathVariable("entityType") String strEntityType,
-            @PathVariable("entityId") String strEntityId,
-            @RequestParam("tenantId") String strTenantId,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_TYPE) String strEntityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(ENTITY_ID) String strEntityId,
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION, required = true)
+            @RequestParam(TENANT_ID) String strTenantId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
-            @RequestBody EventFilter eventFilter,
+            @ApiParam(value = "A JSON value representing the event filter.", required = true)
+            @RequestBody BaseEventFilter eventFilter,
+            @ApiParam(value = EVENT_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = EVENT_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder,
             @RequestParam(required = false) String sortOrder,
+            @ApiParam(value = EVENT_START_TIME_DESCRIPTION)
             @RequestParam(required = false) Long startTime,
             @RequestParam(required = false) Long startTime,
+            @ApiParam(value = EVENT_END_TIME_DESCRIPTION)
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
             @RequestParam(required = false) Long endTime) throws ThingsboardException {
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityId", strEntityId);
         checkParameter("EntityType", strEntityType);
         checkParameter("EntityType", strEntityType);
@@ -127,7 +181,7 @@ public class EventController extends BaseController {
             EntityId entityId = EntityIdFactory.getByTypeAndId(strEntityType, strEntityId);
             EntityId entityId = EntityIdFactory.getByTypeAndId(strEntityType, strEntityId);
             checkEntityId(entityId, Operation.READ);
             checkEntityId(entityId, Operation.READ);
 
 
-            if(sortProperty != null && sortProperty.equals("createdTime") && eventFilter.hasFilterForJsonBody()) {
+            if (sortProperty != null && sortProperty.equals("createdTime") && eventFilter.hasFilterForJsonBody()) {
                 sortProperty = ModelConstants.CREATED_TIME_PROPERTY;
                 sortProperty = ModelConstants.CREATED_TIME_PROPERTY;
             }
             }
 
 

@@ -15,12 +15,18 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
-import org.springframework.web.bind.annotation.*;
-import org.thingsboard.server.common.data.EntityType;
-import org.thingsboard.server.common.data.audit.ActionType;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestController;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
 import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationTemplateId;
 import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationTemplateId;
 import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistrationTemplate;
 import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistrationTemplate;
@@ -37,6 +43,10 @@ import java.util.List;
 public class OAuth2ConfigTemplateController extends BaseController {
 public class OAuth2ConfigTemplateController extends BaseController {
     private static final String CLIENT_REGISTRATION_TEMPLATE_ID = "clientRegistrationTemplateId";
     private static final String CLIENT_REGISTRATION_TEMPLATE_ID = "clientRegistrationTemplateId";
 
 
+    private static final String OAUTH2_CLIENT_REGISTRATION_TEMPLATE_DEFINITION = "Client registration template is OAuth2 provider configuration template with default settings for registering new OAuth2 clients";
+
+    @ApiOperation(value = "Create or update OAuth2 client registration template (saveClientRegistrationTemplate)",
+            notes = OAUTH2_CLIENT_REGISTRATION_TEMPLATE_DEFINITION)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(method = RequestMethod.POST)
     @RequestMapping(method = RequestMethod.POST)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
@@ -49,10 +59,13 @@ public class OAuth2ConfigTemplateController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete OAuth2 client registration template by id (deleteClientRegistrationTemplate)",
+            notes = OAUTH2_CLIENT_REGISTRATION_TEMPLATE_DEFINITION)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/{clientRegistrationTemplateId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/{clientRegistrationTemplateId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteClientRegistrationTemplate(@PathVariable(CLIENT_REGISTRATION_TEMPLATE_ID) String strClientRegistrationTemplateId) throws ThingsboardException {
+    public void deleteClientRegistrationTemplate(@ApiParam(value = "String representation of client registration template id to delete", example = "139b1f81-2f5d-11ec-9dbe-9b627e1a88f4")
+                                                 @PathVariable(CLIENT_REGISTRATION_TEMPLATE_ID) String strClientRegistrationTemplateId) throws ThingsboardException {
         checkParameter(CLIENT_REGISTRATION_TEMPLATE_ID, strClientRegistrationTemplateId);
         checkParameter(CLIENT_REGISTRATION_TEMPLATE_ID, strClientRegistrationTemplateId);
         try {
         try {
             accessControlService.checkPermission(getCurrentUser(), Resource.OAUTH2_CONFIGURATION_TEMPLATE, Operation.DELETE);
             accessControlService.checkPermission(getCurrentUser(), Resource.OAUTH2_CONFIGURATION_TEMPLATE, Operation.DELETE);
@@ -63,6 +76,8 @@ public class OAuth2ConfigTemplateController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get the list of all OAuth2 client registration templates (getClientRegistrationTemplates)",
+            notes = OAUTH2_CLIENT_REGISTRATION_TEMPLATE_DEFINITION)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(method = RequestMethod.GET, produces = "application/json")
     @RequestMapping(method = RequestMethod.GET, produces = "application/json")
     @ResponseBody
     @ResponseBody
@@ -74,4 +89,5 @@ public class OAuth2ConfigTemplateController extends BaseController {
             throw handleException(e);
             throw handleException(e);
         }
         }
     }
     }
+
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
@@ -50,10 +52,20 @@ public class OAuth2Controller extends BaseController {
     @Autowired
     @Autowired
     private OAuth2Configuration oAuth2Configuration;
     private OAuth2Configuration oAuth2Configuration;
 
 
+
+    @ApiOperation(value = "Get OAuth2 clients (getOAuth2Clients)", notes = "Get the list of OAuth2 clients " +
+            "to log in with, available for such domain scheme (HTTP or HTTPS) (if x-forwarded-proto request header is present - " +
+            "the scheme is known from it) and domain name and port (port may be known from x-forwarded-port header)")
     @RequestMapping(value = "/noauth/oauth2Clients", method = RequestMethod.POST)
     @RequestMapping(value = "/noauth/oauth2Clients", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
     public List<OAuth2ClientInfo> getOAuth2Clients(HttpServletRequest request,
     public List<OAuth2ClientInfo> getOAuth2Clients(HttpServletRequest request,
+                                                   @ApiParam(value = "Mobile application package name, to find OAuth2 clients " +
+                                                           "where there is configured mobile application with such package name")
                                                    @RequestParam(required = false) String pkgName,
                                                    @RequestParam(required = false) String pkgName,
+                                                   @ApiParam(value = "Platform type to search OAuth2 clients for which " +
+                                                           "the usage with this platform type is allowed in the settings. " +
+                                                           "If platform type is not one of allowable values - it will just be ignored",
+                                                           allowableValues = "WEB, ANDROID, IOS")
                                                    @RequestParam(required = false) String platform) throws ThingsboardException {
                                                    @RequestParam(required = false) String platform) throws ThingsboardException {
         try {
         try {
             if (log.isDebugEnabled()) {
             if (log.isDebugEnabled()) {
@@ -76,6 +88,7 @@ public class OAuth2Controller extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get current OAuth2 settings (getCurrentOAuth2Info)")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/oauth2/config", method = RequestMethod.GET, produces = "application/json")
     @RequestMapping(value = "/oauth2/config", method = RequestMethod.GET, produces = "application/json")
     @ResponseBody
     @ResponseBody
@@ -88,6 +101,7 @@ public class OAuth2Controller extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Save OAuth2 settings (saveOAuth2Info)")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/oauth2/config", method = RequestMethod.POST)
     @RequestMapping(value = "/oauth2/config", method = RequestMethod.POST)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
@@ -101,6 +115,10 @@ public class OAuth2Controller extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get OAuth2 log in processing URL (getLoginProcessingUrl)", notes = "Returns the URL enclosed in " +
+            "double quotes. After successful authentication with OAuth2 provider, it makes a redirect to this path so that the platform can do " +
+            "further log in processing. This URL may be configured as 'security.oauth2.loginProcessingUrl' property in yml configuration file, or " +
+            "as 'SECURITY_OAUTH2_LOGIN_PROCESSING_URL' env variable. By default it is '/login/oauth2/code/'")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/oauth2/loginProcessingUrl", method = RequestMethod.GET)
     @RequestMapping(value = "/oauth2/loginProcessingUrl", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -112,4 +130,5 @@ public class OAuth2Controller extends BaseController {
             throw handleException(e);
             throw handleException(e);
         }
         }
     }
     }
+
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.ResponseEntity;
@@ -38,17 +40,27 @@ import java.util.UUID;
 @Slf4j
 @Slf4j
 public class RpcV1Controller extends AbstractRpcController {
 public class RpcV1Controller extends AbstractRpcController {
 
 
+    @ApiOperation(value = "Send one-way RPC request (handleOneWayDeviceRPCRequest)", notes = "Deprecated. See 'Rpc V 2 Controller' instead.")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/oneway/{deviceId}", method = RequestMethod.POST)
     @RequestMapping(value = "/oneway/{deviceId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> handleOneWayDeviceRPCRequest(@PathVariable("deviceId") String deviceIdStr, @RequestBody String requestBody) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> handleOneWayDeviceRPCRequest(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION)
+            @PathVariable("deviceId") String deviceIdStr,
+            @ApiParam(value = "A JSON value representing the RPC request.")
+            @RequestBody String requestBody) throws ThingsboardException {
         return handleDeviceRPCRequest(true, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.REQUEST_TIMEOUT, HttpStatus.CONFLICT);
         return handleDeviceRPCRequest(true, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.REQUEST_TIMEOUT, HttpStatus.CONFLICT);
     }
     }
 
 
+    @ApiOperation(value = "Send two-way RPC request (handleTwoWayDeviceRPCRequest)", notes = "Deprecated. See 'Rpc V 2 Controller' instead.")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/twoway/{deviceId}", method = RequestMethod.POST)
     @RequestMapping(value = "/twoway/{deviceId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> handleTwoWayDeviceRPCRequest(@PathVariable("deviceId") String deviceIdStr, @RequestBody String requestBody) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> handleTwoWayDeviceRPCRequest(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION)
+            @PathVariable("deviceId") String deviceIdStr,
+            @ApiParam(value = "A JSON value representing the RPC request.")
+            @RequestBody String requestBody) throws ThingsboardException {
         return handleDeviceRPCRequest(false, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.REQUEST_TIMEOUT, HttpStatus.CONFLICT);
         return handleDeviceRPCRequest(false, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.REQUEST_TIMEOUT, HttpStatus.CONFLICT);
     }
     }
 
 

@@ -15,6 +15,10 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.ResponseEntity;
@@ -52,24 +56,88 @@ import static org.thingsboard.server.common.data.DataConstants.RPC_DELETED;
 @Slf4j
 @Slf4j
 public class RpcV2Controller extends AbstractRpcController {
 public class RpcV2Controller extends AbstractRpcController {
 
 
+    private static final String RPC_REQUEST_DESCRIPTION = "Sends the one-way remote-procedure call (RPC) request to device. " +
+            "The RPC call is A JSON that contains the method name ('method'), parameters ('params') and multiple optional fields. " +
+            "See example below. We will review the properties of the RPC call one-by-one below. " +
+            "\n\n" + MARKDOWN_CODE_BLOCK_START +
+            "{\n" +
+            "  \"method\": \"setGpio\",\n" +
+            "  \"params\": {\n" +
+            "    \"pin\": 7,\n" +
+            "    \"value\": 1\n" +
+            "  },\n" +
+            "  \"persistent\": false,\n" +
+            "  \"timeout\": 5000\n" +
+            "}" +
+            MARKDOWN_CODE_BLOCK_END +
+            "\n\n### Server-side RPC structure\n" +
+            "\n" +
+            "The body of server-side RPC request consists of multiple fields:\n" +
+            "\n" +
+            "* **method** - mandatory, name of the method to distinct the RPC calls.\n" +
+            "  For example, \"getCurrentTime\" or \"getWeatherForecast\". The value of the parameter is a string.\n" +
+            "* **params** - mandatory, parameters used for processing of the request. The value is a JSON. Leave empty JSON \"{}\" if no parameters needed.\n" +
+            "* **timeout** - optional, value of the processing timeout in milliseconds. The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds).\n" +
+            "* **expirationTime** - optional, value of the epoch time (in milliseconds, UTC timezone). Overrides **timeout** if present.\n" +
+            "* **persistent** - optional, indicates persistent RPC. The default value is \"false\".\n" +
+            "* **retries** - optional, defines how many times persistent RPC will be re-sent in case of failures on the network and/or device side.\n" +
+            "* **additionalInfo** - optional, defines metadata for the persistent RPC that will be added to the persistent RPC events.";
+
+    private static final String ONE_WAY_RPC_RESULT = "\n\n### RPC Result\n" +
+            "In case of persistent RPC, the result of this call is 'rpcId' UUID. In case of lightweight RPC, " +
+            "the result of this call is either 200 OK if the message was sent to device, or 504 Gateway Timeout if device is offline.";
+
+    private static final String TWO_WAY_RPC_RESULT = "\n\n### RPC Result\n" +
+            "In case of persistent RPC, the result of this call is 'rpcId' UUID. In case of lightweight RPC, " +
+            "the result of this call is the response from device, or 504 Gateway Timeout if device is offline.";
+
+    private static final String ONE_WAY_RPC_REQUEST_DESCRIPTION = "Sends the one-way remote-procedure call (RPC) request to device. " + RPC_REQUEST_DESCRIPTION + ONE_WAY_RPC_RESULT + TENANT_OR_USER_AUTHORITY_PARAGRAPH;
+
+    private static final String TWO_WAY_RPC_REQUEST_DESCRIPTION = "Sends the two-way remote-procedure call (RPC) request to device. " + RPC_REQUEST_DESCRIPTION + TWO_WAY_RPC_RESULT + TENANT_OR_USER_AUTHORITY_PARAGRAPH;
+
+    @ApiOperation(value = "Send one-way RPC request", notes = ONE_WAY_RPC_REQUEST_DESCRIPTION)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = "Persistent RPC request was saved to the database or lightweight RPC request was sent to the device."),
+            @ApiResponse(code = 400, message = "Invalid structure of the request."),
+            @ApiResponse(code = 401, message = "User is not authorized to send the RPC request. Most likely, User belongs to different Customer or Tenant."),
+            @ApiResponse(code = 504, message = "Timeout to process the RPC call. Most likely, device is offline."),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/oneway/{deviceId}", method = RequestMethod.POST)
     @RequestMapping(value = "/oneway/{deviceId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> handleOneWayDeviceRPCRequest(@PathVariable("deviceId") String deviceIdStr, @RequestBody String requestBody) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> handleOneWayDeviceRPCRequest(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION)
+            @PathVariable("deviceId") String deviceIdStr,
+            @ApiParam(value = "A JSON value representing the RPC request.")
+            @RequestBody String requestBody) throws ThingsboardException {
         return handleDeviceRPCRequest(true, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.GATEWAY_TIMEOUT, HttpStatus.GATEWAY_TIMEOUT);
         return handleDeviceRPCRequest(true, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.GATEWAY_TIMEOUT, HttpStatus.GATEWAY_TIMEOUT);
     }
     }
 
 
+    @ApiOperation(value = "Send two-way RPC request", notes = TWO_WAY_RPC_REQUEST_DESCRIPTION)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = "Persistent RPC request was saved to the database or lightweight RPC response received."),
+            @ApiResponse(code = 400, message = "Invalid structure of the request."),
+            @ApiResponse(code = 401, message = "User is not authorized to send the RPC request. Most likely, User belongs to different Customer or Tenant."),
+            @ApiResponse(code = 504, message = "Timeout to process the RPC call. Most likely, device is offline."),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/twoway/{deviceId}", method = RequestMethod.POST)
     @RequestMapping(value = "/twoway/{deviceId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> handleTwoWayDeviceRPCRequest(@PathVariable("deviceId") String deviceIdStr, @RequestBody String requestBody) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> handleTwoWayDeviceRPCRequest(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION)
+            @PathVariable(DEVICE_ID) String deviceIdStr,
+            @ApiParam(value = "A JSON value representing the RPC request.")
+            @RequestBody String requestBody) throws ThingsboardException {
         return handleDeviceRPCRequest(false, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.GATEWAY_TIMEOUT, HttpStatus.GATEWAY_TIMEOUT);
         return handleDeviceRPCRequest(false, new DeviceId(UUID.fromString(deviceIdStr)), requestBody, HttpStatus.GATEWAY_TIMEOUT, HttpStatus.GATEWAY_TIMEOUT);
     }
     }
 
 
+    @ApiOperation(value = "Get persistent RPC request", notes = "Get information about the status of the RPC call." + TENANT_OR_USER_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/persistent/{rpcId}", method = RequestMethod.GET)
     @RequestMapping(value = "/persistent/{rpcId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public Rpc getPersistedRpc(@PathVariable("rpcId") String strRpc) throws ThingsboardException {
+    public Rpc getPersistedRpc(
+            @ApiParam(value = RPC_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(RPC_ID) String strRpc) throws ThingsboardException {
         checkParameter("RpcId", strRpc);
         checkParameter("RpcId", strRpc);
         try {
         try {
             RpcId rpcId = new RpcId(UUID.fromString(strRpc));
             RpcId rpcId = new RpcId(UUID.fromString(strRpc));
@@ -79,16 +147,25 @@ public class RpcV2Controller extends AbstractRpcController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get persistent RPC requests", notes = "Allows to query RPC calls for specific device using pagination." + TENANT_OR_USER_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/persistent/device/{deviceId}", method = RequestMethod.GET)
     @RequestMapping(value = "/persistent/device/{deviceId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<Rpc> getPersistedRpcByDevice(@PathVariable("deviceId") String strDeviceId,
-                                                 @RequestParam int pageSize,
-                                                 @RequestParam int page,
-                                                 @RequestParam RpcStatus rpcStatus,
-                                                 @RequestParam(required = false) String textSearch,
-                                                 @RequestParam(required = false) String sortProperty,
-                                                 @RequestParam(required = false) String sortOrder) throws ThingsboardException {
+    public PageData<Rpc> getPersistedRpcByDevice(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(DEVICE_ID) String strDeviceId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = "Status of the RPC", required = true, allowableValues = RPC_STATUS_ALLOWABLE_VALUES)
+            @RequestParam RpcStatus rpcStatus,
+            @ApiParam(value = RPC_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = RPC_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         checkParameter("DeviceId", strDeviceId);
         checkParameter("DeviceId", strDeviceId);
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
@@ -100,10 +177,13 @@ public class RpcV2Controller extends AbstractRpcController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete persistent RPC", notes = "Deletes the persistent RPC request." + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/persistent/{rpcId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/persistent/{rpcId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody
-    public void deleteResource(@PathVariable("rpcId") String strRpc) throws ThingsboardException {
+    public void deleteResource(
+            @ApiParam(value = RPC_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(RPC_ID) String strRpc) throws ThingsboardException {
         checkParameter("RpcId", strRpc);
         checkParameter("RpcId", strRpc);
         try {
         try {
             RpcId rpcId = new RpcId(UUID.fromString(strRpc));
             RpcId rpcId = new RpcId(UUID.fromString(strRpc));

@@ -20,10 +20,13 @@ import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.util.StringUtils;
 import org.springframework.util.StringUtils;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -92,6 +95,25 @@ public class RuleChainController extends BaseController {
     private static final ObjectMapper objectMapper = new ObjectMapper();
     private static final ObjectMapper objectMapper = new ObjectMapper();
     public static final int TIMEOUT = 20;
     public static final int TIMEOUT = 20;
 
 
+    private static final String RULE_CHAIN_DESCRIPTION = "The rule chain object is lightweight and contains general information about the rule chain. " +
+            "List of rule nodes and their connection is stored in a separate 'metadata' object.";
+    private static final String RULE_CHAIN_METADATA_DESCRIPTION = "The metadata object contains information about the rule nodes and their connections.";
+    private static final String TEST_JS_FUNCTION = "Execute the JavaScript function and return the result. The format of request: \n\n"
+            + MARKDOWN_CODE_BLOCK_START
+            + "{\n" +
+            "  \"script\": \"Your JS Function as String\",\n" +
+            "  \"scriptType\": \"One of: update, generate, filter, switch, json, string\",\n" +
+            "  \"argNames\": [\"msg\", \"metadata\", \"type\"],\n" +
+            "  \"msg\": \"{\\\"temperature\\\": 42}\", \n" +
+            "  \"metadata\": {\n" +
+            "    \"deviceName\": \"Device A\",\n" +
+            "    \"deviceType\": \"Thermometer\"\n" +
+            "  },\n" +
+            "  \"msgType\": \"POST_TELEMETRY_REQUEST\"\n" +
+            "}"
+            + MARKDOWN_CODE_BLOCK_END
+            + "\n\n Expected result JSON contains \"output\" and \"error\".";
+
     @Autowired
     @Autowired
     private InstallScripts installScripts;
     private InstallScripts installScripts;
 
 
@@ -107,10 +129,14 @@ public class RuleChainController extends BaseController {
     @Value("${actors.rule.chain.debug_mode_rate_limits_per_tenant.enabled}")
     @Value("${actors.rule.chain.debug_mode_rate_limits_per_tenant.enabled}")
     private boolean debugPerTenantEnabled;
     private boolean debugPerTenantEnabled;
 
 
+    @ApiOperation(value = "Get Rule Chain (getRuleChainById)",
+            notes = "Fetch the Rule Chain object based on the provided Rule Chain Id. " + RULE_CHAIN_DESCRIPTION + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/{ruleChainId}", method = RequestMethod.GET)
     @RequestMapping(value = "/ruleChain/{ruleChainId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public RuleChain getRuleChainById(@PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
+    public RuleChain getRuleChainById(
+            @ApiParam(value = RULE_CHAIN_ID_PARAM_DESCRIPTION)
+            @PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         try {
         try {
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
@@ -120,10 +146,14 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Rule Chain (getRuleChainById)",
+            notes = "Fetch the Rule Chain Metadata object based on the provided Rule Chain Id. " + RULE_CHAIN_METADATA_DESCRIPTION + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/{ruleChainId}/metadata", method = RequestMethod.GET)
     @RequestMapping(value = "/ruleChain/{ruleChainId}/metadata", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public RuleChainMetaData getRuleChainMetaData(@PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
+    public RuleChainMetaData getRuleChainMetaData(
+            @ApiParam(value = RULE_CHAIN_ID_PARAM_DESCRIPTION)
+            @PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         try {
         try {
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
@@ -134,11 +164,18 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
-
+    @ApiOperation(value = "Create Or Update Rule Chain (saveRuleChain)",
+            notes = "Create or update the Rule Chain. When creating Rule Chain, platform generates Rule Chain Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "The newly created Rule Chain Id will be present in the response. " +
+                    "Specify existing Rule Chain id to update the rule chain. " +
+                    "Referencing non-existing rule chain Id will cause 'Not Found' error." +
+                    "\n\n" + RULE_CHAIN_DESCRIPTION)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain", method = RequestMethod.POST)
     @RequestMapping(value = "/ruleChain", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public RuleChain saveRuleChain(@RequestBody RuleChain ruleChain) throws ThingsboardException {
+    public RuleChain saveRuleChain(
+            @ApiParam(value = "A JSON value representing the rule chain.")
+            @RequestBody RuleChain ruleChain) throws ThingsboardException {
         try {
         try {
             boolean created = ruleChain.getId() == null;
             boolean created = ruleChain.getId() == null;
             ruleChain.setTenantId(getCurrentUser().getTenantId());
             ruleChain.setTenantId(getCurrentUser().getTenantId());
@@ -172,10 +209,15 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Create Default Rule Chain",
+            notes = "Create rule chain from template, based on the specified name in the request. " +
+                    "Creates the rule chain based on the template that is used to create root rule chain. " + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/device/default", method = RequestMethod.POST)
     @RequestMapping(value = "/ruleChain/device/default", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public RuleChain saveRuleChain(@RequestBody DefaultRuleChainCreateRequest request) throws ThingsboardException {
+    public RuleChain saveRuleChain(
+            @ApiParam(value = "A JSON value representing the request.")
+            @RequestBody DefaultRuleChainCreateRequest request) throws ThingsboardException {
         try {
         try {
             checkNotNull(request);
             checkNotNull(request);
             checkParameter(request.getName(), "name");
             checkParameter(request.getName(), "name");
@@ -195,10 +237,14 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Set Root Rule Chain (setRootRuleChain)",
+            notes = "Makes the rule chain to be root rule chain. Updates previous root rule chain as well. " + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/{ruleChainId}/root", method = RequestMethod.POST)
     @RequestMapping(value = "/ruleChain/{ruleChainId}/root", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public RuleChain setRootRuleChain(@PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
+    public RuleChain setRootRuleChain(
+            @ApiParam(value = RULE_CHAIN_ID_PARAM_DESCRIPTION)
+            @PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         try {
         try {
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
@@ -234,10 +280,14 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Update Rule Chain Metadata",
+            notes = "Updates the rule chain metadata. " + RULE_CHAIN_METADATA_DESCRIPTION + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/metadata", method = RequestMethod.POST)
     @RequestMapping(value = "/ruleChain/metadata", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public RuleChainMetaData saveRuleChainMetaData(@RequestBody RuleChainMetaData ruleChainMetaData) throws ThingsboardException {
+    public RuleChainMetaData saveRuleChainMetaData(
+            @ApiParam(value = "A JSON value representing the rule chain metadata.")
+            @RequestBody RuleChainMetaData ruleChainMetaData) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getTenantId();
             TenantId tenantId = getTenantId();
             if (debugPerTenantEnabled) {
             if (debugPerTenantEnabled) {
@@ -275,15 +325,24 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+
+    @ApiOperation(value = "Get Rule Chains (getRuleChains)",
+            notes = "Returns a page of Rule Chains owned by tenant. " + RULE_CHAIN_DESCRIPTION + PAGE_DATA_PARAMETERS)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChains", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/ruleChains", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<RuleChain> getRuleChains(
     public PageData<RuleChain> getRuleChains(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = RULE_CHAIN_TYPE_DESCRIPTION, allowableValues = RULE_CHAIN_TYPES_ALLOWABLE_VALUES)
             @RequestParam(value = "type", required = false) String typeStr,
             @RequestParam(value = "type", required = false) String typeStr,
+            @ApiParam(value = RULE_CHAIN_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = RULE_CHAIN_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
@@ -298,10 +357,14 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete rule chain (deleteRuleChain)",
+            notes = "Deletes the rule chain. Referencing non-existing rule chain Id will cause an error. Referencing rule chain that is used in the device profiles will cause an error.")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/{ruleChainId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/ruleChain/{ruleChainId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteRuleChain(@PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
+    public void deleteRuleChain(
+            @ApiParam(value = RULE_CHAIN_ID_PARAM_DESCRIPTION)
+            @PathVariable(RULE_CHAIN_ID) String strRuleChainId) throws ThingsboardException {
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         checkParameter(RULE_CHAIN_ID, strRuleChainId);
         try {
         try {
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
             RuleChainId ruleChainId = new RuleChainId(toUUID(strRuleChainId));
@@ -344,10 +407,15 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get latest input message (getLatestRuleNodeDebugInput)",
+            notes = "Gets the input message from the debug events for specified Rule Chain Id. " +
+                    "Referencing non-existing rule chain Id will cause an error. ")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleNode/{ruleNodeId}/debugIn", method = RequestMethod.GET)
     @RequestMapping(value = "/ruleNode/{ruleNodeId}/debugIn", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public JsonNode getLatestRuleNodeDebugInput(@PathVariable(RULE_NODE_ID) String strRuleNodeId) throws ThingsboardException {
+    public JsonNode getLatestRuleNodeDebugInput(
+            @ApiParam(value = RULE_CHAIN_ID_PARAM_DESCRIPTION)
+            @PathVariable(RULE_NODE_ID) String strRuleNodeId) throws ThingsboardException {
         checkParameter(RULE_NODE_ID, strRuleNodeId);
         checkParameter(RULE_NODE_ID, strRuleNodeId);
         try {
         try {
             RuleNodeId ruleNodeId = new RuleNodeId(toUUID(strRuleNodeId));
             RuleNodeId ruleNodeId = new RuleNodeId(toUUID(strRuleNodeId));
@@ -370,10 +438,15 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+
+    @ApiOperation(value = "Test JavaScript function",
+            notes = TEST_JS_FUNCTION + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChain/testScript", method = RequestMethod.POST)
     @RequestMapping(value = "/ruleChain/testScript", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public JsonNode testScript(@RequestBody JsonNode inputParams) throws ThingsboardException {
+    public JsonNode testScript(
+            @ApiParam(value = "Test JS request. See API call description above.")
+            @RequestBody JsonNode inputParams) throws ThingsboardException {
         try {
         try {
             String script = inputParams.get("script").asText();
             String script = inputParams.get("script").asText();
             String scriptType = inputParams.get("scriptType").asText();
             String scriptType = inputParams.get("scriptType").asText();
@@ -433,10 +506,13 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Export Rule Chains", notes = "Exports all tenant rule chains as one JSON." + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChains/export", params = {"limit"}, method = RequestMethod.GET)
     @RequestMapping(value = "/ruleChains/export", params = {"limit"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public RuleChainData exportRuleChains(@RequestParam("limit") int limit) throws ThingsboardException {
+    public RuleChainData exportRuleChains(
+            @ApiParam(value = "A limit of rule chains to export.", required = true)
+            @RequestParam("limit") int limit) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
             PageLink pageLink = new PageLink(limit);
             PageLink pageLink = new PageLink(limit);
@@ -446,10 +522,15 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Import Rule Chains", notes = "Imports all tenant rule chains as one JSON." + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/ruleChains/import", method = RequestMethod.POST)
     @RequestMapping(value = "/ruleChains/import", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public List<RuleChainImportResult> importRuleChains(@RequestBody RuleChainData ruleChainData, @RequestParam(required = false, defaultValue = "false") boolean overwrite) throws ThingsboardException {
+    public List<RuleChainImportResult> importRuleChains(
+            @ApiParam(value = "A JSON value representing the rule chains.")
+            @RequestBody RuleChainData ruleChainData,
+            @ApiParam(value = "Enables overwrite for existing rule chains with the same name.")
+            @RequestParam(required = false, defaultValue = "false") boolean overwrite) throws ThingsboardException {
         try {
         try {
             TenantId tenantId = getCurrentUser().getTenantId();
             TenantId tenantId = getCurrentUser().getTenantId();
             List<RuleChainImportResult> importResults = ruleChainService.importTenantRuleChains(tenantId, ruleChainData, overwrite);
             List<RuleChainImportResult> importResults = ruleChainService.importTenantRuleChains(tenantId, ruleChainData, overwrite);
@@ -495,6 +576,14 @@ public class RuleChainController extends BaseController {
         return msgData;
         return msgData;
     }
     }
 
 
+    @ApiOperation(value = "Assign rule chain to edge (assignRuleChainToEdge)",
+            notes = "Creates assignment of an existing rule chain to an instance of The Edge. " +
+                    EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive a copy of assignment rule chain " +
+                    EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once rule chain will be delivered to edge service, it's going to start processing messages locally. " +
+                    "\n\nOnly rule chain with type 'EDGE' can be assigned to edge.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/ruleChain/{ruleChainId}", method = RequestMethod.POST)
     @RequestMapping(value = "/edge/{edgeId}/ruleChain/{ruleChainId}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
@@ -528,6 +617,13 @@ public class RuleChainController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Unassign rule chain from edge (unassignRuleChainFromEdge)",
+            notes = "Clears assignment of the rule chain to the edge. " +
+                    EDGE_UNASSIGN_ASYNC_FIRST_STEP_DESCRIPTION +
+                    "Second, remote edge service will receive an 'unassign' command to remove rule chain " +
+                    EDGE_UNASSIGN_RECEIVE_STEP_DESCRIPTION + ". " +
+                    "Third, once 'unassign' command will be delivered to edge service, it's going to remove rule chain locally.",
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/edge/{edgeId}/ruleChain/{ruleChainId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/edge/{edgeId}/ruleChain/{ruleChainId}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody

@@ -26,10 +26,15 @@ import com.google.common.util.concurrent.MoreExecutors;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParseException;
 import com.google.gson.JsonParseException;
 import com.google.gson.JsonParser;
 import com.google.gson.JsonParser;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.util.StringUtils;
 import org.springframework.util.StringUtils;
@@ -48,7 +53,6 @@ import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.TenantProfile;
 import org.thingsboard.server.common.data.TenantProfile;
 import org.thingsboard.server.common.data.audit.ActionType;
 import org.thingsboard.server.common.data.audit.ActionType;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
-import org.thingsboard.server.common.data.id.CustomerId;
 import org.thingsboard.server.common.data.id.DeviceId;
 import org.thingsboard.server.common.data.id.DeviceId;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityIdFactory;
 import org.thingsboard.server.common.data.id.EntityIdFactory;
@@ -108,6 +112,48 @@ import java.util.stream.Collectors;
 @Slf4j
 @Slf4j
 public class TelemetryController extends BaseController {
 public class TelemetryController extends BaseController {
 
 
+    private static final String ATTRIBUTES_SCOPE_DESCRIPTION = "A string value representing the attributes scope. For example, 'SERVER_SCOPE'.";
+    private static final String ATTRIBUTES_KEYS_DESCRIPTION = "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'.";
+    private static final String ATTRIBUTES_SCOPE_ALLOWED_VALUES = "SERVER_SCOPE, CLIENT_SCOPE, SHARED_SCOPE";
+    private static final String ATTRIBUTES_JSON_REQUEST_DESCRIPTION = "A string value representing the json object. For example, '{\"key\":\"value\"}'";
+    private static final String ATTRIBUTE_DATA_CLASS_DESCRIPTION = "AttributeData class represents information regarding a particular attribute and includes the next parameters: 'lastUpdatesTs' - a long value representing the timestamp of the last attribute modification in milliseconds. 'key' - attribute key name, and 'value' - attribute value.";
+    private static final String GET_ALL_ATTRIBUTES_BASE_DESCRIPTION = "Returns a JSON structure that represents a list of AttributeData class objects for the selected entity based on the specified comma-separated list of attribute key names. " + ATTRIBUTE_DATA_CLASS_DESCRIPTION;
+    private static final String GET_ALL_ATTRIBUTES_BY_SCOPE_BASE_DESCRIPTION = "Returns a JSON structure that represents a list of AttributeData class objects for the selected entity based on the attributes scope selected and a comma-separated list of attribute key names. " + ATTRIBUTE_DATA_CLASS_DESCRIPTION;
+
+    private static final String TS_DATA_CLASS_DESCRIPTION = "TsData class is a timeseries data point for specific telemetry key that includes 'value' - object value, and 'ts' - a long value representing timestamp in milliseconds for this value. ";
+
+    private static final String TELEMETRY_KEYS_BASE_DESCRIPTION = "A string value representing the comma-separated list of telemetry keys.";
+    private static final String TELEMETRY_KEYS_DESCRIPTION = TELEMETRY_KEYS_BASE_DESCRIPTION + " If keys are not selected, the result will return all latest timeseries. For example, 'temp,humidity'.";
+    private static final String TELEMETRY_SCOPE_DESCRIPTION = "Value is not used in the API call implementation. However, you need to specify whatever value cause scope is a path variable.";
+    private static final String TELEMETRY_JSON_REQUEST_DESCRIPTION = "A string value representing the json object. For example, '{\"key\":\"value\"}' or '{\"ts\":1527863043000,\"values\":{\"key1\":\"value1\",\"key2\":\"value2\"}}' or [{\"ts\":1527863043000,\"values\":{\"key1\":\"value1\",\"key2\":\"value2\"}}, {\"ts\":1527863053000,\"values\":{\"key1\":\"value3\",\"key2\":\"value4\"}}]";
+
+
+    private static final String STRICT_DATA_TYPES_DESCRIPTION = "A boolean value to specify if values of selected telemetry keys will represent string values(by default) or use strict data type.";
+    private static final String INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION = "Referencing a non-existing entity Id or invalid entity type will cause an error. ";
+
+    private static final String SAVE_ENTITY_ATTRIBUTES_DESCRIPTION = "Creates or updates the entity attributes based on entity id, entity type, specified attributes scope " +
+            "and request payload that represents a JSON object with key-value format of attributes to create or update. " +
+            "For example, '{\"temperature\": 26}'. Key is a unique parameter and cannot be overwritten. Only value can be overwritten for the key. ";
+    private static final String SAVE_ATTIRIBUTES_STATUS_OK = "Attribute from the request was created or updated. ";
+    private static final String INVALID_STRUCTURE_OF_THE_REQUEST = "Invalid structure of the request";
+    private static final String SAVE_ATTIRIBUTES_STATUS_BAD_REQUEST = INVALID_STRUCTURE_OF_THE_REQUEST + " or invalid attributes scope provided.";
+    private static final String SAVE_ENTITY_ATTRIBUTES_STATUS_OK = "Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED', " +
+            "and also sends event msg to the rule engine with msg type 'ATTRIBUTES_UPDATED'.";
+    private static final String SAVE_ENTITY_ATTRIBUTES_STATUS_UNAUTHORIZED = "User is not authorized to save entity attributes for selected entity. Most likely, User belongs to different Customer or Tenant.";
+    private static final String SAVE_ENTITY_ATTRIBUTES_STATUS_INTERNAL_SERVER_ERROR = "The exception was thrown during processing the request. " +
+            "Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.";
+    private static final String SAVE_ENTITY_TIMESERIES_DESCRIPTION = "Creates or updates the entity timeseries based on entity id, entity type " +
+            "and request payload that represents a JSON object with key-value or ts-values format. " +
+            "For example, '{\"temperature\": 26}'  or '{\"ts\":1634712287000,\"values\":{\"temperature\":26, \"humidity\":87}}', " +
+            "or JSON array with inner objects inside of ts-values format. " +
+            "For example, '[{\"ts\":1634712287000,\"values\":{\"temperature\":26, \"humidity\":87}}, {\"ts\":1634712588000,\"values\":{\"temperature\":25, \"humidity\":88}}]'. " +
+            "The scope parameter is not used in the API call implementation but should be specified whatever value because it is used as a path variable. ";
+    private static final String SAVE_ENTITY_TIMESERIES_STATUS_OK = "Timeseries from the request was created or updated. " +
+            "Platform creates an audit log event about entity timeseries updates with action type 'TIMESERIES_UPDATED'.";
+    private static final String SAVE_ENTITY_TIMESERIES_STATUS_UNAUTHORIZED = "User is not authorized to save entity timeseries for selected entity. Most likely, User belongs to different Customer or Tenant.";
+    private static final String SAVE_ENTITY_TIMESERIES_STATUS_INTERNAL_SERVER_ERROR = "The exception was thrown during processing the request. " +
+            "Platform creates an audit log event about entity timeseries updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.";
+
     @Autowired
     @Autowired
     private TimeseriesService tsService;
     private TimeseriesService tsService;
 
 
@@ -133,83 +179,132 @@ public class TelemetryController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get all attribute keys (getAttributeKeys)",
+            notes = "Returns a list of all attribute key names for the selected entity. " +
+                    "In the case of device entity specified, a response will include merged attribute key names list from each scope: " +
+                    "SERVER_SCOPE, CLIENT_SCOPE, SHARED_SCOPE. " + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/keys/attributes", method = RequestMethod.GET)
     @RequestMapping(value = "/{entityType}/{entityId}/keys/attributes", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getAttributeKeys(
     public DeferredResult<ResponseEntity> getAttributeKeys(
-            @PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr) throws ThingsboardException {
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr) throws ThingsboardException {
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr, this::getAttributeKeysCallback);
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr, this::getAttributeKeysCallback);
     }
     }
 
 
+    @ApiOperation(value = "Get all attributes keys by scope (getAttributeKeysByScope)",
+            notes = "Returns a list of attribute key names from the specified attributes scope for the selected entity. " +
+                    "If scope parameter is omitted, Get all attribute keys(getAttributeKeys) API will be called. " + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/keys/attributes/{scope}", method = RequestMethod.GET)
     @RequestMapping(value = "/{entityType}/{entityId}/keys/attributes/{scope}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getAttributeKeysByScope(
     public DeferredResult<ResponseEntity> getAttributeKeysByScope(
-            @PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr
-            , @PathVariable("scope") String scope) throws ThingsboardException {
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope) throws ThingsboardException {
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr,
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr,
                 (result, tenantId, entityId) -> getAttributeKeysCallback(result, tenantId, entityId, scope));
                 (result, tenantId, entityId) -> getAttributeKeysCallback(result, tenantId, entityId, scope));
     }
     }
 
 
+    @ApiOperation(value = "Get attributes (getAttributes)",
+            notes = GET_ALL_ATTRIBUTES_BASE_DESCRIPTION + " If 'keys' parameter is omitted, AttributeData class objects will be added to the response for all existing keys of the selected entity. " +
+                    INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/values/attributes", method = RequestMethod.GET)
     @RequestMapping(value = "/{entityType}/{entityId}/values/attributes", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getAttributes(
     public DeferredResult<ResponseEntity> getAttributes(
-            @PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-            @RequestParam(name = "keys", required = false) String keysStr) throws ThingsboardException {
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = ATTRIBUTES_KEYS_DESCRIPTION) @RequestParam(name = "keys", required = false) String keysStr) throws ThingsboardException {
         SecurityUser user = getCurrentUser();
         SecurityUser user = getCurrentUser();
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr,
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr,
                 (result, tenantId, entityId) -> getAttributeValuesCallback(result, user, entityId, null, keysStr));
                 (result, tenantId, entityId) -> getAttributeValuesCallback(result, user, entityId, null, keysStr));
     }
     }
 
 
+    @ApiOperation(value = "Get attributes by scope (getAttributesByScope)",
+            notes = GET_ALL_ATTRIBUTES_BY_SCOPE_BASE_DESCRIPTION + " In case that 'keys' parameter is not selected, " +
+                    "AttributeData class objects will be added to the response for all existing attribute keys from the " +
+                    "specified attributes scope of the selected entity. If 'scope' parameter is omitted, " +
+                    "Get attributes (getAttributes) API will be called. " + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/values/attributes/{scope}", method = RequestMethod.GET)
     @RequestMapping(value = "/{entityType}/{entityId}/values/attributes/{scope}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getAttributesByScope(
     public DeferredResult<ResponseEntity> getAttributesByScope(
-            @PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-            @PathVariable("scope") String scope,
-            @RequestParam(name = "keys", required = false) String keysStr) throws ThingsboardException {
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope,
+            @ApiParam(value = ATTRIBUTES_KEYS_DESCRIPTION) @RequestParam(name = "keys", required = false) String keysStr) throws ThingsboardException {
         SecurityUser user = getCurrentUser();
         SecurityUser user = getCurrentUser();
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr,
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_ATTRIBUTES, entityType, entityIdStr,
                 (result, tenantId, entityId) -> getAttributeValuesCallback(result, user, entityId, scope, keysStr));
                 (result, tenantId, entityId) -> getAttributeValuesCallback(result, user, entityId, scope, keysStr));
     }
     }
 
 
+    @ApiOperation(value = "Get timeseries keys (getTimeseriesKeys)",
+            notes = "Returns a list of all telemetry key names for the selected entity based on entity id and entity type specified. " +
+                    INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/keys/timeseries", method = RequestMethod.GET)
     @RequestMapping(value = "/{entityType}/{entityId}/keys/timeseries", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getTimeseriesKeys(
     public DeferredResult<ResponseEntity> getTimeseriesKeys(
-            @PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr) throws ThingsboardException {
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr) throws ThingsboardException {
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_TELEMETRY, entityType, entityIdStr,
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_TELEMETRY, entityType, entityIdStr,
                 (result, tenantId, entityId) -> Futures.addCallback(tsService.findAllLatest(tenantId, entityId), getTsKeysToResponseCallback(result), MoreExecutors.directExecutor()));
                 (result, tenantId, entityId) -> Futures.addCallback(tsService.findAllLatest(tenantId, entityId), getTsKeysToResponseCallback(result), MoreExecutors.directExecutor()));
     }
     }
 
 
+    @ApiOperation(value = "Get latest timeseries (getLatestTimeseries)",
+            notes = "Returns a JSON structure that represents a Map, where the map key is a telemetry key name " +
+                    "and map value - is a singleton list of TsData class objects. " + TS_DATA_CLASS_DESCRIPTION + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/values/timeseries", method = RequestMethod.GET)
     @RequestMapping(value = "/{entityType}/{entityId}/values/timeseries", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getLatestTimeseries(
     public DeferredResult<ResponseEntity> getLatestTimeseries(
-            @PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-            @RequestParam(name = "keys", required = false) String keysStr,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = TELEMETRY_KEYS_DESCRIPTION) @RequestParam(name = "keys", required = false) String keysStr,
+            @ApiParam(value = STRICT_DATA_TYPES_DESCRIPTION)
             @RequestParam(name = "useStrictDataTypes", required = false, defaultValue = "false") Boolean useStrictDataTypes) throws ThingsboardException {
             @RequestParam(name = "useStrictDataTypes", required = false, defaultValue = "false") Boolean useStrictDataTypes) throws ThingsboardException {
         SecurityUser user = getCurrentUser();
         SecurityUser user = getCurrentUser();
-
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_TELEMETRY, entityType, entityIdStr,
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_TELEMETRY, entityType, entityIdStr,
                 (result, tenantId, entityId) -> getLatestTimeseriesValuesCallback(result, user, entityId, keysStr, useStrictDataTypes));
                 (result, tenantId, entityId) -> getLatestTimeseriesValuesCallback(result, user, entityId, keysStr, useStrictDataTypes));
     }
     }
 
 
-
+    @ApiOperation(value = "Get timeseries (getTimeseries)",
+            notes = "Returns a JSON structure that represents a Map, where the map key is a telemetry key name " +
+                    "and map value - is a list of TsData class objects. " + TS_DATA_CLASS_DESCRIPTION +
+                    "This method allows us to group original data into intervals and aggregate it using one of the aggregation methods or just limit the number of TsData objects to fetch for each key specified. " +
+                    "See the desription of the request parameters for more details. " +
+                    "The result can also be sorted in ascending or descending order. " + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/values/timeseries", method = RequestMethod.GET, params = {"keys", "startTs", "endTs"})
     @RequestMapping(value = "/{entityType}/{entityId}/values/timeseries", method = RequestMethod.GET, params = {"keys", "startTs", "endTs"})
     @ResponseBody
     @ResponseBody
     public DeferredResult<ResponseEntity> getTimeseries(
     public DeferredResult<ResponseEntity> getTimeseries(
-            @PathVariable("entityType") String entityType,
-            @PathVariable("entityId") String entityIdStr,
-            @RequestParam(name = "keys") String keys,
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = TELEMETRY_KEYS_BASE_DESCRIPTION) @RequestParam(name = "keys") String keys,
+            @ApiParam(value = "A long value representing the start timestamp of search time range in milliseconds.")
             @RequestParam(name = "startTs") Long startTs,
             @RequestParam(name = "startTs") Long startTs,
+            @ApiParam(value = "A long value representing the end timestamp of search time range in milliseconds.")
             @RequestParam(name = "endTs") Long endTs,
             @RequestParam(name = "endTs") Long endTs,
+            @ApiParam(value = "A long value representing the aggregation interval range in milliseconds.")
             @RequestParam(name = "interval", defaultValue = "0") Long interval,
             @RequestParam(name = "interval", defaultValue = "0") Long interval,
+            @ApiParam(value = "An integer value that represents a max number of timeseries data points to fetch." +
+                    " This parameter is used only in the case if 'agg' parameter is set to 'NONE'.", defaultValue = "100")
             @RequestParam(name = "limit", defaultValue = "100") Integer limit,
             @RequestParam(name = "limit", defaultValue = "100") Integer limit,
+            @ApiParam(value = "A string value representing the aggregation function. " +
+                    "If the interval is not specified, 'agg' parameter will use 'NONE' value.",
+                    allowableValues = "MIN, MAX, AVG, SUM, COUNT, NONE")
             @RequestParam(name = "agg", defaultValue = "NONE") String aggStr,
             @RequestParam(name = "agg", defaultValue = "NONE") String aggStr,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(name = "orderBy", defaultValue = "DESC") String orderBy,
             @RequestParam(name = "orderBy", defaultValue = "DESC") String orderBy,
+            @ApiParam(value = STRICT_DATA_TYPES_DESCRIPTION)
             @RequestParam(name = "useStrictDataTypes", required = false, defaultValue = "false") Boolean useStrictDataTypes) throws ThingsboardException {
             @RequestParam(name = "useStrictDataTypes", required = false, defaultValue = "false") Boolean useStrictDataTypes) throws ThingsboardException {
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_TELEMETRY, entityType, entityIdStr,
         return accessValidator.validateEntityAndCallback(getCurrentUser(), Operation.READ_TELEMETRY, entityType, entityIdStr,
                 (result, tenantId, entityId) -> {
                 (result, tenantId, entityId) -> {
@@ -222,64 +317,145 @@ public class TelemetryController extends BaseController {
                 });
                 });
     }
     }
 
 
+    @ApiOperation(value = "Save or update device attributes (saveDeviceAttributes)",
+            notes = "Creates or updates the device attributes based on device id, specified attribute scope, " +
+                    "and request payload that represents a JSON object with key-value format of attributes to create or update. " +
+                    "For example, '{\"temperature\": 26}'. Key is a unique parameter and cannot be overwritten. Only value can " +
+                    "be overwritten for the key. ",
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = SAVE_ATTIRIBUTES_STATUS_OK +
+                    "Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED', " +
+                    "and also sends event msg to the rule engine with msg type 'ATTRIBUTES_UPDATED'."),
+            @ApiResponse(code = 400, message = SAVE_ATTIRIBUTES_STATUS_BAD_REQUEST),
+            @ApiResponse(code = 401, message = "User is not authorized to save device attributes for selected device. Most likely, User belongs to different Customer or Tenant."),
+            @ApiResponse(code = 500, message = "The exception was thrown during processing the request. " +
+                    "Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace."),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{deviceId}/{scope}", method = RequestMethod.POST)
     @RequestMapping(value = "/{deviceId}/{scope}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> saveDeviceAttributes(@PathVariable("deviceId") String deviceIdStr, @PathVariable("scope") String scope,
-                                                               @RequestBody JsonNode request) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> saveDeviceAttributes(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION) @PathVariable("deviceId") String deviceIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope,
+            @ApiParam(value = ATTRIBUTES_JSON_REQUEST_DESCRIPTION) @RequestBody JsonNode request) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndUuid(EntityType.DEVICE, deviceIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndUuid(EntityType.DEVICE, deviceIdStr);
         return saveAttributes(getTenantId(), entityId, scope, request);
         return saveAttributes(getTenantId(), entityId, scope, request);
     }
     }
 
 
+    @ApiOperation(value = "Save or update attributes (saveEntityAttributesV1)",
+            notes = SAVE_ENTITY_ATTRIBUTES_DESCRIPTION + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = SAVE_ATTIRIBUTES_STATUS_OK + SAVE_ENTITY_ATTRIBUTES_STATUS_OK),
+            @ApiResponse(code = 400, message = SAVE_ATTIRIBUTES_STATUS_BAD_REQUEST),
+            @ApiResponse(code = 401, message = SAVE_ENTITY_ATTRIBUTES_STATUS_UNAUTHORIZED),
+            @ApiResponse(code = 500, message = SAVE_ENTITY_ATTRIBUTES_STATUS_INTERNAL_SERVER_ERROR),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/{scope}", method = RequestMethod.POST)
     @RequestMapping(value = "/{entityType}/{entityId}/{scope}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> saveEntityAttributesV1(@PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-                                                                 @PathVariable("scope") String scope,
-                                                                 @RequestBody JsonNode request) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> saveEntityAttributesV1(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope,
+            @ApiParam(value = ATTRIBUTES_JSON_REQUEST_DESCRIPTION) @RequestBody JsonNode request) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         return saveAttributes(getTenantId(), entityId, scope, request);
         return saveAttributes(getTenantId(), entityId, scope, request);
     }
     }
 
 
+    @ApiOperation(value = "Save or update attributes (saveEntityAttributesV2)",
+            notes = SAVE_ENTITY_ATTRIBUTES_DESCRIPTION + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = SAVE_ATTIRIBUTES_STATUS_OK + SAVE_ENTITY_ATTRIBUTES_STATUS_OK),
+            @ApiResponse(code = 400, message = SAVE_ATTIRIBUTES_STATUS_BAD_REQUEST),
+            @ApiResponse(code = 401, message = SAVE_ENTITY_ATTRIBUTES_STATUS_UNAUTHORIZED),
+            @ApiResponse(code = 500, message = SAVE_ENTITY_ATTRIBUTES_STATUS_INTERNAL_SERVER_ERROR),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/attributes/{scope}", method = RequestMethod.POST)
     @RequestMapping(value = "/{entityType}/{entityId}/attributes/{scope}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> saveEntityAttributesV2(@PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-                                                                 @PathVariable("scope") String scope,
-                                                                 @RequestBody JsonNode request) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> saveEntityAttributesV2(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope,
+            @ApiParam(value = ATTRIBUTES_JSON_REQUEST_DESCRIPTION) @RequestBody JsonNode request) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         return saveAttributes(getTenantId(), entityId, scope, request);
         return saveAttributes(getTenantId(), entityId, scope, request);
     }
     }
 
 
+    @ApiOperation(value = "Save or update telemetry (saveEntityTelemetry)",
+            notes = SAVE_ENTITY_TIMESERIES_DESCRIPTION + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = SAVE_ENTITY_TIMESERIES_STATUS_OK),
+            @ApiResponse(code = 400, message = INVALID_STRUCTURE_OF_THE_REQUEST),
+            @ApiResponse(code = 401, message = SAVE_ENTITY_TIMESERIES_STATUS_UNAUTHORIZED),
+            @ApiResponse(code = 500, message = SAVE_ENTITY_TIMESERIES_STATUS_INTERNAL_SERVER_ERROR),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/timeseries/{scope}", method = RequestMethod.POST)
     @RequestMapping(value = "/{entityType}/{entityId}/timeseries/{scope}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> saveEntityTelemetry(@PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-                                                              @PathVariable("scope") String scope,
-                                                              @RequestBody String requestBody) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> saveEntityTelemetry(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = TELEMETRY_SCOPE_DESCRIPTION) @PathVariable("scope") String scope,
+            @ApiParam(value = TELEMETRY_JSON_REQUEST_DESCRIPTION) @RequestBody String requestBody) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         return saveTelemetry(getTenantId(), entityId, requestBody, 0L);
         return saveTelemetry(getTenantId(), entityId, requestBody, 0L);
     }
     }
 
 
+    @ApiOperation(value = "Save or update telemetry with TTL (saveEntityTelemetryWithTTL)",
+            notes = SAVE_ENTITY_TIMESERIES_DESCRIPTION + "The ttl parameter used only in case of Cassandra DB use for timeseries data storage. " + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = SAVE_ENTITY_TIMESERIES_STATUS_OK),
+            @ApiResponse(code = 400, message = INVALID_STRUCTURE_OF_THE_REQUEST),
+            @ApiResponse(code = 401, message = SAVE_ENTITY_TIMESERIES_STATUS_UNAUTHORIZED),
+            @ApiResponse(code = 500, message = SAVE_ENTITY_TIMESERIES_STATUS_INTERNAL_SERVER_ERROR),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/timeseries/{scope}/{ttl}", method = RequestMethod.POST)
     @RequestMapping(value = "/{entityType}/{entityId}/timeseries/{scope}/{ttl}", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> saveEntityTelemetryWithTTL(@PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-                                                                     @PathVariable("scope") String scope, @PathVariable("ttl") Long ttl,
-                                                                     @RequestBody String requestBody) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> saveEntityTelemetryWithTTL(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = TELEMETRY_SCOPE_DESCRIPTION) @PathVariable("scope") String scope,
+            @ApiParam(value = "A long value representing TTL (Time to Live) parameter.") @PathVariable("ttl") Long ttl,
+            @ApiParam(value = TELEMETRY_JSON_REQUEST_DESCRIPTION) @RequestBody String requestBody) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         return saveTelemetry(getTenantId(), entityId, requestBody, ttl);
         return saveTelemetry(getTenantId(), entityId, requestBody, ttl);
     }
     }
 
 
+    @ApiOperation(value = "Delete entity timeseries (deleteEntityTimeseries)",
+            notes = "Delete timeseries for selected entity based on entity id, entity type, keys " +
+                    "and removal time range. To delete all data for keys parameter 'deleteAllDataForKeys' should be set to true, " +
+                    "otherwise, will be deleted data that is in range of the selected time interval. ",
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = "Timeseries for the selected keys in the request was removed. " +
+                    "Platform creates an audit log event about entity timeseries removal with action type 'TIMESERIES_DELETED'."),
+            @ApiResponse(code = 400, message = "Platform returns a bad request in case if keys list is empty or start and end timestamp values is empty when deleteAllDataForKeys is set to false."),
+            @ApiResponse(code = 401, message = "User is not authorized to delete entity timeseries for selected entity. Most likely, User belongs to different Customer or Tenant."),
+            @ApiResponse(code = 500, message = "The exception was thrown during processing the request. " +
+                    "Platform creates an audit log event about entity timeseries removal with action type 'TIMESERIES_DELETED' that includes an error stacktrace."),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/timeseries/delete", method = RequestMethod.DELETE)
     @RequestMapping(value = "/{entityType}/{entityId}/timeseries/delete", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> deleteEntityTimeseries(@PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-                                                                 @RequestParam(name = "keys") String keysStr,
-                                                                 @RequestParam(name = "deleteAllDataForKeys", defaultValue = "false") boolean deleteAllDataForKeys,
-                                                                 @RequestParam(name = "startTs", required = false) Long startTs,
-                                                                 @RequestParam(name = "endTs", required = false) Long endTs,
-                                                                 @RequestParam(name = "rewriteLatestIfDeleted", defaultValue = "false") boolean rewriteLatestIfDeleted) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> deleteEntityTimeseries(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = TELEMETRY_KEYS_DESCRIPTION) @RequestParam(name = "keys") String keysStr,
+            @ApiParam(value = "A boolean value to specify if should be deleted all data for selected keys or only data that are in the selected time range.")
+            @RequestParam(name = "deleteAllDataForKeys", defaultValue = "false") boolean deleteAllDataForKeys,
+            @ApiParam(value = "A long value representing the start timestamp of removal time range in milliseconds.")
+            @RequestParam(name = "startTs", required = false) Long startTs,
+            @ApiParam(value = "A long value representing the end timestamp of removal time range in milliseconds.")
+            @RequestParam(name = "endTs", required = false) Long endTs,
+            @ApiParam(value = "If the parameter is set to true, the latest telemetry will be rewritten in case that current latest value was removed, otherwise, in case that parameter is set to false the new latest value will not set.")
+            @RequestParam(name = "rewriteLatestIfDeleted", defaultValue = "false") boolean rewriteLatestIfDeleted) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         return deleteTimeseries(entityId, keysStr, deleteAllDataForKeys, startTs, endTs, rewriteLatestIfDeleted);
         return deleteTimeseries(entityId, keysStr, deleteAllDataForKeys, startTs, endTs, rewriteLatestIfDeleted);
     }
     }
@@ -311,7 +487,6 @@ public class TelemetryController extends BaseController {
             for (String key : keys) {
             for (String key : keys) {
                 deleteTsKvQueries.add(new BaseDeleteTsKvQuery(key, deleteFromTs, deleteToTs, rewriteLatestIfDeleted));
                 deleteTsKvQueries.add(new BaseDeleteTsKvQuery(key, deleteFromTs, deleteToTs, rewriteLatestIfDeleted));
             }
             }
-
             ListenableFuture<List<Void>> future = tsService.remove(user.getTenantId(), entityId, deleteTsKvQueries);
             ListenableFuture<List<Void>> future = tsService.remove(user.getTenantId(), entityId, deleteTsKvQueries);
             Futures.addCallback(future, new FutureCallback<List<Void>>() {
             Futures.addCallback(future, new FutureCallback<List<Void>>() {
                 @Override
                 @Override
@@ -329,22 +504,49 @@ public class TelemetryController extends BaseController {
         });
         });
     }
     }
 
 
+    @ApiOperation(value = "Delete device attributes (deleteEntityAttributes)",
+            notes = "Delete device attributes from the specified attributes scope based on device id and a list of keys to delete. " +
+                    "Selected keys will be deleted only if there are exist in the specified attribute scope. Referencing a non-existing device Id will cause an error",
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = "Device attributes was removed for the selected keys in the request. " +
+                    "Platform creates an audit log event about device attributes removal with action type 'ATTRIBUTES_DELETED'."),
+            @ApiResponse(code = 400, message = "Platform returns a bad request in case if keys or scope are not specified."),
+            @ApiResponse(code = 401, message = "User is not authorized to delete device attributes for selected entity. Most likely, User belongs to different Customer or Tenant."),
+            @ApiResponse(code = 500, message = "The exception was thrown during processing the request. " +
+                    "Platform creates an audit log event about device attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace."),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{deviceId}/{scope}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/{deviceId}/{scope}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> deleteEntityAttributes(@PathVariable("deviceId") String deviceIdStr,
-                                                                 @PathVariable("scope") String scope,
-                                                                 @RequestParam(name = "keys") String keysStr) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> deleteEntityAttributes(
+            @ApiParam(value = DEVICE_ID_PARAM_DESCRIPTION) @PathVariable("deviceId") String deviceIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope,
+            @ApiParam(value = ATTRIBUTES_KEYS_DESCRIPTION) @RequestParam(name = "keys") String keysStr) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndUuid(EntityType.DEVICE, deviceIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndUuid(EntityType.DEVICE, deviceIdStr);
         return deleteAttributes(entityId, scope, keysStr);
         return deleteAttributes(entityId, scope, keysStr);
     }
     }
 
 
+    @ApiOperation(value = "Delete entity attributes (deleteEntityAttributes)",
+            notes = "Delete entity attributes from the specified attributes scope based on entity id, entity type and a list of keys to delete. " +
+                    "Selected keys will be deleted only if there are exist in the specified attribute scope." + INVALID_ENTITY_ID_OR_ENTITY_TYPE_DESCRIPTION,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = "Entity attributes was removed for the selected keys in the request. " +
+                    "Platform creates an audit log event about entity attributes removal with action type 'ATTRIBUTES_DELETED'."),
+            @ApiResponse(code = 400, message = "Platform returns a bad request in case if keys or scope are not specified."),
+            @ApiResponse(code = 401, message = "User is not authorized to delete entity attributes for selected entity. Most likely, User belongs to different Customer or Tenant."),
+            @ApiResponse(code = 500, message = "The exception was thrown during processing the request. " +
+                    "Platform creates an audit log event about entity attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace."),
+    })
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/{entityType}/{entityId}/{scope}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/{entityType}/{entityId}/{scope}", method = RequestMethod.DELETE)
     @ResponseBody
     @ResponseBody
-    public DeferredResult<ResponseEntity> deleteEntityAttributes(@PathVariable("entityType") String entityType, @PathVariable("entityId") String entityIdStr,
-                                                                 @PathVariable("scope") String scope,
-                                                                 @RequestParam(name = "keys") String keysStr) throws ThingsboardException {
+    public DeferredResult<ResponseEntity> deleteEntityAttributes(
+            @ApiParam(value = ENTITY_TYPE_PARAM_DESCRIPTION) @PathVariable("entityType") String entityType,
+            @ApiParam(value = ENTITY_ID_PARAM_DESCRIPTION) @PathVariable("entityId") String entityIdStr,
+            @ApiParam(value = ATTRIBUTES_SCOPE_DESCRIPTION, allowableValues = ATTRIBUTES_SCOPE_ALLOWED_VALUES) @PathVariable("scope") String scope,
+            @ApiParam(value = ATTRIBUTES_KEYS_DESCRIPTION) @RequestParam(name = "keys") String keysStr) throws ThingsboardException {
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         EntityId entityId = EntityIdFactory.getByTypeAndId(entityType, entityIdStr);
         return deleteAttributes(entityId, scope, keysStr);
         return deleteAttributes(entityId, scope, keysStr);
     }
     }

@@ -16,6 +16,8 @@
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
@@ -47,21 +49,26 @@ import org.thingsboard.server.service.security.permission.Resource;
 @Slf4j
 @Slf4j
 public class TenantController extends BaseController {
 public class TenantController extends BaseController {
 
 
+    private static final String TENANT_INFO_DESCRIPTION = "The Tenant Info object extends regular Tenant object and includes Tenant Profile name. ";
     @Autowired
     @Autowired
     private InstallScripts installScripts;
     private InstallScripts installScripts;
 
 
     @Autowired
     @Autowired
     private TenantService tenantService;
     private TenantService tenantService;
 
 
+    @ApiOperation(value = "Get Tenant (getTenantById)",
+            notes = "Fetch the Tenant object based on the provided Tenant Id. " + SYSTEM_OR_TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/{tenantId}", method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/{tenantId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public Tenant getTenantById(@PathVariable("tenantId") String strTenantId) throws ThingsboardException {
+    public Tenant getTenantById(
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION)
+            @PathVariable(TENANT_ID) String strTenantId) throws ThingsboardException {
         checkParameter(TENANT_ID, strTenantId);
         checkParameter(TENANT_ID, strTenantId);
         try {
         try {
             TenantId tenantId = new TenantId(toUUID(strTenantId));
             TenantId tenantId = new TenantId(toUUID(strTenantId));
             Tenant tenant = checkTenantId(tenantId, Operation.READ);
             Tenant tenant = checkTenantId(tenantId, Operation.READ);
-            if(!tenant.getAdditionalInfo().isNull()) {
+            if (!tenant.getAdditionalInfo().isNull()) {
                 processDashboardIdFromAdditionalInfo((ObjectNode) tenant.getAdditionalInfo(), HOME_DASHBOARD);
                 processDashboardIdFromAdditionalInfo((ObjectNode) tenant.getAdditionalInfo(), HOME_DASHBOARD);
             }
             }
             return tenant;
             return tenant;
@@ -70,10 +77,15 @@ public class TenantController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Info (getTenantInfoById)",
+            notes = "Fetch the Tenant Info object based on the provided Tenant Id. " +
+                    TENANT_INFO_DESCRIPTION + SYSTEM_OR_TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/tenant/info/{tenantId}", method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/info/{tenantId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public TenantInfo getTenantInfoById(@PathVariable("tenantId") String strTenantId) throws ThingsboardException {
+    public TenantInfo getTenantInfoById(
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION)
+            @PathVariable(TENANT_ID) String strTenantId) throws ThingsboardException {
         checkParameter(TENANT_ID, strTenantId);
         checkParameter(TENANT_ID, strTenantId);
         try {
         try {
             TenantId tenantId = new TenantId(toUUID(strTenantId));
             TenantId tenantId = new TenantId(toUUID(strTenantId));
@@ -83,10 +95,19 @@ public class TenantController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Create Or update Tenant (saveTenant)",
+            notes = "Create or update the Tenant. When creating tenant, platform generates Tenant Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "Default Rule Chain and Device profile are also generated for the new tenants automatically. " +
+                    "The newly created Tenant Id will be present in the response. " +
+                    "Specify existing Tenant Id id to update the Tenant. " +
+                    "Referencing non-existing Tenant Id will cause 'Not Found' error." +
+                    SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenant", method = RequestMethod.POST)
     @RequestMapping(value = "/tenant", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public Tenant saveTenant(@RequestBody Tenant tenant) throws ThingsboardException {
+    public Tenant saveTenant(
+            @ApiParam(value = "A JSON value representing the tenant.")
+            @RequestBody Tenant tenant) throws ThingsboardException {
         try {
         try {
             boolean newTenant = tenant.getId() == null;
             boolean newTenant = tenant.getId() == null;
 
 
@@ -107,11 +128,15 @@ public class TenantController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete Tenant (deleteTenant)",
+            notes = "Deletes the tenant, it's customers, rule chains, devices and all other related entities. Referencing non-existing tenant Id will cause an error." + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenant/{tenantId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/tenant/{tenantId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteTenant(@PathVariable("tenantId") String strTenantId) throws ThingsboardException {
-        checkParameter("tenantId", strTenantId);
+    public void deleteTenant(
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION)
+            @PathVariable(TENANT_ID) String strTenantId) throws ThingsboardException {
+        checkParameter(TENANT_ID, strTenantId);
         try {
         try {
             TenantId tenantId = new TenantId(toUUID(strTenantId));
             TenantId tenantId = new TenantId(toUUID(strTenantId));
             Tenant tenant = checkTenantId(tenantId, Operation.DELETE);
             Tenant tenant = checkTenantId(tenantId, Operation.DELETE);
@@ -124,14 +149,21 @@ public class TenantController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenants (getTenants)", notes = "Returns a page of tenants registered in the platform. " + PAGE_DATA_PARAMETERS + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenants", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenants", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<Tenant> getTenants(@RequestParam int pageSize,
-                                       @RequestParam int page,
-                                       @RequestParam(required = false) String textSearch,
-                                       @RequestParam(required = false) String sortProperty,
-                                       @RequestParam(required = false) String sortOrder) throws ThingsboardException {
+    public PageData<Tenant> getTenants(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = TENANT_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = TENANT_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             return checkNotNull(tenantService.findTenants(pageLink));
             return checkNotNull(tenantService.findTenants(pageLink));
@@ -140,14 +172,23 @@ public class TenantController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenants Info (getTenants)", notes = "Returns a page of tenant info objects registered in the platform. "
+            + TENANT_INFO_DESCRIPTION + PAGE_DATA_PARAMETERS + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenantInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<TenantInfo> getTenantInfos(@RequestParam int pageSize,
-                                               @RequestParam int page,
-                                               @RequestParam(required = false) String textSearch,
-                                               @RequestParam(required = false) String sortProperty,
-                                               @RequestParam(required = false) String sortOrder) throws ThingsboardException {
+    public PageData<TenantInfo> getTenantInfos(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = TENANT_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = TENANT_INFO_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder
+    ) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             return checkNotNull(tenantService.findTenantInfos(pageLink));
             return checkNotNull(tenantService.findTenantInfos(pageLink));

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatus;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -44,10 +46,16 @@ import org.thingsboard.server.service.security.permission.Resource;
 @Slf4j
 @Slf4j
 public class TenantProfileController extends BaseController {
 public class TenantProfileController extends BaseController {
 
 
+    private static final String TENANT_PROFILE_INFO_DESCRIPTION = "Tenant Profile Info is a lightweight object that contains only id and name of the profile. ";
+
+    @ApiOperation(value = "Get Tenant Profile (getTenantProfileById)",
+            notes = "Fetch the Tenant Profile object based on the provided Tenant Profile Id. " + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfile/{tenantProfileId}", method = RequestMethod.GET)
     @RequestMapping(value = "/tenantProfile/{tenantProfileId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public TenantProfile getTenantProfileById(@PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
+    public TenantProfile getTenantProfileById(
+            @ApiParam(value = TENANT_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
         checkParameter("tenantProfileId", strTenantProfileId);
         checkParameter("tenantProfileId", strTenantProfileId);
         try {
         try {
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
@@ -57,10 +65,14 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Profile Info (getTenantProfileInfoById)",
+            notes = "Fetch the Tenant Profile Info object based on the provided Tenant Profile Id. " + TENANT_PROFILE_INFO_DESCRIPTION + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfileInfo/{tenantProfileId}", method = RequestMethod.GET)
     @RequestMapping(value = "/tenantProfileInfo/{tenantProfileId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public EntityInfo getTenantProfileInfoById(@PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
+    public EntityInfo getTenantProfileInfoById(
+            @ApiParam(value = TENANT_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
         checkParameter("tenantProfileId", strTenantProfileId);
         checkParameter("tenantProfileId", strTenantProfileId);
         try {
         try {
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
@@ -70,6 +82,8 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get default Tenant Profile Info (getDefaultTenantProfileInfo)",
+            notes = "Fetch the default Tenant Profile Info object based. " + TENANT_PROFILE_INFO_DESCRIPTION + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfileInfo/default", method = RequestMethod.GET)
     @RequestMapping(value = "/tenantProfileInfo/default", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -81,10 +95,65 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Create Or update Tenant Profile (saveTenantProfile)",
+            notes = "Create or update the Tenant Profile. When creating tenant profile, platform generates Tenant Profile Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "The newly created Tenant Profile Id will be present in the response. " +
+                    "Specify existing Tenant Profile Id id to update the Tenant Profile. " +
+                    "Referencing non-existing Tenant Profile Id will cause 'Not Found' error. " +
+                    "\n\nUpdate of the tenant profile configuration will cause immediate recalculation of API limits for all affected Tenants. " +
+                    "\n\nThe **'profileData'** object is the part of Tenant Profile that defines API limits and Rate limits. " +
+                    "\n\nYou have an ability to define maximum number of devices ('maxDevice'), assets ('maxAssets') and other entities. " +
+                    "You may also define maximum number of messages to be processed per month ('maxTransportMessages', 'maxREExecutions', etc). " +
+                    "The '*RateLimit' defines the rate limits using simple syntax. For example, '1000:1,20000:60' means up to 1000 events per second but no more than 20000 event per minute. " +
+                    "Let's review the example of tenant profile data below: " +
+                    "\n\n" + MARKDOWN_CODE_BLOCK_START +
+                    "{\n" +
+                    "  \"name\": \"Default\",\n" +
+                    "  \"description\": \"Default tenant profile\",\n" +
+                    "  \"isolatedTbCore\": false,\n" +
+                    "  \"isolatedTbRuleEngine\": false,\n" +
+                    "  \"profileData\": {\n" +
+                    "    \"configuration\": {\n" +
+                    "      \"type\": \"DEFAULT\",\n" +
+                    "      \"maxDevices\": 0,\n" +
+                    "      \"maxAssets\": 0,\n" +
+                    "      \"maxCustomers\": 0,\n" +
+                    "      \"maxUsers\": 0,\n" +
+                    "      \"maxDashboards\": 0,\n" +
+                    "      \"maxRuleChains\": 0,\n" +
+                    "      \"maxResourcesInBytes\": 0,\n" +
+                    "      \"maxOtaPackagesInBytes\": 0,\n" +
+                    "      \"transportTenantMsgRateLimit\": \"1000:1,20000:60\",\n" +
+                    "      \"transportTenantTelemetryMsgRateLimit\": \"1000:1,20000:60\",\n" +
+                    "      \"transportTenantTelemetryDataPointsRateLimit\": \"1000:1,20000:60\",\n" +
+                    "      \"transportDeviceMsgRateLimit\": \"20:1,600:60\",\n" +
+                    "      \"transportDeviceTelemetryMsgRateLimit\": \"20:1,600:60\",\n" +
+                    "      \"transportDeviceTelemetryDataPointsRateLimit\": \"20:1,600:60\",\n" +
+                    "      \"maxTransportMessages\": 10000000,\n" +
+                    "      \"maxTransportDataPoints\": 10000000,\n" +
+                    "      \"maxREExecutions\": 4000000,\n" +
+                    "      \"maxJSExecutions\": 5000000,\n" +
+                    "      \"maxDPStorageDays\": 0,\n" +
+                    "      \"maxRuleNodeExecutionsPerMessage\": 50,\n" +
+                    "      \"maxEmails\": 0,\n" +
+                    "      \"maxSms\": 0,\n" +
+                    "      \"maxCreatedAlarms\": 1000,\n" +
+                    "      \"defaultStorageTtlDays\": 0,\n" +
+                    "      \"alarmsTtlDays\": 0,\n" +
+                    "      \"rpcTtlDays\": 0,\n" +
+                    "      \"warnThreshold\": 0\n" +
+                    "    }\n" +
+                    "  },\n" +
+                    "  \"default\": true\n" +
+                    "}" +
+                    MARKDOWN_CODE_BLOCK_END +
+                    SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfile", method = RequestMethod.POST)
     @RequestMapping(value = "/tenantProfile", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public TenantProfile saveTenantProfile(@RequestBody TenantProfile tenantProfile) throws ThingsboardException {
+    public TenantProfile saveTenantProfile(
+            @ApiParam(value = "A JSON value representing the tenant profile.")
+            @RequestBody TenantProfile tenantProfile) throws ThingsboardException {
         try {
         try {
             boolean newTenantProfile = tenantProfile.getId() == null;
             boolean newTenantProfile = tenantProfile.getId() == null;
             if (newTenantProfile) {
             if (newTenantProfile) {
@@ -105,10 +174,14 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete Tenant Profile (deleteTenantProfile)",
+            notes = "Deletes the tenant profile. Referencing non-existing tenant profile Id will cause an error. Referencing profile that is used by the tenants will cause an error. " + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfile/{tenantProfileId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/tenantProfile/{tenantProfileId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteTenantProfile(@PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
+    public void deleteTenantProfile(
+            @ApiParam(value = TENANT_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
         checkParameter("tenantProfileId", strTenantProfileId);
         checkParameter("tenantProfileId", strTenantProfileId);
         try {
         try {
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
@@ -120,10 +193,14 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Make tenant profile default (setDefaultTenantProfile)",
+            notes = "Makes specified tenant profile to be default. Referencing non-existing tenant profile Id will cause an error. " + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfile/{tenantProfileId}/default", method = RequestMethod.POST)
     @RequestMapping(value = "/tenantProfile/{tenantProfileId}/default", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public TenantProfile setDefaultTenantProfile(@PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
+    public TenantProfile setDefaultTenantProfile(
+            @ApiParam(value = TENANT_PROFILE_ID_PARAM_DESCRIPTION)
+            @PathVariable("tenantProfileId") String strTenantProfileId) throws ThingsboardException {
         checkParameter("tenantProfileId", strTenantProfileId);
         checkParameter("tenantProfileId", strTenantProfileId);
         try {
         try {
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
             TenantProfileId tenantProfileId = new TenantProfileId(toUUID(strTenantProfileId));
@@ -135,14 +212,21 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Profiles (getTenantProfiles)", notes = "Returns a page of tenant profiles registered in the platform. " + PAGE_DATA_PARAMETERS + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfiles", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenantProfiles", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<TenantProfile> getTenantProfiles(@RequestParam int pageSize,
-                                                     @RequestParam int page,
-                                                     @RequestParam(required = false) String textSearch,
-                                                     @RequestParam(required = false) String sortProperty,
-                                                     @RequestParam(required = false) String sortOrder) throws ThingsboardException {
+    public PageData<TenantProfile> getTenantProfiles(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = TENANT_PROFILE_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = TENANT_PROFILE_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             return checkNotNull(tenantProfileService.findTenantProfiles(getTenantId(), pageLink));
             return checkNotNull(tenantProfileService.findTenantProfiles(getTenantId(), pageLink));
@@ -151,14 +235,22 @@ public class TenantProfileController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Profiles Info (getTenantProfileInfos)", notes = "Returns a page of tenant profile info objects registered in the platform. "
+            + TENANT_PROFILE_INFO_DESCRIPTION + PAGE_DATA_PARAMETERS + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenantProfileInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenantProfileInfos", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public PageData<EntityInfo> getTenantProfileInfos(@RequestParam int pageSize,
-                                                      @RequestParam int page,
-                                                      @RequestParam(required = false) String textSearch,
-                                                      @RequestParam(required = false) String sortProperty,
-                                                      @RequestParam(required = false) String sortOrder) throws ThingsboardException {
+    public PageData<EntityInfo> getTenantProfileInfos(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
+            @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
+            @RequestParam int page,
+            @ApiParam(value = TENANT_PROFILE_TEXT_SEARCH_DESCRIPTION)
+            @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = TENANT_PROFILE_INFO_SORT_PROPERTY_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
+            @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             return checkNotNull(tenantProfileService.findTenantProfileInfos(getTenantId(), pageLink));
             return checkNotNull(tenantProfileService.findTenantProfileInfos(getTenantId(), pageLink));

@@ -15,9 +15,9 @@
  */
  */
 package org.thingsboard.server.controller;
 package org.thingsboard.server.controller;
 
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.Getter;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.beans.factory.annotation.Value;
@@ -32,7 +32,6 @@ import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.bind.annotation.RestController;
-import org.thingsboard.common.util.JacksonUtil;
 import org.thingsboard.rule.engine.api.MailService;
 import org.thingsboard.rule.engine.api.MailService;
 import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.User;
 import org.thingsboard.server.common.data.User;
@@ -52,6 +51,7 @@ import org.thingsboard.server.common.data.security.event.UserAuthDataChangedEven
 import org.thingsboard.server.common.data.security.model.JwtToken;
 import org.thingsboard.server.common.data.security.model.JwtToken;
 import org.thingsboard.server.queue.util.TbCoreComponent;
 import org.thingsboard.server.queue.util.TbCoreComponent;
 import org.thingsboard.server.service.security.auth.jwt.RefreshTokenRepository;
 import org.thingsboard.server.service.security.auth.jwt.RefreshTokenRepository;
+import org.thingsboard.server.service.security.model.JwtTokenPair;
 import org.thingsboard.server.service.security.model.SecurityUser;
 import org.thingsboard.server.service.security.model.SecurityUser;
 import org.thingsboard.server.service.security.model.UserPrincipal;
 import org.thingsboard.server.service.security.model.UserPrincipal;
 import org.thingsboard.server.service.security.model.token.JwtTokenFactory;
 import org.thingsboard.server.service.security.model.token.JwtTokenFactory;
@@ -82,20 +82,27 @@ public class UserController extends BaseController {
     private final SystemSecurityService systemSecurityService;
     private final SystemSecurityService systemSecurityService;
     private final ApplicationEventPublisher eventPublisher;
     private final ApplicationEventPublisher eventPublisher;
 
 
+    @ApiOperation(value = "Get User (getUserById)",
+            notes = "Fetch the User object based on the provided User Id. " +
+            "If the user has the authority of 'SYS_ADMIN', the server does not perform additional checks. " +
+            "If the user has the authority of 'TENANT_ADMIN', the server checks that the requested user is owned by the same tenant. " +
+            "If the user has the authority of 'CUSTOMER_USER', the server checks that the requested user is owned by the same customer.")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/user/{userId}", method = RequestMethod.GET)
     @RequestMapping(value = "/user/{userId}", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public User getUserById(@PathVariable(USER_ID) String strUserId) throws ThingsboardException {
+    public User getUserById(
+            @ApiParam(value = USER_ID_PARAM_DESCRIPTION)
+            @PathVariable(USER_ID) String strUserId) throws ThingsboardException {
         checkParameter(USER_ID, strUserId);
         checkParameter(USER_ID, strUserId);
         try {
         try {
             UserId userId = new UserId(toUUID(strUserId));
             UserId userId = new UserId(toUUID(strUserId));
             User user = checkUserId(userId, Operation.READ);
             User user = checkUserId(userId, Operation.READ);
-            if(user.getAdditionalInfo().isObject()) {
+            if (user.getAdditionalInfo().isObject()) {
                 ObjectNode additionalInfo = (ObjectNode) user.getAdditionalInfo();
                 ObjectNode additionalInfo = (ObjectNode) user.getAdditionalInfo();
                 processDashboardIdFromAdditionalInfo(additionalInfo, DEFAULT_DASHBOARD);
                 processDashboardIdFromAdditionalInfo(additionalInfo, DEFAULT_DASHBOARD);
                 processDashboardIdFromAdditionalInfo(additionalInfo, HOME_DASHBOARD);
                 processDashboardIdFromAdditionalInfo(additionalInfo, HOME_DASHBOARD);
                 UserCredentials userCredentials = userService.findUserCredentialsByUserId(user.getTenantId(), user.getId());
                 UserCredentials userCredentials = userService.findUserCredentialsByUserId(user.getTenantId(), user.getId());
-                if(userCredentials.isEnabled() && !additionalInfo.has("userCredentialsEnabled")) {
+                if (userCredentials.isEnabled() && !additionalInfo.has("userCredentialsEnabled")) {
                     additionalInfo.put("userCredentialsEnabled", true);
                     additionalInfo.put("userCredentialsEnabled", true);
                 }
                 }
             }
             }
@@ -105,6 +112,10 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Check Token Access Enabled (isUserTokenAccessEnabled)",
+            notes = "Checks that the system is configured to allow administrators to impersonate themself as other users. " +
+                    "If the user who performs the request has the authority of 'SYS_ADMIN', it is possible to login as any tenant administrator. " +
+                    "If the user who performs the request has the authority of 'TENANT_ADMIN', it is possible to login as any customer user. ")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/user/tokenAccessEnabled", method = RequestMethod.GET)
     @RequestMapping(value = "/user/tokenAccessEnabled", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
@@ -112,10 +123,16 @@ public class UserController extends BaseController {
         return userTokenAccessEnabled;
         return userTokenAccessEnabled;
     }
     }
 
 
+    @ApiOperation(value = "Get User Token (getUserToken)",
+            notes = "Returns the token of the User based on the provided User Id. " +
+                    "If the user who performs the request has the authority of 'SYS_ADMIN', it is possible to get the token of any tenant administrator. " +
+                    "If the user who performs the request has the authority of 'TENANT_ADMIN', it is possible to get the token of any customer user that belongs to the same tenant. ")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/user/{userId}/token", method = RequestMethod.GET)
     @RequestMapping(value = "/user/{userId}/token", method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
-    public JsonNode getUserToken(@PathVariable(USER_ID) String strUserId) throws ThingsboardException {
+    public JwtTokenPair getUserToken(
+            @ApiParam(value = USER_ID_PARAM_DESCRIPTION)
+            @PathVariable(USER_ID) String strUserId) throws ThingsboardException {
         checkParameter(USER_ID, strUserId);
         checkParameter(USER_ID, strUserId);
         try {
         try {
             if (!userTokenAccessEnabled) {
             if (!userTokenAccessEnabled) {
@@ -130,22 +147,26 @@ public class UserController extends BaseController {
             SecurityUser securityUser = new SecurityUser(user, credentials.isEnabled(), principal);
             SecurityUser securityUser = new SecurityUser(user, credentials.isEnabled(), principal);
             JwtToken accessToken = tokenFactory.createAccessJwtToken(securityUser);
             JwtToken accessToken = tokenFactory.createAccessJwtToken(securityUser);
             JwtToken refreshToken = refreshTokenRepository.requestRefreshToken(securityUser);
             JwtToken refreshToken = refreshTokenRepository.requestRefreshToken(securityUser);
-            ObjectMapper objectMapper = new ObjectMapper();
-            ObjectNode tokenObject = objectMapper.createObjectNode();
-            tokenObject.put("token", accessToken.getToken());
-            tokenObject.put("refreshToken", refreshToken.getToken());
-            return tokenObject;
+            return new JwtTokenPair(accessToken.getToken(), refreshToken.getToken());
         } catch (Exception e) {
         } catch (Exception e) {
             throw handleException(e);
             throw handleException(e);
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Save Or update User (saveUser)",
+            notes = "Create or update the User. When creating user, platform generates User Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "The newly created User Id will be present in the response. " +
+                    "Specify existing User Id to update the device. " +
+                    "Referencing non-existing User Id will cause 'Not Found' error." +
+                    "\n\nDevice email is unique for entire platform setup.")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/user", method = RequestMethod.POST)
     @RequestMapping(value = "/user", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public User saveUser(@RequestBody User user,
-                         @RequestParam(required = false, defaultValue = "true") boolean sendActivationMail,
-                         HttpServletRequest request) throws ThingsboardException {
+    public User saveUser(
+            @ApiParam(value = "A JSON value representing the User.", required = true)
+            @RequestBody User user,
+            @ApiParam(value = "Send activation email (or use activation link)", defaultValue = "true")
+            @RequestParam(required = false, defaultValue = "true") boolean sendActivationMail, HttpServletRequest request) throws ThingsboardException {
         try {
         try {
 
 
             if (Authority.TENANT_ADMIN.equals(getCurrentUser().getAuthority())) {
             if (Authority.TENANT_ADMIN.equals(getCurrentUser().getAuthority())) {
@@ -188,10 +209,13 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Send or re-send the activation email",
+            notes = "Force send the activation email to the user. Useful to resend the email if user has accidentally deleted it. " + SYSTEM_OR_TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/user/sendActivationMail", method = RequestMethod.POST)
     @RequestMapping(value = "/user/sendActivationMail", method = RequestMethod.POST)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
     public void sendActivationEmail(
     public void sendActivationEmail(
+            @ApiParam(value = "Email of the user", required = true)
             @RequestParam(value = "email") String email,
             @RequestParam(value = "email") String email,
             HttpServletRequest request) throws ThingsboardException {
             HttpServletRequest request) throws ThingsboardException {
         try {
         try {
@@ -214,10 +238,14 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get the activation link (getActivationLink)",
+            notes = "Get the activation link for the user. " +
+                    "The base url for activation link is configurable in the general settings of system administrator. " + SYSTEM_OR_TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/user/{userId}/activationLink", method = RequestMethod.GET, produces = "text/plain")
     @RequestMapping(value = "/user/{userId}/activationLink", method = RequestMethod.GET, produces = "text/plain")
     @ResponseBody
     @ResponseBody
     public String getActivationLink(
     public String getActivationLink(
+            @ApiParam(value = USER_ID_PARAM_DESCRIPTION)
             @PathVariable(USER_ID) String strUserId,
             @PathVariable(USER_ID) String strUserId,
             HttpServletRequest request) throws ThingsboardException {
             HttpServletRequest request) throws ThingsboardException {
         checkParameter(USER_ID, strUserId);
         checkParameter(USER_ID, strUserId);
@@ -239,10 +267,15 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Delete User (deleteUser)",
+            notes = "Deletes the User, it's credentials and all the relations (from and to the User). " +
+                    "Referencing non-existing User Id will cause an error. " + SYSTEM_OR_TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/user/{userId}", method = RequestMethod.DELETE)
     @RequestMapping(value = "/user/{userId}", method = RequestMethod.DELETE)
     @ResponseStatus(value = HttpStatus.OK)
     @ResponseStatus(value = HttpStatus.OK)
-    public void deleteUser(@PathVariable(USER_ID) String strUserId) throws ThingsboardException {
+    public void deleteUser(
+            @ApiParam(value = USER_ID_PARAM_DESCRIPTION)
+            @PathVariable(USER_ID) String strUserId) throws ThingsboardException {
         checkParameter(USER_ID, strUserId);
         checkParameter(USER_ID, strUserId);
         try {
         try {
             UserId userId = new UserId(toUUID(strUserId));
             UserId userId = new UserId(toUUID(strUserId));
@@ -267,14 +300,22 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Users (getUsers)",
+            notes = "Returns a page of users owned by tenant or customer. The scope depends on authority of the user that performs the request." +
+                    PAGE_DATA_PARAMETERS + TENANT_OR_USER_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/users", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/users", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<User> getUsers(
     public PageData<User> getUsers(
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = USER_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = USER_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         try {
         try {
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
             PageLink pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder);
@@ -289,15 +330,23 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Tenant Users (getTenantAdmins)",
+            notes = "Returns a page of users owned by tenant. " + PAGE_DATA_PARAMETERS + SYSTEM_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @PreAuthorize("hasAuthority('SYS_ADMIN')")
     @RequestMapping(value = "/tenant/{tenantId}/users", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/tenant/{tenantId}/users", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<User> getTenantAdmins(
     public PageData<User> getTenantAdmins(
-            @PathVariable("tenantId") String strTenantId,
+            @ApiParam(value = TENANT_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(TENANT_ID) String strTenantId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = USER_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = USER_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         checkParameter("tenantId", strTenantId);
         checkParameter("tenantId", strTenantId);
         try {
         try {
@@ -309,15 +358,23 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Get Customer Users (getCustomerUsers)",
+            notes = "Returns a page of users owned by customer. " + PAGE_DATA_PARAMETERS + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @PreAuthorize("hasAuthority('TENANT_ADMIN')")
     @RequestMapping(value = "/customer/{customerId}/users", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @RequestMapping(value = "/customer/{customerId}/users", params = {"pageSize", "page"}, method = RequestMethod.GET)
     @ResponseBody
     @ResponseBody
     public PageData<User> getCustomerUsers(
     public PageData<User> getCustomerUsers(
-            @PathVariable("customerId") String strCustomerId,
+            @ApiParam(value = CUSTOMER_ID_PARAM_DESCRIPTION, required = true)
+            @PathVariable(CUSTOMER_ID) String strCustomerId,
+            @ApiParam(value = PAGE_SIZE_DESCRIPTION, required = true)
             @RequestParam int pageSize,
             @RequestParam int pageSize,
+            @ApiParam(value = PAGE_NUMBER_DESCRIPTION, required = true)
             @RequestParam int page,
             @RequestParam int page,
+            @ApiParam(value = USER_TEXT_SEARCH_DESCRIPTION)
             @RequestParam(required = false) String textSearch,
             @RequestParam(required = false) String textSearch,
+            @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = USER_SORT_PROPERTY_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortProperty,
             @RequestParam(required = false) String sortProperty,
+            @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES)
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
             @RequestParam(required = false) String sortOrder) throws ThingsboardException {
         checkParameter("customerId", strCustomerId);
         checkParameter("customerId", strCustomerId);
         try {
         try {
@@ -331,11 +388,16 @@ public class UserController extends BaseController {
         }
         }
     }
     }
 
 
+    @ApiOperation(value = "Enable/Disable User credentials (setUserCredentialsEnabled)",
+            notes = "Enables or Disables user credentials. Useful when you would like to block user account without deleting it. " + PAGE_DATA_PARAMETERS + TENANT_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @RequestMapping(value = "/user/{userId}/userCredentialsEnabled", method = RequestMethod.POST)
     @RequestMapping(value = "/user/{userId}/userCredentialsEnabled", method = RequestMethod.POST)
     @ResponseBody
     @ResponseBody
-    public void setUserCredentialsEnabled(@PathVariable(USER_ID) String strUserId,
-                                          @RequestParam(required = false, defaultValue = "true") boolean userCredentialsEnabled) throws ThingsboardException {
+    public void setUserCredentialsEnabled(
+            @ApiParam(value = USER_ID_PARAM_DESCRIPTION)
+            @PathVariable(USER_ID) String strUserId,
+            @ApiParam(value = "Disable (\"true\") or enable (\"false\") the credentials.", defaultValue = "true")
+            @RequestParam(required = false, defaultValue = "true") boolean userCredentialsEnabled) throws ThingsboardException {
         checkParameter(USER_ID, strUserId);
         checkParameter(USER_ID, strUserId);
         try {
         try {
             UserId userId = new UserId(toUUID(strUserId));
             UserId userId = new UserId(toUUID(strUserId));

@@ -15,6 +15,10 @@
  */
  */
 package org.thingsboard.server.service.telemetry;
 package org.thingsboard.server.service.telemetry;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel
 public class AttributeData implements Comparable<AttributeData>{
 public class AttributeData implements Comparable<AttributeData>{
 
 
     private final long lastUpdateTs;
     private final long lastUpdateTs;
@@ -28,14 +32,17 @@ public class AttributeData implements Comparable<AttributeData>{
         this.value = value;
         this.value = value;
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "Timestamp last updated attribute, in milliseconds", example = "1609459200000", readOnly = true)
     public long getLastUpdateTs() {
     public long getLastUpdateTs() {
         return lastUpdateTs;
         return lastUpdateTs;
     }
     }
 
 
+    @ApiModelProperty(position = 2, value = "String representing attribute key", example = "active", readOnly = true)
     public String getKey() {
     public String getKey() {
         return key;
         return key;
     }
     }
 
 
+    @ApiModelProperty(position = 3, value = "Object representing value of attribute key", example = "false", readOnly = true)
     public Object getValue() {
     public Object getValue() {
         return value;
         return value;
     }
     }

@@ -15,6 +15,10 @@
  */
  */
 package org.thingsboard.server.service.telemetry;
 package org.thingsboard.server.service.telemetry;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel
 public class TsData implements Comparable<TsData>{
 public class TsData implements Comparable<TsData>{
 
 
     private final long ts;
     private final long ts;
@@ -26,10 +30,12 @@ public class TsData implements Comparable<TsData>{
         this.value = value;
         this.value = value;
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "Timestamp last updated timeseries, in milliseconds", example = "1609459200000", readOnly = true)
     public long getTs() {
     public long getTs() {
         return ts;
         return ts;
     }
     }
 
 
+    @ApiModelProperty(position = 2, value = "Object representing value of timeseries key", example = "20", readOnly = true)
     public Object getValue() {
     public Object getValue() {
         return value;
         return value;
     }
     }

@@ -18,6 +18,8 @@ package org.thingsboard.server.common.data;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonProperty.Access;
 import com.fasterxml.jackson.annotation.JsonProperty.Access;
+import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModelProperty;
 import org.thingsboard.server.common.data.id.CustomerId;
 import org.thingsboard.server.common.data.id.CustomerId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.validation.NoXss;
 import org.thingsboard.server.common.data.validation.NoXss;
@@ -27,7 +29,9 @@ public class Customer extends ContactBased<CustomerId> implements HasTenantId {
     private static final long serialVersionUID = -1599722990298929275L;
     private static final long serialVersionUID = -1599722990298929275L;
 
 
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 3, value = "Title of the customer", example = "Company A")
     private String title;
     private String title;
+    @ApiModelProperty(position = 5, required = true, value = "JSON object with Tenant Id")
     private TenantId tenantId;
     private TenantId tenantId;
 
 
     public Customer() {
     public Customer() {
@@ -51,7 +55,7 @@ public class Customer extends ContactBased<CustomerId> implements HasTenantId {
     public void setTenantId(TenantId tenantId) {
     public void setTenantId(TenantId tenantId) {
         this.tenantId = tenantId;
         this.tenantId = tenantId;
     }
     }
-    
+
     public String getTitle() {
     public String getTitle() {
         return title;
         return title;
     }
     }
@@ -60,6 +64,75 @@ public class Customer extends ContactBased<CustomerId> implements HasTenantId {
         this.title = title;
         this.title = title;
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the customer Id. " +
+            "Specify this field to update the customer. " +
+            "Referencing non-existing customer Id will cause error. " +
+            "Omit this field to create new customer." )
+    @Override
+    public CustomerId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the customer creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
+    @ApiModelProperty(position = 6, required = true, value = "Country", example = "US")
+    @Override
+    public String getCountry() {
+        return super.getCountry();
+    }
+
+    @ApiModelProperty(position = 7, required = true, value = "State", example = "NY")
+    @Override
+    public String getState() {
+        return super.getState();
+    }
+
+    @ApiModelProperty(position = 8, required = true, value = "City", example = "New York")
+    @Override
+    public String getCity() {
+        return super.getCity();
+    }
+
+    @ApiModelProperty(position = 9, required = true, value = "Address Line 1", example = "42 Broadway Suite 12-400")
+    @Override
+    public String getAddress() {
+        return super.getAddress();
+    }
+
+    @ApiModelProperty(position = 10, required = true, value = "Address Line 2", example = "")
+    @Override
+    public String getAddress2() {
+        return super.getAddress2();
+    }
+
+    @ApiModelProperty(position = 11, required = true, value = "Zip code", example = "10004")
+    @Override
+    public String getZip() {
+        return super.getZip();
+    }
+
+    @ApiModelProperty(position = 12, required = true, value = "Phone number", example = "+1(415)777-7777")
+    @Override
+    public String getPhone() {
+        return super.getPhone();
+    }
+
+    @ApiModelProperty(position = 13, required = true, value = "Email", example = "example@company.com")
+    @Override
+    public String getEmail() {
+        return super.getEmail();
+    }
+
+    @ApiModelProperty(position = 14, value = "Additional parameters of the device", dataType = "com.fasterxml.jackson.databind.JsonNode")
+    @Override
+    public JsonNode getAdditionalInfo() {
+        return super.getAdditionalInfo();
+    }
+
     @JsonIgnore
     @JsonIgnore
     public boolean isPublic() {
     public boolean isPublic() {
         if (getAdditionalInfo() != null && getAdditionalInfo().has("isPublic")) {
         if (getAdditionalInfo() != null && getAdditionalInfo().has("isPublic")) {
@@ -76,6 +149,7 @@ public class Customer extends ContactBased<CustomerId> implements HasTenantId {
 
 
     @Override
     @Override
     @JsonProperty(access = Access.READ_ONLY)
     @JsonProperty(access = Access.READ_ONLY)
+    @ApiModelProperty(position = 4, value = "Name of the customer. Read-only, duplicated from title for backward compatibility", example = "Company A", readOnly = true)
     public String getName() {
     public String getName() {
         return title;
         return title;
     }
     }

@@ -17,6 +17,8 @@ package org.thingsboard.server.common.data;
 
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
@@ -34,34 +36,51 @@ import java.io.IOException;
 
 
 import static org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo.mapper;
 import static org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo.mapper;
 
 
+@ApiModel
 @Data
 @Data
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 @Slf4j
 @Slf4j
 public class DeviceProfile extends SearchTextBased<DeviceProfileId> implements HasName, HasTenantId, HasOtaPackage {
 public class DeviceProfile extends SearchTextBased<DeviceProfileId> implements HasName, HasTenantId, HasOtaPackage {
 
 
+    @ApiModelProperty(position = 3, value = "JSON object with Tenant Id that owns the profile.", readOnly = true)
     private TenantId tenantId;
     private TenantId tenantId;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 4, value = "Unique Device Profile Name in scope of Tenant.", example = "Moisture Sensor")
     private String name;
     private String name;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 11, value = "Device Profile description. ")
     private String description;
     private String description;
+    @ApiModelProperty(position = 12, value = "Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view. ")
     private String image;
     private String image;
     private boolean isDefault;
     private boolean isDefault;
+    @ApiModelProperty(position = 16, value = "Type of the profile. Always 'DEFAULT' for now. Reserved for future use.")
     private DeviceProfileType type;
     private DeviceProfileType type;
+    @ApiModelProperty(position = 14, value = "Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT.")
     private DeviceTransportType transportType;
     private DeviceTransportType transportType;
+    @ApiModelProperty(position = 15, value = "Provisioning strategy.")
     private DeviceProfileProvisionType provisionType;
     private DeviceProfileProvisionType provisionType;
+    @ApiModelProperty(position = 7, value = "Reference to the rule chain. " +
+            "If present, the specified rule chain will be used to process all messages related to device, including telemetry, attribute updates, etc. " +
+            "Otherwise, the root rule chain will be used to process those messages.")
     private RuleChainId defaultRuleChainId;
     private RuleChainId defaultRuleChainId;
+    @ApiModelProperty(position = 6, value = "Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details.")
     private DashboardId defaultDashboardId;
     private DashboardId defaultDashboardId;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 8, value = "Reference to the rule engine queue. " +
+            "If present, the specified queue will be used to store all unprocessed messages related to device, including telemetry, attribute updates, etc. " +
+            "Otherwise, the 'Main' queue will be used to store those messages.")
     private String defaultQueueName;
     private String defaultQueueName;
     @Valid
     @Valid
     private transient DeviceProfileData profileData;
     private transient DeviceProfileData profileData;
     @JsonIgnore
     @JsonIgnore
     private byte[] profileDataBytes;
     private byte[] profileDataBytes;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 13, value = "Unique provisioning key used by 'Device Provisioning' feature.")
     private String provisionDeviceKey;
     private String provisionDeviceKey;
 
 
+    @ApiModelProperty(position = 9, value = "Reference to the firmware OTA package. If present, the specified package will be used as default device firmware. ")
     private OtaPackageId firmwareId;
     private OtaPackageId firmwareId;
-
+    @ApiModelProperty(position = 10, value = "Reference to the software OTA package. If present, the specified package will be used as default device software. ")
     private OtaPackageId softwareId;
     private OtaPackageId softwareId;
 
 
     public DeviceProfile() {
     public DeviceProfile() {
@@ -88,16 +107,32 @@ public class DeviceProfile extends SearchTextBased<DeviceProfileId> implements H
         this.softwareId = deviceProfile.getSoftwareId();
         this.softwareId = deviceProfile.getSoftwareId();
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the device profile Id. " +
+            "Specify this field to update the device profile. " +
+            "Referencing non-existing device profile Id will cause error. " +
+            "Omit this field to create new device profile.")
+    @Override
+    public DeviceProfileId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the profile creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
     @Override
     @Override
     public String getSearchText() {
     public String getSearchText() {
         return getName();
         return getName();
     }
     }
 
 
-    @Override
-    public String getName() {
-        return name;
+    @ApiModelProperty(position = 5, value = "Used to mark the default profile. Default profile is used when the device profile is not specified during device creation.")
+    public boolean isDefault(){
+        return isDefault;
     }
     }
 
 
+    @ApiModelProperty(position = 16, value = "Complex JSON object that includes addition device profile configuration (transport, alarm rules, etc).")
     public DeviceProfileData getProfileData() {
     public DeviceProfileData getProfileData() {
         if (profileData != null) {
         if (profileData != null) {
             return profileData;
             return profileData;

@@ -17,6 +17,7 @@ package org.thingsboard.server.common.data;
 
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
 import lombok.ToString;
 import lombok.Value;
 import lombok.Value;
@@ -31,9 +32,13 @@ import java.util.UUID;
 @ToString(callSuper = true)
 @ToString(callSuper = true)
 public class DeviceProfileInfo extends EntityInfo {
 public class DeviceProfileInfo extends EntityInfo {
 
 
+    @ApiModelProperty(position = 3, value = "Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view. ")
     private final String image;
     private final String image;
+    @ApiModelProperty(position = 4, value = "Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details.")
     private final DashboardId defaultDashboardId;
     private final DashboardId defaultDashboardId;
+    @ApiModelProperty(position = 5, value = "Type of the profile. Always 'DEFAULT' for now. Reserved for future use.")
     private final DeviceProfileType type;
     private final DeviceProfileType type;
+    @ApiModelProperty(position = 6, value = "Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT.")
     private final DeviceTransportType transportType;
     private final DeviceTransportType transportType;
 
 
     @JsonCreator
     @JsonCreator

@@ -17,6 +17,8 @@ package org.thingsboard.server.common.data;
 
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityIdFactory;
 import org.thingsboard.server.common.data.id.EntityIdFactory;
@@ -24,10 +26,13 @@ import org.thingsboard.server.common.data.id.HasId;
 
 
 import java.util.UUID;
 import java.util.UUID;
 
 
+@ApiModel
 @Data
 @Data
 public class EntityInfo implements HasId<EntityId>, HasName {
 public class EntityInfo implements HasId<EntityId>, HasName {
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the entity Id. ")
     private final EntityId id;
     private final EntityId id;
+    @ApiModelProperty(position = 2, value = "Entity Name")
     private final String name;
     private final String name;
 
 
     @JsonCreator
     @JsonCreator

@@ -16,6 +16,8 @@
 package org.thingsboard.server.common.data;
 package org.thingsboard.server.common.data;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EventId;
 import org.thingsboard.server.common.data.id.EventId;
@@ -25,12 +27,18 @@ import org.thingsboard.server.common.data.id.TenantId;
  * @author Andrew Shvayka
  * @author Andrew Shvayka
  */
  */
 @Data
 @Data
+@ApiModel
 public class Event extends BaseData<EventId> {
 public class Event extends BaseData<EventId> {
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with Tenant Id.", readOnly = true)
     private TenantId tenantId;
     private TenantId tenantId;
+    @ApiModelProperty(position = 2, value = "Event type", example = "STATS")
     private String type;
     private String type;
+    @ApiModelProperty(position = 3, value = "string", example = "784f394c-42b6-435a-983c-b7beff2784f9")
     private String uid;
     private String uid;
+    @ApiModelProperty(position = 4, value = "JSON object with Entity Id for which event is created.", readOnly = true)
     private EntityId entityId;
     private EntityId entityId;
+    @ApiModelProperty(position = 5, value = "Event body.", dataType = "com.fasterxml.jackson.databind.JsonNode")
     private transient JsonNode body;
     private transient JsonNode body;
 
 
     public Event() {
     public Event() {
@@ -45,4 +53,9 @@ public class Event extends BaseData<EventId> {
         super(event);
         super(event);
     }
     }
 
 
+    @ApiModelProperty(position = 6, value = "Timestamp of the event creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
 }
 }

@@ -17,20 +17,28 @@ package org.thingsboard.server.common.data;
 
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.TenantProfileId;
 import org.thingsboard.server.common.data.id.TenantProfileId;
 import org.thingsboard.server.common.data.validation.NoXss;
 import org.thingsboard.server.common.data.validation.NoXss;
 
 
+@ApiModel
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 public class Tenant extends ContactBased<TenantId> implements HasTenantId {
 public class Tenant extends ContactBased<TenantId> implements HasTenantId {
 
 
     private static final long serialVersionUID = 8057243243859922101L;
     private static final long serialVersionUID = 8057243243859922101L;
 
 
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 3, value = "Title of the tenant", example = "Company A")
     private String title;
     private String title;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 5, value = "Geo region of the tenant", example = "North America")
     private String region;
     private String region;
+
+    @ApiModelProperty(position = 6, required = true, value = "JSON object with Tenant Profile Id")
     private TenantProfileId tenantProfileId;
     private TenantProfileId tenantProfileId;
 
 
     public Tenant() {
     public Tenant() {
@@ -63,6 +71,7 @@ public class Tenant extends ContactBased<TenantId> implements HasTenantId {
     }
     }
 
 
     @Override
     @Override
+    @ApiModelProperty(position = 4, value = "Name of the tenant. Read-only, duplicated from title for backward compatibility", example = "Company A", readOnly = true)
     @JsonProperty(access = JsonProperty.Access.READ_ONLY)
     @JsonProperty(access = JsonProperty.Access.READ_ONLY)
     public String getName() {
     public String getName() {
         return title;
         return title;
@@ -89,6 +98,75 @@ public class Tenant extends ContactBased<TenantId> implements HasTenantId {
         return getTitle();
         return getTitle();
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the tenant Id. " +
+            "Specify this field to update the tenant. " +
+            "Referencing non-existing tenant Id will cause error. " +
+            "Omit this field to create new tenant." )
+    @Override
+    public TenantId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the tenant creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
+    @ApiModelProperty(position = 7, required = true, value = "Country", example = "US")
+    @Override
+    public String getCountry() {
+        return super.getCountry();
+    }
+
+    @ApiModelProperty(position = 8, required = true, value = "State", example = "NY")
+    @Override
+    public String getState() {
+        return super.getState();
+    }
+
+    @ApiModelProperty(position = 9, required = true, value = "City", example = "New York")
+    @Override
+    public String getCity() {
+        return super.getCity();
+    }
+
+    @ApiModelProperty(position = 10, required = true, value = "Address Line 1", example = "42 Broadway Suite 12-400")
+    @Override
+    public String getAddress() {
+        return super.getAddress();
+    }
+
+    @ApiModelProperty(position = 11, required = true, value = "Address Line 2", example = "")
+    @Override
+    public String getAddress2() {
+        return super.getAddress2();
+    }
+
+    @ApiModelProperty(position = 12, required = true, value = "Zip code", example = "10004")
+    @Override
+    public String getZip() {
+        return super.getZip();
+    }
+
+    @ApiModelProperty(position = 13, required = true, value = "Phone number", example = "+1(415)777-7777")
+    @Override
+    public String getPhone() {
+        return super.getPhone();
+    }
+
+    @ApiModelProperty(position = 14, required = true, value = "Email", example = "example@company.com")
+    @Override
+    public String getEmail() {
+        return super.getEmail();
+    }
+
+    @ApiModelProperty(position = 15, value = "Additional parameters of the device", dataType = "com.fasterxml.jackson.databind.JsonNode")
+    @Override
+    public JsonNode getAdditionalInfo() {
+        return super.getAdditionalInfo();
+    }
+
     @Override
     @Override
     public String toString() {
     public String toString() {
         StringBuilder builder = new StringBuilder();
         StringBuilder builder = new StringBuilder();

@@ -15,12 +15,15 @@
  */
  */
 package org.thingsboard.server.common.data;
 package org.thingsboard.server.common.data;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.TenantId;
 
 
+@ApiModel
 @Data
 @Data
 public class TenantInfo extends Tenant {
 public class TenantInfo extends Tenant {
-
+    @ApiModelProperty(position = 15, value = "Tenant Profile name", example = "Default")
     private String tenantProfileName;
     private String tenantProfileName;
 
 
     public TenantInfo() {
     public TenantInfo() {

@@ -17,6 +17,8 @@ package org.thingsboard.server.common.data;
 
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
@@ -31,18 +33,27 @@ import java.util.Optional;
 
 
 import static org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo.mapper;
 import static org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo.mapper;
 
 
+@ApiModel
 @Data
 @Data
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 @Slf4j
 @Slf4j
 public class TenantProfile extends SearchTextBased<TenantProfileId> implements HasName {
 public class TenantProfile extends SearchTextBased<TenantProfileId> implements HasName {
 
 
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 3, value = "Name of the tenant profile", example = "High Priority Tenants")
     private String name;
     private String name;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 4, value = "Description of the tenant profile", example = "Any text")
     private String description;
     private String description;
+    @ApiModelProperty(position = 5, value = "Default Tenant profile to be used.", example = "true")
     private boolean isDefault;
     private boolean isDefault;
+    @ApiModelProperty(position = 6, value = "If enabled, will push all messages related to this tenant and processed by core platform services into separate queue. " +
+            "Useful for complex microservices deployments, to isolate processing of the data for specific tenants", example = "true")
     private boolean isolatedTbCore;
     private boolean isolatedTbCore;
+    @ApiModelProperty(position = 7, value = "If enabled, will push all messages related to this tenant and processed by the rule engine into separate queue. " +
+            "Useful for complex microservices deployments, to isolate processing of the data for specific tenants", example = "true")
     private boolean isolatedTbRuleEngine;
     private boolean isolatedTbRuleEngine;
+    @ApiModelProperty(position = 8, value = "Complex JSON object that contains profile settings: max devices, max assets, rate limits, etc.")
     private transient TenantProfileData profileData;
     private transient TenantProfileData profileData;
     @JsonIgnore
     @JsonIgnore
     private byte[] profileDataBytes;
     private byte[] profileDataBytes;
@@ -65,6 +76,21 @@ public class TenantProfile extends SearchTextBased<TenantProfileId> implements H
         this.setProfileData(tenantProfile.getProfileData());
         this.setProfileData(tenantProfile.getProfileData());
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the tenant profile Id. " +
+            "Specify this field to update the tenant profile. " +
+            "Referencing non-existing tenant profile Id will cause error. " +
+            "Omit this field to create new tenant profile." )
+    @Override
+    public TenantProfileId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the tenant profile creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
     @Override
     @Override
     public String getSearchText() {
     public String getSearchText() {
         return getName();
         return getName();

@@ -17,6 +17,8 @@ package org.thingsboard.server.common.data.alarm;
 
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Data;
@@ -34,23 +36,41 @@ import java.util.List;
 /**
 /**
  * Created by ashvayka on 11.05.17.
  * Created by ashvayka on 11.05.17.
  */
  */
+@ApiModel
 @Data
 @Data
 @Builder
 @Builder
 @AllArgsConstructor
 @AllArgsConstructor
 public class Alarm extends BaseData<AlarmId> implements HasName, HasTenantId, HasCustomerId {
 public class Alarm extends BaseData<AlarmId> implements HasName, HasTenantId, HasCustomerId {
 
 
+    @ApiModelProperty(position = 3, value = "JSON object with Tenant Id", readOnly = true)
     private TenantId tenantId;
     private TenantId tenantId;
+
+    @ApiModelProperty(position = 4, value = "JSON object with Customer Id", readOnly = true)
     private CustomerId customerId;
     private CustomerId customerId;
+
+    @ApiModelProperty(position = 6, required = true, value = "representing type of the Alarm", example = "High Temperature Alarm")
     private String type;
     private String type;
+    @ApiModelProperty(position = 7, required = true, value = "JSON object with alarm originator id")
     private EntityId originator;
     private EntityId originator;
+    @ApiModelProperty(position = 8, required = true, value = "Alarm severity", example = "CRITICAL")
     private AlarmSeverity severity;
     private AlarmSeverity severity;
+    @ApiModelProperty(position = 9, required = true, value = "Alarm status", example = "CLEARED_UNACK")
     private AlarmStatus status;
     private AlarmStatus status;
+    @ApiModelProperty(position = 10, value = "Timestamp of the alarm start time, in milliseconds", example = "1634058704565")
     private long startTs;
     private long startTs;
+    @ApiModelProperty(position = 11, value = "Timestamp of the alarm end time(last time update), in milliseconds", example = "1634111163522")
     private long endTs;
     private long endTs;
+    @ApiModelProperty(position = 12, value = "Timestamp of the alarm acknowledgement, in milliseconds", example = "1634115221948")
     private long ackTs;
     private long ackTs;
+    @ApiModelProperty(position = 13, value = "Timestamp of the alarm clearing, in milliseconds", example = "1634114528465")
     private long clearTs;
     private long clearTs;
+    @ApiModelProperty(position = 14, value = "JSON object with alarm details")
     private transient JsonNode details;
     private transient JsonNode details;
+    @ApiModelProperty(position = 15, value = "Propagation flag to specify if alarm should be propagated to parent entities of alarm originator", example = "true")
     private boolean propagate;
     private boolean propagate;
+    @ApiModelProperty(position = 16, value = "JSON array of relation types that should be used for propagation. " +
+            "By default, 'propagateRelationTypes' array is empty which means that the alarm will propagate based on any relation type to parent entities. " +
+            "This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will ignoned.")
     private List<String> propagateRelationTypes;
     private List<String> propagateRelationTypes;
 
 
     public Alarm() {
     public Alarm() {
@@ -81,7 +101,25 @@ public class Alarm extends BaseData<AlarmId> implements HasName, HasTenantId, Ha
 
 
     @Override
     @Override
     @JsonProperty(access = JsonProperty.Access.READ_ONLY)
     @JsonProperty(access = JsonProperty.Access.READ_ONLY)
+    @ApiModelProperty(position = 5, required = true, value = "representing type of the Alarm", example = "High Temperature Alarm")
     public String getName() {
     public String getName() {
         return type;
         return type;
     }
     }
+
+    @ApiModelProperty(position = 1, value = "JSON object with the alarm Id. " +
+            "Specify this field to update the alarm. " +
+            "Referencing non-existing alarm Id will cause error. " +
+            "Omit this field to create new alarm." )
+    @Override
+    public AlarmId getId() {
+        return super.getId();
+    }
+
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the alarm creation, in milliseconds", example = "1634058704567", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
 }
 }

@@ -15,10 +15,15 @@
  */
  */
 package org.thingsboard.server.common.data.alarm;
 package org.thingsboard.server.common.data.alarm;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel
 public class AlarmInfo extends Alarm {
 public class AlarmInfo extends Alarm {
 
 
     private static final long serialVersionUID = 2807343093519543363L;
     private static final long serialVersionUID = 2807343093519543363L;
 
 
+    @ApiModelProperty(position = 17, value = "Alarm originator name", example = "Thermostat")
     private String originatorName;
     private String originatorName;
 
 
     public AlarmInfo() {
     public AlarmInfo() {

@@ -16,24 +16,37 @@
 package org.thingsboard.server.common.data.audit;
 package org.thingsboard.server.common.data.audit;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import org.thingsboard.server.common.data.BaseData;
 import org.thingsboard.server.common.data.BaseData;
 import org.thingsboard.server.common.data.id.*;
 import org.thingsboard.server.common.data.id.*;
 
 
+@ApiModel
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 @Data
 @Data
 public class AuditLog extends BaseData<AuditLogId> {
 public class AuditLog extends BaseData<AuditLogId> {
 
 
+    @ApiModelProperty(position = 3, value = "JSON object with Tenant Id", readOnly = true)
     private TenantId tenantId;
     private TenantId tenantId;
+    @ApiModelProperty(position = 4, value = "JSON object with Customer Id", readOnly = true)
     private CustomerId customerId;
     private CustomerId customerId;
+    @ApiModelProperty(position = 5, value = "JSON object with Entity id", readOnly = true)
     private EntityId entityId;
     private EntityId entityId;
+    @ApiModelProperty(position = 6, value = "Name of the logged entity", example = "Thermometer", readOnly = true)
     private String entityName;
     private String entityName;
+    @ApiModelProperty(position = 7, value = "JSON object with User id.", readOnly = true)
     private UserId userId;
     private UserId userId;
+    @ApiModelProperty(position = 8, value = "Unique user name(email) of the user that performed some action on logged entity", example = "tenant@thingsboard.org", readOnly = true)
     private String userName;
     private String userName;
+    @ApiModelProperty(position = 9, value = "String represented Action type", example = "ADDED", readOnly = true)
     private ActionType actionType;
     private ActionType actionType;
+    @ApiModelProperty(position = 10, value = "JsonNode represented action data", readOnly = true)
     private JsonNode actionData;
     private JsonNode actionData;
+    @ApiModelProperty(position = 11, value = "String represented Action status", example = "SUCCESS", allowableValues = "SUCCESS,FAILURE", readOnly = true)
     private ActionStatus actionStatus;
     private ActionStatus actionStatus;
+    @ApiModelProperty(position = 12, value = "Failure action details info. An empty string in case of action status type 'SUCCESS', otherwise includes stack trace of the caused exception.", readOnly = true)
     private String actionFailureDetails;
     private String actionFailureDetails;
 
 
     public AuditLog() {
     public AuditLog() {
@@ -57,4 +70,17 @@ public class AuditLog extends BaseData<AuditLogId> {
         this.actionStatus = auditLog.getActionStatus();
         this.actionStatus = auditLog.getActionStatus();
         this.actionFailureDetails = auditLog.getActionFailureDetails();
         this.actionFailureDetails = auditLog.getActionFailureDetails();
     }
     }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the auditLog creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
+    @ApiModelProperty(position = 1, value = "JSON object with the auditLog Id")
+    @Override
+    public AuditLogId getId() {
+        return super.getId();
+    }
+
 }
 }

+/**
+ * Copyright © 2016-2021 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.server.common.data.event;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+
+@ApiModel
+@Data
+public abstract class BaseEventFilter implements EventFilter {
+
+    @ApiModelProperty(position = 1, value = "String value representing msg direction type (incoming to entity or outcoming from entity)", allowableValues = "IN, OUT")
+    protected String msgDirectionType;
+    @ApiModelProperty(position = 2, value = "String value representing the server name, identifier or ip address where the platform is running", example = "ip-172-31-24-152")
+    protected String server;
+    @ApiModelProperty(position = 3, value = "The case insensitive 'contains' filter based on data (key and value) for the message.", example = "humidity")
+    protected String dataSearch;
+    @ApiModelProperty(position = 4, value = "The case insensitive 'contains' filter based on metadata (key and value) for the message.", example = "deviceName")
+    protected String metadataSearch;
+    @ApiModelProperty(position = 5, value = "String value representing the entity type", allowableValues = "DEVICE")
+    protected String entityName;
+    @ApiModelProperty(position = 6, value = "String value representing the type of message routing", example = "Success")
+    protected String relationType;
+    @ApiModelProperty(position = 7, value = "String value representing the entity id in the event body (originator of the message)", example = "de9d54a0-2b7a-11ec-a3cc-23386423d98f")
+    protected String entityId;
+    @ApiModelProperty(position = 8, value = "String value representing the message type", example = "POST_TELEMETRY_REQUEST")
+    protected String msgType;
+    @ApiModelProperty(position = 9, value = "Boolean value to filter the errors", allowableValues = "false, true")
+    protected boolean isError;
+    @ApiModelProperty(position = 10, value = "The case insensitive 'contains' filter based on error message", example = "not present in the DB")
+    protected String errorStr;
+    @ApiModelProperty(position = 11, value = "String value representing the method name when the error happened", example = "onClusterEventMsg")
+    protected String method;
+    @ApiModelProperty(position = 12, value = "The minimum number of successfully processed messages", example = "25")
+    protected Integer messagesProcessed;
+    @ApiModelProperty(position = 13, value = "The minimum number of errors occurred during messages processing", example = "30")
+    protected Integer errorsOccurred;
+    @ApiModelProperty(position = 14, value = "String value representing the lifecycle event type", example = "STARTED")
+    protected String event;
+    @ApiModelProperty(position = 15, value = "String value representing status of the lifecycle event", allowableValues = "Success, Failure")
+    protected String status;
+
+}

@@ -15,22 +15,11 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
 import org.thingsboard.server.common.data.StringUtils;
 import org.thingsboard.server.common.data.StringUtils;
 
 
-@Data
-public abstract class DebugEvent implements EventFilter {
-
-    private String msgDirectionType;
-    private String server;
-    private String dataSearch;
-    private String metadataSearch;
-    private String entityName;
-    private String relationType;
-    private String entityId;
-    private String msgType;
-    private boolean isError;
-    private String error;
+@ApiModel
+public abstract class DebugEvent extends BaseEventFilter implements EventFilter {
 
 
     public void setIsError(boolean isError) {
     public void setIsError(boolean isError) {
         this.isError = isError;
         this.isError = isError;
@@ -39,7 +28,7 @@ public abstract class DebugEvent implements EventFilter {
     @Override
     @Override
     public boolean hasFilterForJsonBody() {
     public boolean hasFilterForJsonBody() {
         return !StringUtils.isEmpty(msgDirectionType) || !StringUtils.isEmpty(server) || !StringUtils.isEmpty(dataSearch) || !StringUtils.isEmpty(metadataSearch)
         return !StringUtils.isEmpty(msgDirectionType) || !StringUtils.isEmpty(server) || !StringUtils.isEmpty(dataSearch) || !StringUtils.isEmpty(metadataSearch)
-                || !StringUtils.isEmpty(entityName) || !StringUtils.isEmpty(relationType) || !StringUtils.isEmpty(entityId) || !StringUtils.isEmpty(msgType) || !StringUtils.isEmpty(error) || isError;
+                || !StringUtils.isEmpty(entityName) || !StringUtils.isEmpty(relationType) || !StringUtils.isEmpty(entityId) || !StringUtils.isEmpty(msgType) || !StringUtils.isEmpty(errorStr) || isError;
     }
     }
 
 
 }
 }

@@ -15,6 +15,9 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
+import io.swagger.annotations.ApiModel;
+
+@ApiModel
 public class DebugRuleChainEventFilter extends DebugEvent {
 public class DebugRuleChainEventFilter extends DebugEvent {
     @Override
     @Override
     public EventType getEventType() {
     public EventType getEventType() {

@@ -15,6 +15,9 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
+import io.swagger.annotations.ApiModel;
+
+@ApiModel
 public class DebugRuleNodeEventFilter extends DebugEvent {
 public class DebugRuleNodeEventFilter extends DebugEvent {
     @Override
     @Override
     public EventType getEventType() {
     public EventType getEventType() {

@@ -15,14 +15,11 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
 import org.thingsboard.server.common.data.StringUtils;
 import org.thingsboard.server.common.data.StringUtils;
 
 
-@Data
-public class ErrorEventFilter implements EventFilter {
-    private String server;
-    private String method;
-    private String error;
+@ApiModel
+public class ErrorEventFilter extends BaseEventFilter implements EventFilter {
 
 
     @Override
     @Override
     public EventType getEventType() {
     public EventType getEventType() {
@@ -31,6 +28,6 @@ public class ErrorEventFilter implements EventFilter {
 
 
     @Override
     @Override
     public boolean hasFilterForJsonBody() {
     public boolean hasFilterForJsonBody() {
-        return !StringUtils.isEmpty(server) || !StringUtils.isEmpty(method) || !StringUtils.isEmpty(error);
+        return !StringUtils.isEmpty(server) || !StringUtils.isEmpty(method) || !StringUtils.isEmpty(errorStr);
     }
     }
 }
 }

@@ -15,11 +15,12 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 
 
+@ApiModel
 @JsonTypeInfo(
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,
         use = JsonTypeInfo.Id.NAME,
         include = JsonTypeInfo.As.PROPERTY,
         include = JsonTypeInfo.As.PROPERTY,
@@ -32,7 +33,8 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo;
         @JsonSubTypes.Type(value = StatisticsEventFilter.class, name = "STATS")
         @JsonSubTypes.Type(value = StatisticsEventFilter.class, name = "STATS")
 })
 })
 public interface EventFilter {
 public interface EventFilter {
-    @JsonIgnore
+
+    @ApiModelProperty(position = 1, required = true, value = "String value representing the event type", example = "STATS")
     EventType getEventType();
     EventType getEventType();
 
 
     boolean hasFilterForJsonBody();
     boolean hasFilterForJsonBody();

@@ -15,15 +15,11 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
 import org.thingsboard.server.common.data.StringUtils;
 import org.thingsboard.server.common.data.StringUtils;
 
 
-@Data
-public class LifeCycleEventFilter implements EventFilter {
-    private String server;
-    private String event;
-    private String status;
-    private String error;
+@ApiModel
+public class LifeCycleEventFilter extends BaseEventFilter implements EventFilter {
 
 
     @Override
     @Override
     public EventType getEventType() {
     public EventType getEventType() {
@@ -32,6 +28,6 @@ public class LifeCycleEventFilter implements EventFilter {
 
 
     @Override
     @Override
     public boolean hasFilterForJsonBody() {
     public boolean hasFilterForJsonBody() {
-        return !StringUtils.isEmpty(server) || !StringUtils.isEmpty(event) || !StringUtils.isEmpty(status) || !StringUtils.isEmpty(error);
+        return !StringUtils.isEmpty(server) || !StringUtils.isEmpty(event) || !StringUtils.isEmpty(status) || !StringUtils.isEmpty(errorStr);
     }
     }
 }
 }

@@ -15,14 +15,11 @@
  */
  */
 package org.thingsboard.server.common.data.event;
 package org.thingsboard.server.common.data.event;
 
 
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
 import org.thingsboard.server.common.data.StringUtils;
 import org.thingsboard.server.common.data.StringUtils;
 
 
-@Data
-public class StatisticsEventFilter implements EventFilter {
-    private String server;
-    private Integer messagesProcessed;
-    private Integer errorsOccurred;
+@ApiModel
+public class StatisticsEventFilter extends BaseEventFilter implements EventFilter {
 
 
     @Override
     @Override
     public EventType getEventType() {
     public EventType getEventType() {

@@ -18,6 +18,8 @@ package org.thingsboard.server.common.data.id;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.EntityType;
 
 
 import java.io.Serializable;
 import java.io.Serializable;
@@ -29,12 +31,15 @@ import java.util.UUID;
 
 
 @JsonDeserialize(using = EntityIdDeserializer.class)
 @JsonDeserialize(using = EntityIdDeserializer.class)
 @JsonSerialize(using = EntityIdSerializer.class)
 @JsonSerialize(using = EntityIdSerializer.class)
+@ApiModel
 public interface EntityId extends HasUUID, Serializable { //NOSONAR, the constant is closely related to EntityId
 public interface EntityId extends HasUUID, Serializable { //NOSONAR, the constant is closely related to EntityId
 
 
     UUID NULL_UUID = UUID.fromString("13814000-1dd2-11b2-8080-808080808080");
     UUID NULL_UUID = UUID.fromString("13814000-1dd2-11b2-8080-808080808080");
 
 
+    @ApiModelProperty(position = 1, required = true, value = "string", example = "784f394c-42b6-435a-983c-b7beff2784f9")
     UUID getId();
     UUID getId();
 
 
+    @ApiModelProperty(position = 2, required = true, value = "string", example = "DEVICE")
     EntityType getEntityType();
     EntityType getEntityType();
 
 
     @JsonIgnore
     @JsonIgnore

@@ -15,19 +15,36 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
-import lombok.*;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
 
 
 @Builder(toBuilder = true)
 @Builder(toBuilder = true)
 @EqualsAndHashCode
 @EqualsAndHashCode
 @Data
 @Data
 @ToString
 @ToString
+@ApiModel
 public class OAuth2BasicMapperConfig {
 public class OAuth2BasicMapperConfig {
+    @ApiModelProperty(value = "Email attribute key of OAuth2 principal attributes. " +
+            "Must be specified for BASIC mapper type and cannot be specified for GITHUB type")
     private final String emailAttributeKey;
     private final String emailAttributeKey;
+    @ApiModelProperty(value = "First name attribute key")
     private final String firstNameAttributeKey;
     private final String firstNameAttributeKey;
+    @ApiModelProperty(value = "Last name attribute key")
     private final String lastNameAttributeKey;
     private final String lastNameAttributeKey;
+    @ApiModelProperty(value = "Tenant naming strategy. For DOMAIN type, domain for tenant name will be taken from the email (substring before '@')", required = true)
     private final TenantNameStrategyType tenantNameStrategy;
     private final TenantNameStrategyType tenantNameStrategy;
+    @ApiModelProperty(value = "Tenant name pattern for CUSTOM naming strategy. " +
+            "OAuth2 attributes in the pattern can be used by enclosing attribute key in '%{' and '}'", example = "%{email}")
     private final String tenantNamePattern;
     private final String tenantNamePattern;
+    @ApiModelProperty(value = "Customer name pattern. When creating a user on the first OAuth2 log in, if specified, " +
+            "customer name will be used to create or find existing customer in the platform and assign customerId to the user")
     private final String customerNamePattern;
     private final String customerNamePattern;
+    @ApiModelProperty(value = "Name of the tenant's dashboard to set as default dashboard for newly created user")
     private final String defaultDashboardName;
     private final String defaultDashboardName;
+    @ApiModelProperty(value = "Whether default dashboard should be open in full screen")
     private final boolean alwaysFullScreen;
     private final boolean alwaysFullScreen;
 }
 }

@@ -15,19 +15,26 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.NoArgsConstructor;
-import lombok.AllArgsConstructor;
 
 
 @EqualsAndHashCode
 @EqualsAndHashCode
 @Data
 @Data
 @NoArgsConstructor
 @NoArgsConstructor
 @AllArgsConstructor
 @AllArgsConstructor
+@ApiModel
 public class OAuth2ClientInfo {
 public class OAuth2ClientInfo {
 
 
+    @ApiModelProperty(value = "OAuth2 client name", example = "GitHub")
     private String name;
     private String name;
+    @ApiModelProperty(value = "Name of the icon, displayed on OAuth2 log in button", example = "github-logo")
     private String icon;
     private String icon;
+    @ApiModelProperty(value = "URI for OAuth2 log in. On HTTP GET request to this URI, it redirects to the OAuth2 provider page",
+            example = "/oauth2/authorization/8352f191-2b4d-11ec-9ed1-cbf57c026ecc")
     private String url;
     private String url;
 
 
     public OAuth2ClientInfo(OAuth2ClientInfo oauth2ClientInfo) {
     public OAuth2ClientInfo(OAuth2ClientInfo oauth2ClientInfo) {
@@ -35,4 +42,5 @@ public class OAuth2ClientInfo {
         this.icon = oauth2ClientInfo.getIcon();
         this.icon = oauth2ClientInfo.getIcon();
         this.url = oauth2ClientInfo.getUrl();
         this.url = oauth2ClientInfo.getUrl();
     }
     }
+
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.NoArgsConstructor;
@@ -29,20 +31,34 @@ import java.util.List;
 @Data
 @Data
 @ToString
 @ToString
 @NoArgsConstructor
 @NoArgsConstructor
+@ApiModel
 public class OAuth2ClientRegistrationTemplate extends SearchTextBasedWithAdditionalInfo<OAuth2ClientRegistrationTemplateId> implements HasName {
 public class OAuth2ClientRegistrationTemplate extends SearchTextBasedWithAdditionalInfo<OAuth2ClientRegistrationTemplateId> implements HasName {
 
 
+    @ApiModelProperty(value = "OAuth2 provider identifier (e.g. its name)", required = true)
     private String providerId;
     private String providerId;
+    @ApiModelProperty(value = "Default config for mapping OAuth2 log in response to platform entities")
     private OAuth2MapperConfig mapperConfig;
     private OAuth2MapperConfig mapperConfig;
+    @ApiModelProperty(value = "Default authorization URI of the OAuth2 provider")
     private String authorizationUri;
     private String authorizationUri;
+    @ApiModelProperty(value = "Default access token URI of the OAuth2 provider")
     private String accessTokenUri;
     private String accessTokenUri;
+    @ApiModelProperty(value = "Default OAuth scopes that will be requested from OAuth2 platform")
     private List<String> scope;
     private List<String> scope;
+    @ApiModelProperty(value = "Default user info URI of the OAuth2 provider")
     private String userInfoUri;
     private String userInfoUri;
+    @ApiModelProperty(value = "Default name of the username attribute in OAuth2 provider log in response")
     private String userNameAttributeName;
     private String userNameAttributeName;
+    @ApiModelProperty(value = "Default JSON Web Key URI of the OAuth2 provider")
     private String jwkSetUri;
     private String jwkSetUri;
+    @ApiModelProperty(value = "Default client authentication method to use: 'BASIC' or 'POST'")
     private String clientAuthenticationMethod;
     private String clientAuthenticationMethod;
+    @ApiModelProperty(value = "Comment for OAuth2 provider")
     private String comment;
     private String comment;
+    @ApiModelProperty(value = "Default log in button icon for OAuth2 provider")
     private String loginButtonIcon;
     private String loginButtonIcon;
+    @ApiModelProperty(value = "Default OAuth2 provider label")
     private String loginButtonLabel;
     private String loginButtonLabel;
+    @ApiModelProperty(value = "Help link for OAuth2 provider")
     private String helpLink;
     private String helpLink;
 
 
     public OAuth2ClientRegistrationTemplate(OAuth2ClientRegistrationTemplate clientRegistrationTemplate) {
     public OAuth2ClientRegistrationTemplate(OAuth2ClientRegistrationTemplate clientRegistrationTemplate) {

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Data;
@@ -28,7 +30,10 @@ import lombok.ToString;
 @NoArgsConstructor
 @NoArgsConstructor
 @AllArgsConstructor
 @AllArgsConstructor
 @Builder
 @Builder
+@ApiModel
 public class OAuth2DomainInfo {
 public class OAuth2DomainInfo {
+    @ApiModelProperty(value = "Domain scheme. Mixed scheme means than both HTTP and HTTPS are going to be used", required = true)
     private SchemeType scheme;
     private SchemeType scheme;
+    @ApiModelProperty(value = "Domain name. Cannot be empty", required = true)
     private String name;
     private String name;
 }
 }

@@ -15,7 +15,14 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
-import lombok.*;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
 
 
 import java.util.List;
 import java.util.List;
 
 
@@ -25,7 +32,10 @@ import java.util.List;
 @Builder(toBuilder = true)
 @Builder(toBuilder = true)
 @NoArgsConstructor
 @NoArgsConstructor
 @AllArgsConstructor
 @AllArgsConstructor
+@ApiModel
 public class OAuth2Info {
 public class OAuth2Info {
+    @ApiModelProperty("Whether OAuth2 settings are enabled or not")
     private boolean enabled;
     private boolean enabled;
+    @ApiModelProperty(value = "List of configured OAuth2 clients. Cannot contain null values", required = true)
     private List<OAuth2ParamsInfo> oauth2ParamsInfos;
     private List<OAuth2ParamsInfo> oauth2ParamsInfos;
 }
 }

@@ -15,6 +15,7 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Builder;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
@@ -25,9 +26,14 @@ import lombok.ToString;
 @Data
 @Data
 @ToString
 @ToString
 public class OAuth2MapperConfig {
 public class OAuth2MapperConfig {
+    @ApiModelProperty(value = "Whether user should be created if not yet present on the platform after successful authentication")
     private boolean allowUserCreation;
     private boolean allowUserCreation;
+    @ApiModelProperty(value = "Whether user credentials should be activated when user is created after successful authentication")
     private boolean activateUser;
     private boolean activateUser;
+    @ApiModelProperty(value = "Type of OAuth2 mapper. Depending on this param, different mapper config fields must be specified", required = true)
     private MapperType type;
     private MapperType type;
+    @ApiModelProperty(value = "Mapper config for BASIC and GITHUB mapper types")
     private OAuth2BasicMapperConfig basic;
     private OAuth2BasicMapperConfig basic;
+    @ApiModelProperty(value = "Mapper config for CUSTOM mapper type")
     private OAuth2CustomMapperConfig custom;
     private OAuth2CustomMapperConfig custom;
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Data;
@@ -28,7 +30,10 @@ import lombok.ToString;
 @NoArgsConstructor
 @NoArgsConstructor
 @AllArgsConstructor
 @AllArgsConstructor
 @Builder
 @Builder
+@ApiModel
 public class OAuth2MobileInfo {
 public class OAuth2MobileInfo {
+    @ApiModelProperty(value = "Application package name. Cannot be empty", required = true)
     private String pkgName;
     private String pkgName;
+    @ApiModelProperty(value = "Application secret. The length must be at least 16 characters", required = true)
     private String appSecret;
     private String appSecret;
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Data;
@@ -30,10 +32,16 @@ import java.util.List;
 @Builder(toBuilder = true)
 @Builder(toBuilder = true)
 @NoArgsConstructor
 @NoArgsConstructor
 @AllArgsConstructor
 @AllArgsConstructor
+@ApiModel
 public class OAuth2ParamsInfo {
 public class OAuth2ParamsInfo {
 
 
+    @ApiModelProperty(value = "List of configured domains where OAuth2 platform will redirect a user after successful " +
+            "authentication. Cannot be empty. There have to be only one domain with specific name with scheme type 'MIXED'. " +
+            "Configured domains with the same name must have different scheme types", required = true)
     private List<OAuth2DomainInfo> domainInfos;
     private List<OAuth2DomainInfo> domainInfos;
+    @ApiModelProperty(value = "Mobile applications settings. Application package name must be unique within the list", required = true)
     private List<OAuth2MobileInfo> mobileInfos;
     private List<OAuth2MobileInfo> mobileInfos;
+    @ApiModelProperty(value = "List of OAuth2 provider settings. Cannot be empty", required = true)
     private List<OAuth2RegistrationInfo> clientRegistrations;
     private List<OAuth2RegistrationInfo> clientRegistrations;
 
 
 }
 }

@@ -16,7 +16,14 @@
 package org.thingsboard.server.common.data.oauth2;
 package org.thingsboard.server.common.data.oauth2;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
-import lombok.*;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
 
 
 import java.util.List;
 import java.util.List;
 
 
@@ -26,19 +33,34 @@ import java.util.List;
 @NoArgsConstructor
 @NoArgsConstructor
 @AllArgsConstructor
 @AllArgsConstructor
 @Builder
 @Builder
+@ApiModel
 public class OAuth2RegistrationInfo {
 public class OAuth2RegistrationInfo {
+    @ApiModelProperty(value = "Config for mapping OAuth2 log in response to platform entities", required = true)
     private OAuth2MapperConfig mapperConfig;
     private OAuth2MapperConfig mapperConfig;
+    @ApiModelProperty(value = "OAuth2 client ID. Cannot be empty", required = true)
     private String clientId;
     private String clientId;
+    @ApiModelProperty(value = "OAuth2 client secret. Cannot be empty", required = true)
     private String clientSecret;
     private String clientSecret;
+    @ApiModelProperty(value = "Authorization URI of the OAuth2 provider. Cannot be empty", required = true)
     private String authorizationUri;
     private String authorizationUri;
+    @ApiModelProperty(value = "Access token URI of the OAuth2 provider. Cannot be empty", required = true)
     private String accessTokenUri;
     private String accessTokenUri;
+    @ApiModelProperty(value = "OAuth scopes that will be requested from OAuth2 platform. Cannot be empty", required = true)
     private List<String> scope;
     private List<String> scope;
+    @ApiModelProperty(value = "User info URI of the OAuth2 provider")
     private String userInfoUri;
     private String userInfoUri;
+    @ApiModelProperty(value = "Name of the username attribute in OAuth2 provider response. Cannot be empty")
     private String userNameAttributeName;
     private String userNameAttributeName;
+    @ApiModelProperty(value = "JSON Web Key URI of the OAuth2 provider")
     private String jwkSetUri;
     private String jwkSetUri;
+    @ApiModelProperty(value = "Client authentication method to use: 'BASIC' or 'POST'. Cannot be empty", required = true)
     private String clientAuthenticationMethod;
     private String clientAuthenticationMethod;
+    @ApiModelProperty(value = "OAuth2 provider label. Cannot be empty", required = true)
     private String loginButtonLabel;
     private String loginButtonLabel;
+    @ApiModelProperty(value = "Log in button icon for OAuth2 provider")
     private String loginButtonIcon;
     private String loginButtonIcon;
+    @ApiModelProperty(value = "List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)")
     private List<PlatformType> platforms;
     private List<PlatformType> platforms;
+    @ApiModelProperty(value = "Additional info of OAuth2 client (e.g. providerName)", required = true)
     private JsonNode additionalInfo;
     private JsonNode additionalInfo;
 }
 }

@@ -15,11 +15,13 @@
  */
  */
 package org.thingsboard.server.common.data.query;
 package org.thingsboard.server.common.data.query;
 
 
+import io.swagger.annotations.ApiModel;
 import lombok.Getter;
 import lombok.Getter;
 
 
 import java.util.Collections;
 import java.util.Collections;
 import java.util.List;
 import java.util.List;
 
 
+@ApiModel
 public class EntityCountQuery {
 public class EntityCountQuery {
 
 
     @Getter
     @Getter

@@ -15,10 +15,12 @@
  */
  */
 package org.thingsboard.server.common.data.query;
 package org.thingsboard.server.common.data.query;
 
 
+import io.swagger.annotations.ApiModel;
 import lombok.Data;
 import lombok.Data;
 
 
 import java.io.Serializable;
 import java.io.Serializable;
 
 
+@ApiModel
 @Data
 @Data
 public class EntityKey implements Serializable {
 public class EntityKey implements Serializable {
     private final EntityKeyType type;
     private final EntityKeyType type;

@@ -15,10 +15,12 @@
  */
  */
 package org.thingsboard.server.common.data.query;
 package org.thingsboard.server.common.data.query;
 
 
+import io.swagger.annotations.ApiModel;
 import lombok.Data;
 import lombok.Data;
 
 
 import java.io.Serializable;
 import java.io.Serializable;
 
 
+@ApiModel
 @Data
 @Data
 public class KeyFilter implements Serializable {
 public class KeyFilter implements Serializable {
 
 

@@ -16,18 +16,17 @@
 package org.thingsboard.server.common.data.relation;
 package org.thingsboard.server.common.data.relation;
 
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo;
 import org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.EntityId;
 
 
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
 import java.io.Serializable;
 import java.io.Serializable;
 
 
 @Slf4j
 @Slf4j
+@ApiModel
 public class EntityRelation implements Serializable {
 public class EntityRelation implements Serializable {
 
 
     private static final long serialVersionUID = 2807343040519543363L;
     private static final long serialVersionUID = 2807343040519543363L;
@@ -72,6 +71,7 @@ public class EntityRelation implements Serializable {
         this.additionalInfo = entityRelation.getAdditionalInfo();
         this.additionalInfo = entityRelation.getAdditionalInfo();
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with [from] Entity Id.", readOnly = true)
     public EntityId getFrom() {
     public EntityId getFrom() {
         return from;
         return from;
     }
     }
@@ -80,6 +80,7 @@ public class EntityRelation implements Serializable {
         this.from = from;
         this.from = from;
     }
     }
 
 
+    @ApiModelProperty(position = 2, value = "JSON object with [to] Entity Id.", readOnly = true)
     public EntityId getTo() {
     public EntityId getTo() {
         return to;
         return to;
     }
     }
@@ -88,6 +89,7 @@ public class EntityRelation implements Serializable {
         this.to = to;
         this.to = to;
     }
     }
 
 
+    @ApiModelProperty(position = 3, value = "String value of relation type.", example = "Contains")
     public String getType() {
     public String getType() {
         return type;
         return type;
     }
     }
@@ -96,6 +98,7 @@ public class EntityRelation implements Serializable {
         this.type = type;
         this.type = type;
     }
     }
 
 
+    @ApiModelProperty(position = 4, value = "Represents the type group of the relation.", example = "COMMON")
     public RelationTypeGroup getTypeGroup() {
     public RelationTypeGroup getTypeGroup() {
         return typeGroup;
         return typeGroup;
     }
     }
@@ -104,6 +107,7 @@ public class EntityRelation implements Serializable {
         this.typeGroup = typeGroup;
         this.typeGroup = typeGroup;
     }
     }
 
 
+    @ApiModelProperty(position = 5, value = "Additional parameters of the relation", dataType = "com.fasterxml.jackson.databind.JsonNode")
     public JsonNode getAdditionalInfo() {
     public JsonNode getAdditionalInfo() {
         return SearchTextBasedWithAdditionalInfo.getJson(() -> additionalInfo, () -> additionalInfoBytes);
         return SearchTextBasedWithAdditionalInfo.getJson(() -> additionalInfo, () -> additionalInfoBytes);
     }
     }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.relation;
 package org.thingsboard.server.common.data.relation;
 
 
+import io.swagger.annotations.ApiModelProperty;
+
 public class EntityRelationInfo extends EntityRelation {
 public class EntityRelationInfo extends EntityRelation {
 
 
     private static final long serialVersionUID = 2807343097519543363L;
     private static final long serialVersionUID = 2807343097519543363L;
@@ -30,6 +32,7 @@ public class EntityRelationInfo extends EntityRelation {
         super(entityRelation);
         super(entityRelation);
     }
     }
 
 
+    @ApiModelProperty(position = 6, value = "Name of the entity for [from] direction.", readOnly = true, example = "A4B72CCDFF33")
     public String getFromName() {
     public String getFromName() {
         return fromName;
         return fromName;
     }
     }
@@ -38,6 +41,7 @@ public class EntityRelationInfo extends EntityRelation {
         this.fromName = fromName;
         this.fromName = fromName;
     }
     }
 
 
+    @ApiModelProperty(position = 7, value = "Name of the entity for [to] direction.", readOnly = true, example = "A4B72CCDFF35")
     public String getToName() {
     public String getToName() {
         return toName;
         return toName;
     }
     }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.relation;
 package org.thingsboard.server.common.data.relation;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
 import java.util.List;
 import java.util.List;
@@ -23,9 +25,12 @@ import java.util.List;
  * Created by ashvayka on 02.05.17.
  * Created by ashvayka on 02.05.17.
  */
  */
 @Data
 @Data
+@ApiModel
 public class EntityRelationsQuery {
 public class EntityRelationsQuery {
 
 
+    @ApiModelProperty(position = 2, value = "Main search parameters.")
     private RelationsSearchParameters parameters;
     private RelationsSearchParameters parameters;
+    @ApiModelProperty(position = 1, value = "Main filters.")
     private List<RelationEntityTypeFilter> filters;
     private List<RelationEntityTypeFilter> filters;
 
 
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.relation;
 package org.thingsboard.server.common.data.relation;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.Data;
 import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.EntityType;
@@ -26,9 +28,12 @@ import java.util.List;
  */
  */
 @Data
 @Data
 @AllArgsConstructor
 @AllArgsConstructor
+@ApiModel
 public class RelationEntityTypeFilter {
 public class RelationEntityTypeFilter {
 
 
+    @ApiModelProperty(position = 1, value = "Type of the relation between root entity and other entity (e.g. 'Contains' or 'Manages').", example = "Contains")
     private String relationType;
     private String relationType;
 
 
+    @ApiModelProperty(position = 2, value = "Array of entity types to filter the related entities (e.g. 'DEVICE', 'ASSET').")
     private List<EntityType> entityTypes;
     private List<EntityType> entityTypes;
 }
 }

@@ -15,6 +15,7 @@
  */
  */
 package org.thingsboard.server.common.data.relation;
 package org.thingsboard.server.common.data.relation;
 
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
@@ -33,7 +34,7 @@ import java.util.UUID;
 @AllArgsConstructor
 @AllArgsConstructor
 public class RelationsSearchParameters {
 public class RelationsSearchParameters {
 
 
-    @ApiModelProperty(position = 1, value = "Root entity id to start search from.")
+    @ApiModelProperty(position = 1, value = "Root entity id to start search from.", example = "784f394c-42b6-435a-983c-b7beff2784f9")
     private UUID rootId;
     private UUID rootId;
     @ApiModelProperty(position = 2, value = "Type of the root entity.")
     @ApiModelProperty(position = 2, value = "Type of the root entity.")
     private EntityType rootType;
     private EntityType rootType;
@@ -59,6 +60,7 @@ public class RelationsSearchParameters {
         this.fetchLastLevelOnly = fetchLastLevelOnly;
         this.fetchLastLevelOnly = fetchLastLevelOnly;
     }
     }
 
 
+    @JsonIgnore
     public EntityId getEntityId() {
     public EntityId getEntityId() {
         return EntityIdFactory.getByTypeAndUuid(rootType, rootId);
         return EntityIdFactory.getByTypeAndUuid(rootType, rootId);
     }
     }

@@ -16,6 +16,8 @@
 package org.thingsboard.server.common.data.rpc;
 package org.thingsboard.server.common.data.rpc;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import org.thingsboard.server.common.data.BaseData;
 import org.thingsboard.server.common.data.BaseData;
@@ -24,15 +26,24 @@ import org.thingsboard.server.common.data.id.DeviceId;
 import org.thingsboard.server.common.data.id.RpcId;
 import org.thingsboard.server.common.data.id.RpcId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.TenantId;
 
 
+@ApiModel
 @Data
 @Data
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 public class Rpc extends BaseData<RpcId> implements HasTenantId {
 public class Rpc extends BaseData<RpcId> implements HasTenantId {
+
+    @ApiModelProperty(position = 3, value = "JSON object with Tenant Id.", readOnly = true)
     private TenantId tenantId;
     private TenantId tenantId;
+    @ApiModelProperty(position = 4, value = "JSON object with Device Id.", readOnly = true)
     private DeviceId deviceId;
     private DeviceId deviceId;
+    @ApiModelProperty(position = 5, value = "Expiration time of the request.", readOnly = true)
     private long expirationTime;
     private long expirationTime;
+    @ApiModelProperty(position = 6, value = "The request body that will be used to send message to device.", readOnly = true)
     private JsonNode request;
     private JsonNode request;
+    @ApiModelProperty(position = 7, value = "The response from the device.", readOnly = true)
     private JsonNode response;
     private JsonNode response;
+    @ApiModelProperty(position = 8, value = "The current status of the RPC call.", readOnly = true)
     private RpcStatus status;
     private RpcStatus status;
+    @ApiModelProperty(position = 9, value = "Additional info used in the rule engine to process the updates to the RPC state.", readOnly = true)
     private JsonNode additionalInfo;
     private JsonNode additionalInfo;
 
 
     public Rpc() {
     public Rpc() {
@@ -53,4 +64,17 @@ public class Rpc extends BaseData<RpcId> implements HasTenantId {
         this.status = rpc.getStatus();
         this.status = rpc.getStatus();
         this.additionalInfo = rpc.getAdditionalInfo();
         this.additionalInfo = rpc.getAdditionalInfo();
     }
     }
+
+    @ApiModelProperty(position = 1, value = "JSON object with the rpc Id. Referencing non-existing rpc Id will cause error.")
+    @Override
+    public RpcId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the rpc creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
 }
 }

@@ -15,17 +15,21 @@
  */
  */
 package org.thingsboard.server.common.data.rule;
 package org.thingsboard.server.common.data.rule;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 
 
 import java.io.Serializable;
 import java.io.Serializable;
 
 
+@ApiModel
 @Data
 @Data
 @Slf4j
 @Slf4j
 public class DefaultRuleChainCreateRequest implements Serializable {
 public class DefaultRuleChainCreateRequest implements Serializable {
 
 
     private static final long serialVersionUID = 5600333716030561537L;
     private static final long serialVersionUID = 5600333716030561537L;
 
 
+    @ApiModelProperty(position = 1, required = true, value = "Name of the new rule chain", example = "Root Rule Chain")
     private String name;
     private String name;
 
 
 }
 }

@@ -15,14 +15,20 @@
  */
  */
 package org.thingsboard.server.common.data.rule;
 package org.thingsboard.server.common.data.rule;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
 /**
 /**
  * Created by ashvayka on 21.03.18.
  * Created by ashvayka on 21.03.18.
  */
  */
+@ApiModel
 @Data
 @Data
 public class NodeConnectionInfo {
 public class NodeConnectionInfo {
+    @ApiModelProperty(position = 1, required = true, value = "Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'from' part of the connection.")
     private int fromIndex;
     private int fromIndex;
+    @ApiModelProperty(position = 2, required = true, value = "Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'to' part of the connection.")
     private int toIndex;
     private int toIndex;
+    @ApiModelProperty(position = 3, required = true, value = "Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure'")
     private String type;
     private String type;
 }
 }

@@ -17,6 +17,8 @@ package org.thingsboard.server.common.data.rule;
 
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
@@ -28,6 +30,7 @@ import org.thingsboard.server.common.data.id.RuleNodeId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.validation.NoXss;
 import org.thingsboard.server.common.data.validation.NoXss;
 
 
+@ApiModel
 @Data
 @Data
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 @Slf4j
 @Slf4j
@@ -35,13 +38,20 @@ public class RuleChain extends SearchTextBasedWithAdditionalInfo<RuleChainId> im
 
 
     private static final long serialVersionUID = -5656679015121935465L;
     private static final long serialVersionUID = -5656679015121935465L;
 
 
+    @ApiModelProperty(position = 3, required = true, value = "JSON object with Tenant Id.", readOnly = true)
     private TenantId tenantId;
     private TenantId tenantId;
     @NoXss
     @NoXss
+    @ApiModelProperty(position = 4, required = true, value = "Rule Chain name", example = "Humidity data processing")
     private String name;
     private String name;
+    @ApiModelProperty(position = 5, value = "Rule Chain type. 'EDGE' rule chains are processing messages on the edge devices only.", example = "A4B72CCDFF33")
     private RuleChainType type;
     private RuleChainType type;
+    @ApiModelProperty(position = 6, value = "JSON object with Rule Chain Id. Pointer to the first rule node that should receive all messages pushed to this rule chain.")
     private RuleNodeId firstRuleNodeId;
     private RuleNodeId firstRuleNodeId;
+    @ApiModelProperty(position = 7, value = "Indicates root rule chain. The root rule chain process messages from all devices and entities by default. User may configure default rule chain per device profile.")
     private boolean root;
     private boolean root;
+    @ApiModelProperty(position = 8, value = "Reserved for future usage.")
     private boolean debugMode;
     private boolean debugMode;
+    @ApiModelProperty(position = 9, value = "Reserved for future usage. The actual list of rule nodes and their relations is stored in the database separately.")
     private transient JsonNode configuration;
     private transient JsonNode configuration;
 
 
     @JsonIgnore
     @JsonIgnore
@@ -75,6 +85,21 @@ public class RuleChain extends SearchTextBasedWithAdditionalInfo<RuleChainId> im
         return name;
         return name;
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the Rule Chain Id. " +
+            "Specify this field to update the Rule Chain. " +
+            "Referencing non-existing Rule Chain Id will cause error. " +
+            "Omit this field to create new rule chain." )
+    @Override
+    public RuleChainId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the rule chain creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
     public JsonNode getConfiguration() {
     public JsonNode getConfiguration() {
         return SearchTextBasedWithAdditionalInfo.getJson(() -> configuration, () -> configurationBytes);
         return SearchTextBasedWithAdditionalInfo.getJson(() -> configuration, () -> configurationBytes);
     }
     }
@@ -82,4 +107,5 @@ public class RuleChain extends SearchTextBasedWithAdditionalInfo<RuleChainId> im
     public void setConfiguration(JsonNode data) {
     public void setConfiguration(JsonNode data) {
         setJson(data, json -> this.configuration = json, bytes -> this.configurationBytes = bytes);
         setJson(data, json -> this.configuration = json, bytes -> this.configurationBytes = bytes);
     }
     }
+
 }
 }

@@ -16,16 +16,23 @@
 package org.thingsboard.server.common.data.rule;
 package org.thingsboard.server.common.data.rule;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import org.thingsboard.server.common.data.id.RuleChainId;
 import org.thingsboard.server.common.data.id.RuleChainId;
 
 
 /**
 /**
  * Created by ashvayka on 21.03.18.
  * Created by ashvayka on 21.03.18.
  */
  */
+@ApiModel
 @Data
 @Data
 public class RuleChainConnectionInfo {
 public class RuleChainConnectionInfo {
+    @ApiModelProperty(position = 1, required = true, value = "Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'from' part of the connection.")
     private int fromIndex;
     private int fromIndex;
+    @ApiModelProperty(position = 2, required = true, value = "JSON object with the Rule Chain Id.")
     private RuleChainId targetRuleChainId;
     private RuleChainId targetRuleChainId;
+    @ApiModelProperty(position = 3, required = true, value = "JSON object with the additional information about the connection.")
     private JsonNode additionalInfo;
     private JsonNode additionalInfo;
+    @ApiModelProperty(position = 4, required = true, value = "Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure'")
     private String type;
     private String type;
 }
 }

@@ -15,13 +15,18 @@
  */
  */
 package org.thingsboard.server.common.data.rule;
 package org.thingsboard.server.common.data.rule;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
 import java.util.List;
 import java.util.List;
 
 
+@ApiModel
 @Data
 @Data
 public class RuleChainData {
 public class RuleChainData {
 
 
+    @ApiModelProperty(position = 1, required = true, value = "List of the Rule Chain objects.", readOnly = true)
     List<RuleChain> ruleChains;
     List<RuleChain> ruleChains;
+    @ApiModelProperty(position = 2, required = true, value = "List of the Rule Chain metadata objects.", readOnly = true)
     List<RuleChainMetaData> metadata;
     List<RuleChainMetaData> metadata;
 }
 }

@@ -16,6 +16,8 @@
 package org.thingsboard.server.common.data.rule;
 package org.thingsboard.server.common.data.rule;
 
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import org.thingsboard.server.common.data.id.RuleChainId;
 import org.thingsboard.server.common.data.id.RuleChainId;
 
 
@@ -25,17 +27,23 @@ import java.util.List;
 /**
 /**
  * Created by igor on 3/13/18.
  * Created by igor on 3/13/18.
  */
  */
+@ApiModel
 @Data
 @Data
 public class RuleChainMetaData {
 public class RuleChainMetaData {
 
 
+    @ApiModelProperty(position = 1, required = true, value = "JSON object with Rule Chain Id.", readOnly = true)
     private RuleChainId ruleChainId;
     private RuleChainId ruleChainId;
 
 
+    @ApiModelProperty(position = 2, required = true, value = "Index of the first rule node in the 'nodes' list")
     private Integer firstNodeIndex;
     private Integer firstNodeIndex;
 
 
+    @ApiModelProperty(position = 3, required = true, value = "List of rule node JSON objects")
     private List<RuleNode> nodes;
     private List<RuleNode> nodes;
 
 
+    @ApiModelProperty(position = 4, required = true, value = "List of JSON objects that represent connections between rule nodes")
     private List<NodeConnectionInfo> connections;
     private List<NodeConnectionInfo> connections;
 
 
+    @ApiModelProperty(position = 5, required = true, value = "List of JSON objects that represent connections between rule nodes and other rule chains.")
     private List<RuleChainConnectionInfo> ruleChainConnections;
     private List<RuleChainConnectionInfo> ruleChainConnections;
 
 
     public void addConnectionInfo(int fromIndex, int toIndex, String type) {
     public void addConnectionInfo(int fromIndex, int toIndex, String type) {

@@ -17,6 +17,8 @@ package org.thingsboard.server.common.data.rule;
 
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
@@ -25,6 +27,7 @@ import org.thingsboard.server.common.data.SearchTextBasedWithAdditionalInfo;
 import org.thingsboard.server.common.data.id.RuleChainId;
 import org.thingsboard.server.common.data.id.RuleChainId;
 import org.thingsboard.server.common.data.id.RuleNodeId;
 import org.thingsboard.server.common.data.id.RuleNodeId;
 
 
+@ApiModel
 @Data
 @Data
 @EqualsAndHashCode(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 @Slf4j
 @Slf4j
@@ -32,10 +35,15 @@ public class RuleNode extends SearchTextBasedWithAdditionalInfo<RuleNodeId> impl
 
 
     private static final long serialVersionUID = -5656679015121235465L;
     private static final long serialVersionUID = -5656679015121235465L;
 
 
+    @ApiModelProperty(position = 3, value = "JSON object with the Rule Chain Id. ", readOnly = true)
     private RuleChainId ruleChainId;
     private RuleChainId ruleChainId;
+    @ApiModelProperty(position = 4, value = "Full Java Class Name of the rule node implementation. ", example = "com.mycompany.iot.rule.engine.ProcessingNode")
     private String type;
     private String type;
+    @ApiModelProperty(position = 5, value = "User defined name of the rule node. Used on UI and for logging. ", example = "Process sensor reading")
     private String name;
     private String name;
+    @ApiModelProperty(position = 6, value = "Enable/disable debug. ", example = "false")
     private boolean debugMode;
     private boolean debugMode;
+    @ApiModelProperty(position = 7, value = "JSON with the rule node configuration. Structure depends on the rule node implementation.", dataType = "com.fasterxml.jackson.databind.JsonNode")
     private transient JsonNode configuration;
     private transient JsonNode configuration;
     @JsonIgnore
     @JsonIgnore
     private byte[] configurationBytes;
     private byte[] configurationBytes;
@@ -75,4 +83,25 @@ public class RuleNode extends SearchTextBasedWithAdditionalInfo<RuleNodeId> impl
         setJson(data, json -> this.configuration = json, bytes -> this.configurationBytes = bytes);
         setJson(data, json -> this.configuration = json, bytes -> this.configurationBytes = bytes);
     }
     }
 
 
+    @ApiModelProperty(position = 1, value = "JSON object with the Rule Node Id. " +
+            "Specify this field to update the Rule Node. " +
+            "Referencing non-existing Rule Node Id will cause error. " +
+            "Omit this field to create new rule node." )
+    @Override
+    public RuleNodeId getId() {
+        return super.getId();
+    }
+
+    @ApiModelProperty(position = 2, value = "Timestamp of the rule node creation, in milliseconds", example = "1609459200000", readOnly = true)
+    @Override
+    public long getCreatedTime() {
+        return super.getCreatedTime();
+    }
+
+    @ApiModelProperty(position = 8, value = "Additional parameters of the rule node. Contains 'layoutX' and 'layoutY' properties for visualization.", dataType = "com.fasterxml.jackson.databind.JsonNode")
+    @Override
+    public JsonNode getAdditionalInfo() {
+        return super.getAdditionalInfo();
+    }
+
 }
 }

@@ -15,6 +15,8 @@
  */
  */
 package org.thingsboard.server.common.data.tenant.profile;
 package org.thingsboard.server.common.data.tenant.profile;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Builder;
 import lombok.Data;
 import lombok.Data;

@@ -19,6 +19,7 @@ import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import io.swagger.annotations.ApiModel;
 import org.thingsboard.server.common.data.ApiUsageRecordKey;
 import org.thingsboard.server.common.data.ApiUsageRecordKey;
 import org.thingsboard.server.common.data.TenantProfileType;
 import org.thingsboard.server.common.data.TenantProfileType;
 
 

@@ -15,11 +15,15 @@
  */
  */
 package org.thingsboard.server.common.data.tenant.profile;
 package org.thingsboard.server.common.data.tenant.profile;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
+@ApiModel
 @Data
 @Data
 public class TenantProfileData {
 public class TenantProfileData {
 
 
+    @ApiModelProperty(position = 1, value = "Complex JSON object that contains profile settings: max devices, max assets, rate limits, etc.")
     private TenantProfileConfiguration configuration;
     private TenantProfileConfiguration configuration;
 
 
 }
 }

@@ -15,7 +15,6 @@
  */
  */
 package org.thingsboard.server.dao.model.sql;
 package org.thingsboard.server.dao.model.sql;
 
 
-import com.datastax.oss.driver.api.core.uuid.Uuids;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonNode;
 import lombok.Data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.EqualsAndHashCode;
@@ -40,15 +39,14 @@ import javax.persistence.Table;
 import java.util.UUID;
 import java.util.UUID;
 
 
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_ACTION_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_ACTION_PROPERTY;
+import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_BODY_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_COLUMN_FAMILY_NAME;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_COLUMN_FAMILY_NAME;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_EDGE_ID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_EDGE_ID_PROPERTY;
-import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_BODY_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_ENTITY_ID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_ENTITY_ID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_TENANT_ID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_TENANT_ID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_TYPE_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_TYPE_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_UID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_UID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.EPOCH_DIFF;
 import static org.thingsboard.server.dao.model.ModelConstants.EPOCH_DIFF;
-import static org.thingsboard.server.dao.model.ModelConstants.EVENT_UID_PROPERTY;
 import static org.thingsboard.server.dao.model.ModelConstants.TS_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.TS_COLUMN;
 
 
 @Data
 @Data

@@ -16,6 +16,7 @@
 package org.thingsboard.server.dao.oauth2;
 package org.thingsboard.server.dao.oauth2;
 
 
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.collections.CollectionUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 import org.springframework.stereotype.Service;
 import org.springframework.util.StringUtils;
 import org.springframework.util.StringUtils;
@@ -224,7 +225,7 @@ public class OAuth2ServiceImpl extends AbstractEntityService implements OAuth2Se
                 if (StringUtils.isEmpty(clientRegistration.getAccessTokenUri())) {
                 if (StringUtils.isEmpty(clientRegistration.getAccessTokenUri())) {
                     throw new DataValidationException("Token uri should be specified!");
                     throw new DataValidationException("Token uri should be specified!");
                 }
                 }
-                if (StringUtils.isEmpty(clientRegistration.getScope())) {
+                if (CollectionUtils.isEmpty(clientRegistration.getScope())) {
                     throw new DataValidationException("Scope should be specified!");
                     throw new DataValidationException("Scope should be specified!");
                 }
                 }
                 if (StringUtils.isEmpty(clientRegistration.getUserNameAttributeName())) {
                 if (StringUtils.isEmpty(clientRegistration.getUserNameAttributeName())) {

@@ -552,6 +552,9 @@ public class BaseRuleChainService extends AbstractEntityService implements RuleC
         if (!edge.getTenantId().equals(ruleChain.getTenantId())) {
         if (!edge.getTenantId().equals(ruleChain.getTenantId())) {
             throw new DataValidationException("Can't assign ruleChain to edge from different tenant!");
             throw new DataValidationException("Can't assign ruleChain to edge from different tenant!");
         }
         }
+        if (!RuleChainType.EDGE.equals(ruleChain.getType())) {
+            throw new DataValidationException("Can't assign non EDGE ruleChain to edge!");
+        }
         try {
         try {
             createRelation(tenantId, new EntityRelation(edgeId, ruleChainId, EntityRelation.CONTAINS_TYPE, RelationTypeGroup.EDGE));
             createRelation(tenantId, new EntityRelation(edgeId, ruleChainId, EntityRelation.CONTAINS_TYPE, RelationTypeGroup.EDGE));
         } catch (Exception e) {
         } catch (Exception e) {

@@ -31,10 +31,12 @@ public interface EdgeEventRepository extends PagingAndSortingRepository<EdgeEven
             "e.tenantId = :tenantId " +
             "e.tenantId = :tenantId " +
             "AND e.edgeId = :edgeId " +
             "AND e.edgeId = :edgeId " +
             "AND (:startTime IS NULL OR e.createdTime >= :startTime) " +
             "AND (:startTime IS NULL OR e.createdTime >= :startTime) " +
-            "AND (:endTime IS NULL OR e.createdTime <= :endTime) "
+            "AND (:endTime IS NULL OR e.createdTime <= :endTime) " +
+            "AND LOWER(e.edgeEventType) LIKE LOWER(CONCAT(:textSearch, '%'))"
     )
     )
     Page<EdgeEventEntity> findEdgeEventsByTenantIdAndEdgeId(@Param("tenantId") UUID tenantId,
     Page<EdgeEventEntity> findEdgeEventsByTenantIdAndEdgeId(@Param("tenantId") UUID tenantId,
                                                             @Param("edgeId") UUID edgeId,
                                                             @Param("edgeId") UUID edgeId,
+                                                            @Param("textSearch") String textSearch,
                                                             @Param("startTime") Long startTime,
                                                             @Param("startTime") Long startTime,
                                                             @Param("endTime") Long endTime,
                                                             @Param("endTime") Long endTime,
                                                             Pageable pageable);
                                                             Pageable pageable);
@@ -44,10 +46,12 @@ public interface EdgeEventRepository extends PagingAndSortingRepository<EdgeEven
             "AND e.edgeId = :edgeId " +
             "AND e.edgeId = :edgeId " +
             "AND (:startTime IS NULL OR e.createdTime >= :startTime) " +
             "AND (:startTime IS NULL OR e.createdTime >= :startTime) " +
             "AND (:endTime IS NULL OR e.createdTime <= :endTime) " +
             "AND (:endTime IS NULL OR e.createdTime <= :endTime) " +
-            "AND e.edgeEventAction <> 'TIMESERIES_UPDATED'"
+            "AND e.edgeEventAction <> 'TIMESERIES_UPDATED' " +
+            "AND LOWER(e.edgeEventType) LIKE LOWER(CONCAT(:textSearch, '%'))"
     )
     )
     Page<EdgeEventEntity> findEdgeEventsByTenantIdAndEdgeIdWithoutTimeseriesUpdated(@Param("tenantId") UUID tenantId,
     Page<EdgeEventEntity> findEdgeEventsByTenantIdAndEdgeIdWithoutTimeseriesUpdated(@Param("tenantId") UUID tenantId,
                                                                                     @Param("edgeId") UUID edgeId,
                                                                                     @Param("edgeId") UUID edgeId,
+                                                                                    @Param("textSearch") String textSearch,
                                                                                     @Param("startTime") Long startTime,
                                                                                     @Param("startTime") Long startTime,
                                                                                     @Param("endTime") Long endTime,
                                                                                     @Param("endTime") Long endTime,
                                                                                     Pageable pageable);
                                                                                     Pageable pageable);

@@ -39,6 +39,7 @@ import java.sql.Connection;
 import java.sql.PreparedStatement;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.SQLException;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Optional;
 import java.util.UUID;
 import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentHashMap;
@@ -107,6 +108,7 @@ public class JpaBaseEdgeEventDao extends JpaAbstractSearchTextDao<EdgeEventEntit
                                 .findEdgeEventsByTenantIdAndEdgeId(
                                 .findEdgeEventsByTenantIdAndEdgeId(
                                         tenantId,
                                         tenantId,
                                         edgeId.getId(),
                                         edgeId.getId(),
+                                        Objects.toString(pageLink.getTextSearch(), ""),
                                         pageLink.getStartTime(),
                                         pageLink.getStartTime(),
                                         pageLink.getEndTime(),
                                         pageLink.getEndTime(),
                                         DaoUtil.toPageable(pageLink)));
                                         DaoUtil.toPageable(pageLink)));
@@ -116,6 +118,7 @@ public class JpaBaseEdgeEventDao extends JpaAbstractSearchTextDao<EdgeEventEntit
                                 .findEdgeEventsByTenantIdAndEdgeIdWithoutTimeseriesUpdated(
                                 .findEdgeEventsByTenantIdAndEdgeIdWithoutTimeseriesUpdated(
                                         tenantId,
                                         tenantId,
                                         edgeId.getId(),
                                         edgeId.getId(),
+                                        Objects.toString(pageLink.getTextSearch(), ""),
                                         pageLink.getStartTime(),
                                         pageLink.getStartTime(),
                                         pageLink.getEndTime(),
                                         pageLink.getEndTime(),
                                         DaoUtil.toPageable(pageLink)));
                                         DaoUtil.toPageable(pageLink)));

@@ -39,10 +39,6 @@ import org.thingsboard.server.dao.event.EventDao;
 import org.thingsboard.server.dao.model.sql.EventEntity;
 import org.thingsboard.server.dao.model.sql.EventEntity;
 import org.thingsboard.server.dao.sql.JpaAbstractDao;
 import org.thingsboard.server.dao.sql.JpaAbstractDao;
 
 
-import java.sql.Connection;
-import java.sql.PreparedStatement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
 import java.util.List;
 import java.util.List;
 import java.util.Objects;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Optional;
@@ -196,7 +192,7 @@ public class JpaBaseEventDao extends JpaAbstractDao<EventEntity, Event> implemen
                         eventFilter.getEntityId(),
                         eventFilter.getEntityId(),
                         eventFilter.getMsgType(),
                         eventFilter.getMsgType(),
                         eventFilter.isError(),
                         eventFilter.isError(),
-                        eventFilter.getError(),
+                        eventFilter.getErrorStr(),
                         eventFilter.getDataSearch(),
                         eventFilter.getDataSearch(),
                         eventFilter.getMetadataSearch(),
                         eventFilter.getMetadataSearch(),
                         DaoUtil.toPageable(pageLink)));
                         DaoUtil.toPageable(pageLink)));
@@ -212,7 +208,7 @@ public class JpaBaseEventDao extends JpaAbstractDao<EventEntity, Event> implemen
                         notNull(pageLink.getEndTime()),
                         notNull(pageLink.getEndTime()),
                         eventFilter.getServer(),
                         eventFilter.getServer(),
                         eventFilter.getMethod(),
                         eventFilter.getMethod(),
-                        eventFilter.getError(),
+                        eventFilter.getErrorStr(),
                         DaoUtil.toPageable(pageLink))
                         DaoUtil.toPageable(pageLink))
         );
         );
     }
     }
@@ -231,7 +227,7 @@ public class JpaBaseEventDao extends JpaAbstractDao<EventEntity, Event> implemen
                         eventFilter.getEvent(),
                         eventFilter.getEvent(),
                         statusFilterEnabled,
                         statusFilterEnabled,
                         statusFilter,
                         statusFilter,
-                        eventFilter.getError(),
+                        eventFilter.getErrorStr(),
                         DaoUtil.toPageable(pageLink))
                         DaoUtil.toPageable(pageLink))
         );
         );
     }
     }

@@ -44,10 +44,10 @@
           {{ 'event.has-error' | translate }}
           {{ 'event.has-error' | translate }}
         </tb-checkbox>
         </tb-checkbox>
       </ng-template>
       </ng-template>
-      <ng-template [ngSwitchCase]="'error'">
+      <ng-template [ngSwitchCase]="'errorStr'">
         <mat-form-field fxHide [fxShow]="showErrorMsgFields()">
         <mat-form-field fxHide [fxShow]="showErrorMsgFields()">
           <mat-label>{{ column.title | translate}}</mat-label>
           <mat-label>{{ column.title | translate}}</mat-label>
-          <input matInput type="text" name="errorSearchText" formControlName="error">
+          <input matInput type="text" name="errorSearchText" formControlName="errorStr">
         </mat-form-field>
         </mat-form-field>
       </ng-template>
       </ng-template>
       <ng-container *ngSwitchDefault>
       <ng-container *ngSwitchDefault>

@@ -292,14 +292,14 @@ export class EventTableConfig extends EntityTableConfig<Event, TimePageLink> {
       case EventType.ERROR:
       case EventType.ERROR:
         this.filterColumns.push(
         this.filterColumns.push(
           {key: 'method', title: 'event.method'},
           {key: 'method', title: 'event.method'},
-          {key: 'error', title: 'event.error'}
+          {key: 'errorStr', title: 'event.error'}
         );
         );
         break;
         break;
       case EventType.LC_EVENT:
       case EventType.LC_EVENT:
         this.filterColumns.push(
         this.filterColumns.push(
           {key: 'event', title: 'event.event'},
           {key: 'event', title: 'event.event'},
           {key: 'status', title: 'event.status'},
           {key: 'status', title: 'event.status'},
-          {key: 'error', title: 'event.error'}
+          {key: 'errorStr', title: 'event.error'}
         );
         );
         break;
         break;
       case EventType.STATS:
       case EventType.STATS:
@@ -319,7 +319,7 @@ export class EventTableConfig extends EntityTableConfig<Event, TimePageLink> {
           {key: 'dataSearch', title: 'event.data'},
           {key: 'dataSearch', title: 'event.data'},
           {key: 'metadataSearch', title: 'event.metadata'},
           {key: 'metadataSearch', title: 'event.metadata'},
           {key: 'isError', title: 'event.error'},
           {key: 'isError', title: 'event.error'},
-          {key: 'error', title: 'event.error'}
+          {key: 'errorStr', title: 'event.error'}
         );
         );
         break;
         break;
     }
     }

@@ -91,13 +91,13 @@ export interface BaseFilterEventBody {
 
 
 export interface ErrorFilterEventBody extends BaseFilterEventBody {
 export interface ErrorFilterEventBody extends BaseFilterEventBody {
   method?: string;
   method?: string;
-  error?: string;
+  errorStr?: string;
 }
 }
 
 
 export interface LcFilterEventEventBody extends BaseFilterEventBody {
 export interface LcFilterEventEventBody extends BaseFilterEventBody {
   event?: string;
   event?: string;
   status?: string;
   status?: string;
-  error?: string;
+  errorStr?: string;
 }
 }
 
 
 export interface StatsFilterEventBody extends BaseFilterEventBody {
 export interface StatsFilterEventBody extends BaseFilterEventBody {
@@ -115,7 +115,7 @@ export interface DebugFilterRuleNodeEventBody extends BaseFilterEventBody {
   dataSearch?: string;
   dataSearch?: string;
   metadataSearch?: string;
   metadataSearch?: string;
   isError?: boolean;
   isError?: boolean;
-  error?: string;
+  errorStr?: string;
 }
 }
 
 
 export type FilterEventBody = ErrorFilterEventBody & LcFilterEventEventBody & StatsFilterEventBody & DebugFilterRuleNodeEventBody;
 export type FilterEventBody = ErrorFilterEventBody & LcFilterEventEventBody & StatsFilterEventBody & DebugFilterRuleNodeEventBody;