fixed readOnly for entityId, deterministic order of tags, fixed DebugEventFilter field duplication (isError, error), fixed OtaPackage data format

application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java

@@ -586,6 +586,9 @@ public class SwaggerConfiguration {
                         if (prop.getDescription() != null) {
                             refSchema.setDescription(prop.getDescription());
                         }
+                        if (prop.getReadOnly() != null) {
+                            refSchema.setReadOnly(prop.getReadOnly());
+                        }
                         schema.getProperties().put(propName, refSchema);
                         log.debug("Replaced oneOf with $ref to {} in property {}", baseType, propName);
                     }
@@ -596,7 +599,7 @@ public class SwaggerConfiguration {
 
     private String tagItemFromPathItem(PathItem item) {
         var operations = item.readOperationsMap().values();
-        var operation = operations.stream().findAny();
+        var operation = operations.stream().findFirst();
         if (operation.isPresent()) {
             var tags = operation.get().getTags();
             if (tags != null && !tags.isEmpty()) {

application/src/main/java/org/thingsboard/server/controller/ApiKeyController.java

@@ -68,7 +68,7 @@ public class ApiKeyController extends BaseController {
     private final ApiKeyService apiKeyService;
 
     @ApiOperation(value = "Save API key for user (saveApiKey)",
-            notes = "Creates an API key for the given user and returns the token ONCE as 'ApiKey <value>'." + AVAILABLE_FOR_ANY_AUTHORIZED_USER)
+            notes = "Creates an API key for the given user and returns the token ONCE as 'ApiKey {value}'." + AVAILABLE_FOR_ANY_AUTHORIZED_USER)
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN','TENANT_ADMIN', 'CUSTOMER_USER')")
     @PostMapping(value = "/apiKey")
     public ApiKey saveApiKey(

application/src/main/java/org/thingsboard/server/controller/DeviceController.java

@@ -206,16 +206,16 @@ public class DeviceController extends BaseController {
             notes = "Create or update the Device. When creating device, platform generates Device Id as " + UUID_WIKI_LINK +
                     "Requires to provide the Device Credentials object as well as an existing device profile ID or use \"default\".\n" +
                     "You may find the example of device with different type of credentials below: \n\n" +
-                    "- Credentials type: <b>\"Access token\"</b> with <b>device profile ID</b> below: \n\n" +
+                    "- Credentials type: **\"Access token\"** with **device profile ID** below: \n\n" +
                     DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_ACCESS_TOKEN_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- Credentials type: <b>\"Access token\"</b> with  <b>device profile default</b> below: \n\n" +
+                    "- Credentials type: **\"Access token\"** with  **device profile default** below: \n\n" +
                     DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_ACCESS_TOKEN_DEFAULT_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- Credentials type: <b>\"X509\"</b> with <b>device profile ID</b> below: \n\n" +
-                    "Note: <b>credentialsId</b> -  format <b>Sha3Hash</b>, <b>certificateValue</b> - format <b>PEM</b> (with \"--BEGIN CERTIFICATE----\" and  -\"----END CERTIFICATE-\").\n\n" +
+                    "- Credentials type: **\"X509\"** with **device profile ID** below: \n\n" +
+                    "Note: **credentialsId** -  format **Sha3Hash**, **certificateValue** - format **PEM** (with \"--BEGIN CERTIFICATE----\" and  -\"----END CERTIFICATE-\").\n\n" +
                     DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_X509_CERTIFICATE_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- Credentials type: <b>\"MQTT_BASIC\"</b> with <b>device profile ID</b> below: \n\n" +
+                    "- Credentials type: **\"MQTT_BASIC\"** with **device profile ID** below: \n\n" +
                     DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_MQTT_BASIC_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- You may find the example of <b>LwM2M</b> device and <b>RPK</b> credentials below: \n\n" +
+                    "- You may find the example of **LwM2M** device and **RPK** credentials below: \n\n" +
                     "Note: LwM2M device - only existing device profile ID (Transport configuration -> Transport type: \"LWM2M\".\n\n" +
                     DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_LVM2M_RPK_DESCRIPTION_MARKDOWN + "\n\n" +
                     "Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity. " +
@@ -322,14 +322,14 @@ public class DeviceController extends BaseController {
                     "Then use current method to update the credentials type and value. It is not possible to create multiple device credentials for the same device.\n" +
                     "The structure of device credentials id and value is simple for the 'ACCESS_TOKEN' but is much more complex for the 'MQTT_BASIC' or 'LWM2M_CREDENTIALS'.\n" +
                     "You may find the example of device with different type of credentials below: \n\n" +
-                    "- Credentials type: <b>\"Access token\"</b> with <b>device ID</b> and with <b>device ID</b> below: \n\n" +
+                    "- Credentials type: **\"Access token\"** with **device ID** and with **device ID** below: \n\n" +
                     DEVICE_UPDATE_CREDENTIALS_PARAM_ACCESS_TOKEN_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- Credentials type: <b>\"X509\"</b> with <b>device profile ID</b> below: \n\n" +
-                    "Note: <b>credentialsId</b> -  format <b>Sha3Hash</b>, <b>certificateValue</b> - format <b>PEM</b> (with \"--BEGIN CERTIFICATE----\" and  -\"----END CERTIFICATE-\").\n\n" +
+                    "- Credentials type: **\"X509\"** with **device profile ID** below: \n\n" +
+                    "Note: **credentialsId** -  format **Sha3Hash**, **certificateValue** - format **PEM** (with \"--BEGIN CERTIFICATE----\" and  -\"----END CERTIFICATE-\").\n\n" +
                     DEVICE_UPDATE_CREDENTIALS_PARAM_X509_CERTIFICATE_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- Credentials type: <b>\"MQTT_BASIC\"</b> with <b>device profile ID</b> below: \n\n" +
+                    "- Credentials type: **\"MQTT_BASIC\"** with **device profile ID** below: \n\n" +
                     DEVICE_UPDATE_CREDENTIALS_PARAM_MQTT_BASIC_DESCRIPTION_MARKDOWN + "\n\n" +
-                    "- You may find the example of <b>LwM2M</b> device and <b>RPK</b> credentials below: \n\n" +
+                    "- You may find the example of **LwM2M** device and **RPK** credentials below: \n\n" +
                     "Note: LwM2M device - only existing device profile ID (Transport configuration -> Transport type: \"LWM2M\".\n\n" +
                     DEVICE_UPDATE_CREDENTIALS_PARAM_LVM2M_RPK_DESCRIPTION_MARKDOWN + "\n\n" +
                     "Update to real value:\n" +

application/src/main/java/org/thingsboard/server/controller/EntitiesVersionControlController.java

@@ -214,19 +214,19 @@ public class EntitiesVersionControlController extends BaseController {
             "      \"timestamp\": 1655198593000,\n" +
             "      \"id\": \"fd82625bdd7d6131cf8027b44ee967012ecaf990\",\n" +
             "      \"name\": \"Devices and assets - v2.0\",\n" +
-            "      \"author\": \"John Doe <johndoe@gmail.com>\"\n" +
+            "      \"author\": \"John Doe (johndoe@gmail.com)\"\n" +
             "    },\n" +
             "    {\n" +
             "      \"timestamp\": 1655198528000,\n" +
             "      \"id\": \"682adcffa9c8a2f863af6f00c4850323acbd4219\",\n" +
             "      \"name\": \"Update my device\",\n" +
-            "      \"author\": \"John Doe <johndoe@gmail.com>\"\n" +
+            "      \"author\": \"John Doe (johndoe@gmail.com)\"\n" +
             "    },\n" +
             "    {\n" +
             "      \"timestamp\": 1655198280000,\n" +
             "      \"id\": \"d2a6087c2b30e18cc55e7cdda345a8d0dfb959a4\",\n" +
             "      \"name\": \"Devices and assets - v1.0\",\n" +
-            "      \"author\": \"John Doe <johndoe@gmail.com>\"\n" +
+            "      \"author\": \"John Doe (johndoe@gmail.com)\"\n" +
             "    }\n" +
             "  ],\n" +
             "  \"totalPages\": 1,\n" +

common/data/src/main/java/org/thingsboard/server/common/data/Dashboard.java

@@ -33,7 +33,7 @@ import java.util.Optional;
 import java.util.stream.Collectors;
 
 @EqualsAndHashCode(callSuper = true)
-@JsonPropertyOrder({"title", "image", "mobileHide", "mobileOrder", "configuration", "name", "resources"})
+@JsonPropertyOrder({"id", "createdTime", "tenantId", "title", "name", "image", "mobileHide", "mobileOrder", "assignedCustomers", "configuration", "resources", "version"})
 public class Dashboard extends DashboardInfo implements ExportableEntity<DashboardId> {
 
     private static final long serialVersionUID = 872682138346187503L;

common/data/src/main/java/org/thingsboard/server/common/data/OtaPackage.java

@@ -31,7 +31,7 @@ public class OtaPackage extends OtaPackageInfo {
     @Serial
     private static final long serialVersionUID = 3091601761339422546L;
 
-    @Schema(description = "OTA Package data.", accessMode = Schema.AccessMode.READ_ONLY)
+    @Schema(description = "OTA Package data.", accessMode = Schema.AccessMode.READ_ONLY, type = "string", format = "byte")
     private transient ByteBuffer data;
 
     public OtaPackage() {

common/data/src/main/java/org/thingsboard/server/common/data/event/DebugEventFilter.java

@@ -15,6 +15,7 @@
  */
 package org.thingsboard.server.common.data.event;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import org.thingsboard.server.common.data.StringUtils;
@@ -26,10 +27,17 @@ public abstract class DebugEventFilter implements EventFilter {
     @Schema(description = "String value representing the server name, identifier or ip address where the platform is running", example = "ip-172-31-24-152")
     protected String server;
     @Schema(description = "Boolean value to filter the errors", allowableValues = {"false", "true"})
+    @JsonProperty("isError")
     protected boolean isError;
     @Schema(description = "The case insensitive 'contains' filter based on error message", example = "not present in the DB")
     protected String errorStr;
 
+    @JsonProperty("isError")
+    public boolean isError() {
+        return isError;
+    }
+
+    @JsonProperty("isError")
     public void setIsError(boolean isError) {
         this.isError = isError;
     }